Difference between revisions of "API/Services/GetUsagePerDay"

From Emersion
Jump to: navigation, search
m
(added sample output format)
Line 13: Line 13:
  
  
−
'''Output'''
+
'''Output (Telephony Usage Summary)'''
−
PENDING
+
  <SOAP-ENV:Body>
 +
      <ns1:GetUsagePerDayResponse>
 +
        <ns1:Day>
 +
            <ns1:Date>2016-04-01</ns1:Date>
 +
            <ns1:TelephonyUsageSummary>
 +
              <ns1:IncludedValues>
 +
                  <ns1:IncludedValue>
 +
                    <ns1:IncludedValueID>123456</ns1:IncludedValueID>
 +
                    <ns1:IncludedValueSlotTypeID>1</ns1:IncludedValueSlotTypeID>
 +
                    <ns1:PercentageUsed>0.33</ns1:PercentageUsed>
 +
                    <ns1:IncludedValueUsed>60</ns1:IncludedValueUsed>
 +
                    <ns1:IncludedValueActual>18000</ns1:IncludedValueActual>
 +
                    <ns1:IncludedValueBase>18000</ns1:IncludedValueBase>
 +
                    <ns1:IncludedValueTypeID>2</ns1:IncludedValueTypeID>
 +
                    <ns1:IncludedValueType>Seconds</ns1:IncludedValueType>
 +
                  </ns1:IncludedValue>
 +
              </ns1:IncludedValues>
 +
              <ns1:BoltOns>
 +
                  <ns1:BoltOn>
 +
                    <ns1:BoltOnPeriodID>112233</ns1:BoltOnPeriodID>
 +
                    <ns1:BoltOnPeriodStart>2016-04-01 00:00:00</ns1:BoltOnPeriodStart>
 +
                    <ns1:BoltOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnPeriodEnd>
 +
                    <ns1:PercentageUsed>14.07</ns1:PercentageUsed>
 +
                    <ns1:IncludedValueUsed>36011.2</ns1:IncludedValueUsed>
 +
                    <ns1:IncludedValueActual>256000</ns1:IncludedValueActual>
 +
                    <ns1:IncludedValueBase>256000</ns1:IncludedValueBase>
 +
                    <ns1:IncludedValueTypeID>3</ns1:IncludedValueTypeID>
 +
                    <ns1:IncludedValueType>Kilobytes</ns1:IncludedValueType>
 +
                  </ns1:BoltOn>
 +
              </ns1:BoltOns>
 +
            </ns1:TelephonyUsageSummary>
 +
        </ns1:Day>
 +
        <ns1:Day>
 +
            <ns1:Date>2016-04-02</ns1:Date>
 +
            <ns1:TelephonyUsageSummary>
 +
              <ns1:BoltOns>
 +
                  <ns1:BoltOn>
 +
                    <ns1:BoltOnPeriodID>223344</ns1:BoltOnPeriodID>
 +
                    <ns1:BoltOnPeriodStart>2016-04-01 00:00:00</ns1:BoltOnPeriodStart>
 +
                    <ns1:BoltOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnPeriodEnd>
 +
                    <ns1:PercentageUsed>14.07</ns1:PercentageUsed>
 +
                    <ns1:IncludedValueUsed>36011.2</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>22334455</ns1:BoltOnAddOnPeriodID>
 +
                          <ns1:BoltOnAddOnPeriodStart>2016-04-06 14:58:07</ns1:BoltOnAddOnPeriodStart>
 +
                          <ns1:BoltOnAddOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnAddOnPeriodEnd>
 +
                          <ns1:PercentageUsed>4</ns1:PercentageUsed>
 +
                          <ns1:IncludedValueUsed>34447.36</ns1:IncludedValueUsed>
 +
                          <ns1:IncludedValueActual>861184</ns1:IncludedValueActual>
 +
                          <ns1:IncludedValueBase>861184</ns1:IncludedValueBase>
 +
                          <ns1:IncludedValueTypeID>3</ns1:IncludedValueTypeID>
 +
                          <ns1:IncludedValueType>Kilobytes</ns1:IncludedValueType>
 +
                        </ns1:BoltOnAddOn>
 +
                    </ns1:BoltOnAddOns>
 +
                  </ns1:BoltOn>
 +
              </ns1:BoltOns>
 +
            </ns1:TelephonyUsageSummary>
 +
        </ns1:Day>
 +
      </ns1:GetUsagePerDayResponse>
 +
  </SOAP-ENV:Body>
  
 +
