Difference between revisions of "API/Services/GetUsagePeriodSummary"

Latest revision as of 13:26, 19 May 2016

Purpose

Retrieve all service subscriptions period, its breakdown of Bolt-On, Data Usage and Normal Included Value based on 'Service Subscription ID' going back X periods or months as defined by the input data returning Telephony and Data records.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetUsagePeriodSummary>
        <ser:ServiceSubscriptionID>1234567</ser:ServiceSubscriptionID>
        <ser:NumberOfPeriods>6</ser:NumberOfPeriods>
        <ser:LengthType>month</ser:LengthType>
     </ser:GetUsagePeriodSummary>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:GetUsagePeriodSummaryResponse>
        <ns1:Period>
           <ns1:Period>
             <ns1:ID>1234567</ns1:ID>
             <ns1:StartDate>2015-07-01 00:00:00</ns1:StartDate>
             <ns1:EndDate>2015-08-01 00:00:00</ns1:EndDate>
           </ns1:Period>
           <ns1:TelephonyUsageSummary>
              <ns1:IncludedValues>
                 <ns1:IncludedValue>
                    <ns1:IncludedValueID/>
                    <ns1:IncludedValueSlotTypeID/>
                    <ns1:PercentageUsed/>
                    <ns1:IncludedValueUsed/>
                    <ns1:IncludedValueActual/>
                    <ns1:IncludedValueBase/>
                    <ns1:IncludedValueTypeID/>
                    <ns1:IncludedValueType/>
                 </ns1:IncludedValue>
                 <ns1:IncludedValue>
                    <ns1:IncludedValueID/>
                    <ns1:IncludedValueSlotTypeID/>
                    <ns1:PercentageUsed/>
                    <ns1:IncludedValueUsed/>
                    <ns1:IncludedValueActual/>
                    <ns1:IncludedValueBase/>
                    <ns1:IncludedValueTypeID/>
                    <ns1:IncludedValueType/>
                 </ns1:IncludedValue>
              </ns1:IncludedValues>
              <ns1:BoltOns>
                 <ns1:BoltOn>
                    <ns1:BoltOnPeriodID/>
                    <ns1:BoltOnPeriodStart/>
                    <ns1:BoltOnPeriodEnd/>
                    <ns1:PercentageUsed/>
                    <ns1:IncludedValueUsed/>
                    <ns1:IncludedValueActual/>
                    <ns1:IncludedValueBase/>
                    <ns1:IncludedValueTypeID/>
                    <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: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:BoltOn>
                    <ns1:BoltOnPeriodID/>
                    <ns1:BoltOnPeriodStart/>
                    <ns1:BoltOnPeriodEnd/>
                    <ns1:PercentageUsed/>
                    <ns1:IncludedValueUsed/>
                    <ns1:IncludedValueActual/>
                    <ns1:IncludedValueBase/>
                    <ns1:IncludedValueTypeID/>
                    <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: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:Period>
     </ns1:GetUsagePeriodSummaryResponse>
  </SOAP-ENV:Body>

Error String

• "Missing Service Subscription ID" - Service Subscription ID is not supplied.
• "Service Subscription does not exist" - Service Subscription ID supplied does not exist in system.
• "Invalid Service Subscription ID" - Service 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'.