Overview

The purpose of this call is to return detailed information pertaining to a specific service. It is frequently used after the serviceList call.

Return a Service

 To retrieve a list of service types:

  1. Create a serviceDetail
  2. Specify the service id
  3. Specify the login token that was returned in the authentication step.

WSDL

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

Operation name

Services/serviceDetail



Business Rules

  • The service id must exist in the database
  • The service id must belong to the end user account.
  • The service subscription must follow these rules:
    • status - preactive and has not been migrated; or
    • status = active and not future dated; and
  • A GNAF address will be returned if
    • There is a service address against the service; and
    • The service address is a GNAF address.




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:userapi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:serviceDetail>
         <urn:service_id>866091</urn:service_id>
         <urn:loginToken>75d99763a21a30b5b6c97e0b511205affae5f4482a7074c091263a6ba5a8f48e</urn:loginToken>
      </urn:serviceDetail>
   </soapenv:Body>
</soapenv:Envelope>




Error Handling

ErrorDescription
A blank array is returnedIf the service does not meet the business rules in any way, the response will be a blank array. Check all business rules and retry.




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.YesInt22

A valid service ID

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