'''Output (Data Usage Summary)'''
 +
  <SOAP-ENV:Body>
 +
      <ns1:GetUsagePerDayResponse>
 +
        <ns1:Day>
 +
            <ns1:Date>2016-03-01</ns1:Date>
 +
            <ns1:DataUsageSummary>
 +
              <ns1:AllocationType>Peak</ns1:AllocationType>
 +
              <ns1:ChargeUpload>10</ns1:ChargeUpload>
 +
              <ns1:ChargeDownload>40</ns1:ChargeDownload>
 +
              <ns1:PercentageUsed>0</ns1:PercentageUsed>
 +
              <ns1:IncludedValueUsed>50</ns1:IncludedValueUsed>
 +
              <ns1:IncludedValueActual>1048576000</ns1:IncludedValueActual>
 +
              <ns1:IncludedValueBase>1048576000</ns1:IncludedValueBase>
 +
              <ns1:IncludedValueLeft>1048575950</ns1:IncludedValueLeft>
 +
              <ns1:IncludedValueType>MB</ns1:IncludedValueType>
 +
              <ns1:ActionAtEnd>Shape</ns1:ActionAtEnd>
 +
            </ns1:DataUsageSummary>
 +
        </ns1:Day>
 +
        <ns1:Day>
 +
            <ns1:Date>2016-03-02</ns1:Date>
 +
            <ns1:DataUsageSummary>
 +
              <ns1:AllocationType>Peak</ns1:AllocationType>
 +
              <ns1:ChargeUpload>20</ns1:ChargeUpload>
 +
              <ns1:ChargeDownload>50</ns1:ChargeDownload>
 +
              <ns1:PercentageUsed>0</ns1:PercentageUsed>
 +
              <ns1:IncludedValueUsed>70</ns1:IncludedValueUsed>
 +
              <ns1:IncludedValueActual>1048576000</ns1:IncludedValueActual>
 +
              <ns1:IncludedValueBase>1048576000</ns1:IncludedValueBase>
 +
              <ns1:IncludedValueLeft>1048575930</ns1:IncludedValueLeft>
 +
              <ns1:IncludedValueType>MB</ns1:IncludedValueType>
 +
              <ns1:ActionAtEnd>Shape</ns1:ActionAtEnd>
 +
            </ns1:DataUsageSummary>
 +
        </ns1:Day>
 +
      </ns1:GetUsagePerDayResponse>
 +
  </SOAP-ENV:Body>
  
 
'''Error String'''
 
'''Error String'''
  
 
* "Invalid Service Subscription Period ID" - Length less that 6; ID does not exist; Subscription period ID does not belong to the retail
 
* "Invalid Service Subscription Period ID" - Length less that 6; ID does not exist; Subscription period ID does not belong to the retail

Revision as of 18:05, 24 May 2016

Purpose

Get Telephony or Data information broken down by day, including all bolt-on and included value information based on the 'Service Subscription Period ID' supplied.


Inputs 

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetUsagePerDayRequest>
        <ser:ServiceSubscriptionPeriodID>1234567</ser:ServiceSubscriptionPeriodID>
     </ser:GetUsagePerDayRequest>
  </soapenv:Body>


