API/Services/serviceLookup

Purpose

Returns service subscription information for a particular service identifier.

Note: This API will return all service subscriptions that are under your end users irrespective of the status that match the supplied identifier.

Inputs

  <soapenv:Body>
     <ser:serviceLookup>
        <ser:service_identifier>1300333333</ser:service_identifier> - identifier to search (mandatory)
        <ser:service_type_id>133300</ser:service_type_id> - service type ID to filter with (optional) - see reference data for more information
        <ser:max_records>100</ser:max_records> - limit to return (optional)
     </ser:serviceLookup>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:serviceLookupResponse>
        <ns1:serviceLookupItem>
           <ns1:account_id></ns1:account_id> - end user account ID
           <ns1:service_identifier></ns1:service_identifier> - service identifier provided via input
           <ns1:subscription_status_name></ns1:subscription_status_name> - vanity name for the subscription status (e.g. Preactive, Active etc.)
           <ns1:subscription_status_id></ns1:subscription_status_id> - primary key for the subscription status (e.g. 1 = Preactive - See reference tables for full mapping)
           <ns1:service_subscr_start_date></ns1:service_subscr_start_date> - the date the subscription started
           <ns1:service_subscr_end_date></ns1:service_subscr_end_date> - the date the subscription ended
           <ns1:contract_length></ns1:contract_length> - the length of the contract by definition (not how much time is left, how long it is defined to be.)
           <ns1:contract_internal_name></ns1:contract_internal_name> - the internal name attached to the contract (if a contract is attached.)
           <ns1:contract_external_name></ns1:contract_external_name> - the external name attached to the contract (if a contract is attached.)
           <ns1:contract_start_date></ns1:contract_start_date> - the start date of the contract (if a contract is attached.)
           <ns1:contract_end_date></ns1:contract_end_date> - the enddate of the contract (if a contract is attached.)
           <ns1:service_start_date></ns1:service_start_date> - the start date of the service
           <ns1:service_end_date></ns1:service_end_date> - the end date of the service
           <ns1:service_type_name></ns1:service_type_name> - the vanity name attached to the service type
           <ns1:carrier_name></ns1:carrier_name> - the carrier name
           <ns1:service_id></ns1:service_id> - the primary key for the service.
        </ns1:serviceLookupItem>
     </ns1:serviceLookupResponse>
  </SOAP-ENV:Body>

Validation Errors - Missing service_identifier - Missing mandatory parameter for service identifier.