API/Services/GetServiceSubscriptionPeriods

Purpose

Retrieve all service subscriptions and service subscription periods based on the 'Package Subscription ID' going back X periods or months as defined by the input data.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetServiceSubscriptionPeriods>
        <ser:PackageSubscriptionID>1234567</ser:PackageSubscriptionID>
        <ser:NumberOfPeriods>6</ser:NumberOfPeriods>
        <ser:LengthType>month</ser:LengthType>
     </ser:GetServiceSubscriptionPeriods>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:GetServiceSubscriptionPeriodsResponse>
        <ns1:ServiceSubscription>
           <ns1:ServiceSubscriptionID>2345678</ns1:ServiceSubscriptionID>
           <ns1:ServiceSubscriptionPeriod>
              <ns1:ID>3456789</ns1:ID>
              <ns1:StartDate>2016-03-01 00:00:00</ns1:StartDate>
              <ns1:EndDate>2016-04-01 00:00:00</ns1:EndDate>
           </ns1:ServiceSubscriptionPeriod>
           <ns1:ServiceSubscriptionPeriod>
              <ns1:ID>4567890ns1:ID>
              <ns1:StartDate>2016-02-01 00:00:00</ns1:StartDate>
              <ns1:EndDate>2016-03-01 00:00:00</ns1:EndDate>
           </ns1:ServiceSubscriptionPeriod>
        </ns1:ServiceSubscription>
     </ns1:GetServiceSubscriptionPeriodsResponse>
  </SOAP-ENV:Body>

Error String

• "Missing Package Subscription ID" - Package Subscription ID is not supplied.
• "Package Subscription does not exist" - Package Subscription ID supplied does not exist in system.
• "Invalid Package Subscription ID" - Package Subscription ID supplied does not belong to the same parent group as the API caller.
• "Missing Number of Periods" - Number of Periods is not supplied.
• "Missing Length Type (period / month)" - Length Type is not supplied.
• "Invalid Length Type. Valid input: 'period' or 'month'" - Length Type supplied is not valid. Valid input is either 'period' or 'month'.