Output (Telephony Usage Summary) 

  <SOAP-ENV:Body>
     <ns1:GetUsagePerDayResponse>
        <ns1:Day>
           <ns1:Date>2016-04-01</ns1:Date>
           <ns1:TelephonyUsageSummary>
              <ns1:IncludedValues>
                 <ns1:IncludedValue>
                    <ns1:IncludedValueID>123456</ns1:IncludedValueID>
                    <ns1:IncludedValueSlotTypeID>1</ns1:IncludedValueSlotTypeID>
                    <ns1:PercentageUsed>0.33</ns1:PercentageUsed>
                    <ns1:IncludedValueUsed>60</ns1:IncludedValueUsed>
                    <ns1:IncludedValueActual>18000</ns1:IncludedValueActual>
                    <ns1:IncludedValueBase>18000</ns1:IncludedValueBase>
                    <ns1:IncludedValueTypeID>2</ns1:IncludedValueTypeID>
                    <ns1:IncludedValueType>Seconds</ns1:IncludedValueType>
                 </ns1:IncludedValue>
              </ns1:IncludedValues>
              <ns1:BoltOns>
                 <ns1:BoltOn>
                    <ns1:BoltOnPeriodID>112233</ns1:BoltOnPeriodID>
                    <ns1:BoltOnPeriodStart>2016-04-01 00:00:00</ns1:BoltOnPeriodStart>
                    <ns1:BoltOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnPeriodEnd>
                    <ns1:PercentageUsed>14.07</ns1:PercentageUsed>
                    <ns1:IncludedValueUsed>36011.2</ns1:IncludedValueUsed>
                    <ns1:IncludedValueActual>256000</ns1:IncludedValueActual>
                    <ns1:IncludedValueBase>256000</ns1:IncludedValueBase>
                    <ns1:IncludedValueTypeID>3</ns1:IncludedValueTypeID>
                    <ns1:IncludedValueType>Kilobytes</ns1:IncludedValueType>
                 </ns1:BoltOn>
              </ns1:BoltOns>
           </ns1:TelephonyUsageSummary>
        </ns1:Day>
        <ns1:Day>
           <ns1:Date>2016-04-02</ns1:Date>
           <ns1:TelephonyUsageSummary>
              <ns1:BoltOns>
                 <ns1:BoltOn>
                    <ns1:BoltOnPeriodID>223344</ns1:BoltOnPeriodID>
                    <ns1:BoltOnPeriodStart>2016-04-01 00:00:00</ns1:BoltOnPeriodStart>
                    <ns1:BoltOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnPeriodEnd>
                    <ns1:PercentageUsed>14.07</ns1:PercentageUsed>
                    <ns1:IncludedValueUsed>36011.2</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>22334455</ns1:BoltOnAddOnPeriodID>
                          <ns1:BoltOnAddOnPeriodStart>2016-04-06 14:58:07</ns1:BoltOnAddOnPeriodStart>
                          <ns1:BoltOnAddOnPeriodEnd>2016-05-01 00:00:00</ns1:BoltOnAddOnPeriodEnd>
                          <ns1:PercentageUsed>4</ns1:PercentageUsed>
                          <ns1:IncludedValueUsed>34447.36</ns1:IncludedValueUsed>
                          <ns1:IncludedValueActual>861184</ns1:IncludedValueActual>
                          <ns1:IncludedValueBase>861184</ns1:IncludedValueBase>
                          <ns1:IncludedValueTypeID>3</ns1:IncludedValueTypeID>
                          <ns1:IncludedValueType>Kilobytes</ns1:IncludedValueType>
                       </ns1:BoltOnAddOn>
                    </ns1:BoltOnAddOns>
                 </ns1:BoltOn>
              </ns1:BoltOns>
           </ns1:TelephonyUsageSummary>
        </ns1:Day>
     </ns1:GetUsagePerDayResponse>
  </SOAP-ENV:Body>

Output (Data Usage Summary) 

  <SOAP-ENV:Body>
     <ns1:GetUsagePerDayResponse>
        <ns1:Day>
           <ns1:Date>2016-03-01</ns1:Date>
           <ns1:DataUsageSummary>
              <ns1:AllocationType>Peak</ns1:AllocationType>
              <ns1:ChargeUpload>10</ns1:ChargeUpload>
              <ns1:ChargeDownload>40</ns1:ChargeDownload>
              <ns1:PercentageUsed>0</ns1:PercentageUsed>
              <ns1:IncludedValueUsed>50</ns1:IncludedValueUsed>
              <ns1:IncludedValueActual>1048576000</ns1:IncludedValueActual>
              <ns1:IncludedValueBase>1048576000</ns1:IncludedValueBase>
              <ns1:IncludedValueLeft>1048575950</ns1:IncludedValueLeft>
              <ns1:IncludedValueType>MB</ns1:IncludedValueType>
              <ns1:ActionAtEnd>Shape</ns1:ActionAtEnd>
           </ns1:DataUsageSummary>
        </ns1:Day>
        <ns1:Day>
           <ns1:Date>2016-03-02</ns1:Date>
           <ns1:DataUsageSummary>
              <ns1:AllocationType>Peak</ns1:AllocationType>
              <ns1:ChargeUpload>20</ns1:ChargeUpload>
              <ns1:ChargeDownload>50</ns1:ChargeDownload>
              <ns1:PercentageUsed>0</ns1:PercentageUsed>
              <ns1:IncludedValueUsed>70</ns1:IncludedValueUsed>
              <ns1:IncludedValueActual>1048576000</ns1:IncludedValueActual>
              <ns1:IncludedValueBase>1048576000</ns1:IncludedValueBase>
              <ns1:IncludedValueLeft>1048575930</ns1:IncludedValueLeft>
              <ns1:IncludedValueType>MB</ns1:IncludedValueType>
              <ns1:ActionAtEnd>Shape</ns1:ActionAtEnd>
           </ns1:DataUsageSummary>
        </ns1:Day>
     </ns1:GetUsagePerDayResponse>
  </SOAP-ENV:Body>

Error String

  • "Invalid Service Subscription Period ID" - Length less that 6; ID does not exist; Subscription period ID does not belong to the retail
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetUsagePerDay&oldid=4461"