API/Services/GetUsageDetail

From Emersion
Jump to: navigation, search

Purpose

Retrieve the raw usage detail for the Invoice ID supplied, optionally filtered by Tariff Group (if supplied). This functionality allows user to retrieve result sets in pages by supplying the Page and Page Size.


Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetUsageDetail>
        <ser:InvoiceID>1234567</ser:InvoiceID>
     </ser:GetUsageDetail>
  </soapenv:Body>


Output

  <SOAP-ENV:Body>
     <ns1:GetUsageDetailResponse>
        <ns1:TotalRecords>30</ns1:TotalRecords>
        <ns1:RecordsReturned>20</ns1:RecordsReturned>
        <ns1:Page>1</ns1:Page>
        <ns1:PageSize>20</ns1:PageSize>
        <ns1:CallDetailRecord>
           <ns1:Date>2015-12-31 22:11:01</ns1:Date>
           <ns1:ChargedService>112233</ns1:ChargedService>
           <ns1:Duration>1500</ns1:Duration>
           <ns1:UnitMeasurement>Kilobyte(s)</ns1:UnitMeasurement>
           <ns1:TariffTypeID>3</ns1:TariffTypeID>
           <ns1:TariffName>Mobile Data</ns1:TariffName>
           <ns1:RatedAmountExTax>0.10</ns1:RatedAmountExTax>
           <ns1:RatedAmountTax>0.01</ns1:RatedAmountTax>
           <ns1:InvoicedAmountExTax>0</ns1:InvoicedAmountExTax>
           <ns1:InvoicedAmountTax>0</ns1:InvoicedAmountTax>
        </ns1:CallDetailRecord>
     </ns1:GetUsageDetailResponse>
  </SOAP-ENV:Body>


Error String

  • "Missing InvoiceID" - InvoiceID not supplied
  • "Page (number) should be 1 or higher" - Page (number) cannot be less than 1.
  • "Page Size should be 1 or more" - Page size cannot be less than 1.