API/Services/GetCurrentUsagePeriodSummary

Purpose

Retrieve a summary of all services under a given 'Package Subscription Id' for the current period. This should separately include Bolt-Ons and Bolt-On Add-Ons.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetCurrentUsagePeriodSummary>
        <ser:PackageSubscriptionID>1234567</ser:PackageSubscriptionID>
     </ser:GetCurrentUsagePeriodSummary>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:GetCurrentUsagePeriodSummaryResponse>
        <ns1:Service>
           <ns1:Service>
              <ns1:ServiceID>112233</ns1:ServiceID>
              <ns1:ServiceIdentifierCore>123123</ns1:ServiceIdentifierCore>
              <ns1:ServiceIdentifierAuth>123123</ns1:ServiceIdentifierAuth>
              <ns1:ServiceIdentifierProvisioning>123123</ns1:ServiceIdentifierProvisioning>
              <ns1:ServiceTypeID>1</ns1:ServiceTypeID>
              <ns1:ServiceTypeName>Mobile</ns1:ServiceTypeName>
           </ns1:Service>
           <ns1:Period>
              <ns1:ID>12345678</ns1:ID>
              <ns1:StartDate>2016-05-01 00:00:00</ns1:StartDate>
              <ns1:EndDate>2016-06-01 00:00:00</ns1:EndDate>
           </ns1:Period>
           <ns1:TelephonyUsageSummary>
              <ns1:IncludedValues>
                 <ns1:IncludedValue>
                    <ns1:IncludedValueID>1122</ns1:IncludedValueID>
                    <ns1:IncludedValueSlotTypeID>2</ns1:IncludedValueSlotTypeID>
                    <ns1:PercentageUsed>0.07</ns1:PercentageUsed>
                    <ns1:IncludedValueUsed>2</ns1:IncludedValueUsed>
                    <ns1:IncludedValueActual>3000</ns1:IncludedValueActual>
                    <ns1:IncludedValueBase>3000</ns1:IncludedValueBase>
                    <ns1:IncludedValueTypeID>4</ns1:IncludedValueTypeID>
                    <ns1:IncludedValueType>Units</ns1:IncludedValueType>
                 </ns1:IncludedValue>
              </ns1:IncludedValues>
              <ns1:BoltOns>
                 <ns1:BoltOn>
                    <ns1:BoltOnPeriodID>2233</ns1:BoltOnPeriodID>
                    <ns1:BoltOnPeriodStart>2016-05-01 00:00:00</ns1:BoltOnPeriodStart>
                    <ns1:BoltOnPeriodEnd>2016-06-01 00:00:00</ns1:BoltOnPeriodEnd>
                    <ns1:PercentageUsed>863.59</ns1:PercentageUsed>
                    <ns1:IncludedValueUsed>2210778</ns1:IncludedValueUsed>
                    <ns1:IncludedValueActual>256000</ns1:IncludedValueActual>
                    <ns1:IncludedValueBase>256000</ns1:IncludedValueBase>
                    <ns1:IncludedValueTypeID>3</ns1:IncludedValueTypeID>
                    <ns1:IncludedValueType>Kilobytes</ns1:IncludedValueType>
                    <ns1:BoltOnAddOns>
                       <ns1:BoltOnAddOn>
                          <ns1:BoltOnAddOnPeriodID/>
                          <ns1:BoltOnAddOnPeriodStart/>
                          <ns1:BoltOnAddOnPeriodEnd/>
                          <ns1:PercentageUsed/>
                          <ns1:IncludedValueUsed/>
                          <ns1:IncludedValueActual/>
                          <ns1:IncludedValueBase/>
                          <ns1:IncludedValueTypeID/>
                          <ns1:IncludedValueType/>
                       </ns1:BoltOnAddOn>
                    </ns1:BoltOnAddOns>
                 </ns1:BoltOn>
              </ns1:BoltOns>
           </ns1:TelephonyUsageSummary>
           <ns1:DataUsageSummary>
              <ns1:AllocationType>Peak</ns1:AllocationType>
              <ns1:ChargeUpload>1</ns1:ChargeUpload>
              <ns1:ChargeDownload>1</ns1:ChargeDownload>
              <ns1:PercentageUsed>50</ns1:PercentageUsed>
              <ns1:IncludedValueUsed>2000000</ns1:IncludedValueUsed>
              <ns1:IncludedValueBase>4000000</ns1:IncludedValueBase>
              <ns1:IncludedValueActual>4000000</ns1:IncludedValueActual>
              <ns1:IncludedValueLeft>2000000</ns1:IncludedValueLeft>
              <ns1:IncludedValueType>MB</ns1:IncludedValueType>
              <ns1:ActionAtEnd>CAP</ns1:ActionAtEnd>
           </ns1:DataUsageSummary>
        </ns1:Service>
     </ns1:GetCurrentUsagePeriodSummaryResponse>
  </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.