Go to full article


Overview

This API returns the balance of a Telstra WME service. The balance is shown in a unit of measure as determined by the WME platform. Usually this is in bytes or megabytes.

Returning the Service Balance

 To return the service balance:

  1. Create a getWMEBalance request
  2. Specify the service ID
  3. Specify the login token that was returned in the authentication step.

WDSL

https://userapi.emersion.com/Services.wsdl

Operation name

Services/getWMEBalance



Business Rules

  • Login token must be valid for the end user
  • Service id must exist in the database
  • Service id must be owned by the caller account
  • If a balance record is found for the service, it will be returned
  • If a balance record is not found for the service, a message will be returned saying that there is no data found for the provided service id




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:userapi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:getWMEBalance>
         <urn:service_id>1011671</urn:service_id>
         <urn:loginToken>a89d8f89c4616042ba7650368eca4fad588874a0b242a80fa479ae2b82a17bf5</urn:loginToken>
      </urn:getWMEBalance>
   </soapenv:Body>
</soapenv:Envelope>




Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information.

NameDescriptionRequired?Field Type

Character

limit

Values 
service_id
The ID of the service.YesInt28

a valid service ID.

loginToken
The authentication token as it was returned by the Authentication/login API call.YesString64a valid session token.



Error Handling

Error MessageDescription
Provided service id does not exist.The service ID does not match any service belonging to the end user.




Reference Data

Service IDs can be found from a customer's service subscription record. Go to Customer > Service Subscriptions. The table displayed on this page contains a list of the customer's services. The Service ID is a column in the table.