Overview

This API call is designed to show the complete history of a service, including it's current status.  This can be useful to see services in various statuses, and to see the migration history of a service.

Returning the Service History

 To retrieve service history items

  1. Create a serviceHistory() request 
  2. Specify the Service ID.

WSDL

https://api.emersion.com.au/Services.wsdl

Operation name

serviceHistory



Business Rules

The service you are querying must be a child (belong to) your service provider account.




SOAP Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:serviceHistory>
         <urn:service_id>1030782</urn:service_id>
      </urn:serviceHistory>
   </soapenv:Body>
</soapenv:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:types" xmlns:ns2="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns2:serviceHistoryResponse>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>2</ns1:service_status_id>
            <ns1:service_status_name>Cancelled</ns1:service_status_name>
            <ns1:service_subscription_id>3049007</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2018-07-03T00:00:00+10:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2018-08-08T12:19:59+10:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>2193122</ns1:package_subscription_id>
            <ns1:address>Unit 999/99 Hutchinson Street, MOUNT BARKER SA 5251 Australia</ns1:address>
            <ns1:package_plan_name>VDSL2 On-Net Request/ns1:package_plan_name>
            <ns1:package_plan_name_external>On-Net Request </ns1:package_plan_name_external>
            <ns1:service_plan_name>VDSL2 - 100Mbps / Unllimited</ns1:service_plan_name>
            <ns1:service_plan_name_external> Broadband 100Mbps / Unlimited</ns1:service_plan_name_external>
            <ns1:service_type_id>3768</ns1:service_type_id>
            <ns1:package_plan_id>209762</ns1:package_plan_id>
            <ns1:account_id>1319399</ns1:account_id>
            <ns1:service_identifier>FTN0000001030782</ns1:service_identifier>
            <ns1:service_start_date>2018-07-03T00:00:00+10:00</ns1:service_start_date>
            <ns1:service_end_date>2018-08-08T12:19:59+10:00</ns1:service_end_date>
            <ns1:service_type_name>FN Broadband VDSL2</ns1:service_type_name>
            <ns1:gnaf_address>
               <ns1:gnaf_address_id>1830983</ns1:gnaf_address_id>
               <ns1:unit_number>21</ns1:unit_number>
               <ns1:unit_type_code>UNIT</ns1:unit_type_code>
               <ns1:address_sitename>The Restful Retirement Village</ns1:address_sitename>
               <ns1:road_number_1>999</ns1:road_number_1>
               <ns1:road_name>Hutchinson</ns1:road_name>
               <ns1:road_type_code>Street</ns1:road_type_code>
               <ns1:locality_name>MOUNT BARKER</ns1:locality_name>
               <ns1:state_territory_code>SA</ns1:state_territory_code>
               <ns1:mailing_address1>2 Hutchinson Street</ns1:mailing_address1>
               <ns1:mailing_suburb>MOUNT BARKER</ns1:mailing_suburb>
               <ns1:mailing_state>SA</ns1:mailing_state>
               <ns1:mailing_postcode>5251</ns1:mailing_postcode>
            </ns1:gnaf_address>
         </ns2:serviceHistoryItem>
      </ns2:serviceHistoryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>


When a service has been migrated, a separate serviceHistoryItem is output for each subscription it has been migrated to.  Note the service_sub_followed_by_id.



Response for a Service with a Migration History
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:types" xmlns:ns2="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns2:serviceHistoryResponse>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>649687</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2013-10-28T08:59:15+11:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2013-10-28T09:18:59+11:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>578094</ns1:package_subscription_id>
            <ns1:package_plan_name>Telstra PSTN (eBill) - Sell Package Plan</ns1:package_plan_name>
            <ns1:package_plan_name_external>PSTN</ns1:package_plan_name_external>
            <ns1:service_plan_name>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name>
            <ns1:service_plan_name_external>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>119468</ns1:package_plan_id>
            <ns1:service_sub_followed_by_id>649700</ns1:service_sub_followed_by_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61398887777</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>649700</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2013-10-28T09:18:59+11:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2013-10-28T10:01:35+11:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>578106</ns1:package_subscription_id>
            <ns1:package_plan_name>Telstra PSTN (eBill) - Sell Package Plan</ns1:package_plan_name>
            <ns1:package_plan_name_external>PSTN</ns1:package_plan_name_external>
            <ns1:service_plan_name>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name>
            <ns1:service_plan_name_external>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>119468</ns1:package_plan_id>
            <ns1:service_sub_followed_by_id>649753</ns1:service_sub_followed_by_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61398887777</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>649753</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2013-10-28T10:01:35+11:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2013-10-28T12:24:14+11:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>578147</ns1:package_subscription_id>
            <ns1:package_plan_name>Telstra PSTN (eBill) - Sell Package Plan</ns1:package_plan_name>
            <ns1:package_plan_name_external>PSTN</ns1:package_plan_name_external>
            <ns1:service_plan_name>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name>
            <ns1:service_plan_name_external>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>119468</ns1:package_plan_id>
            <ns1:service_sub_followed_by_id>649884</ns1:service_sub_followed_by_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61398887777</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>649884</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2013-10-28T12:24:14+11:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2013-10-28T12:29:44+11:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>578263</ns1:package_subscription_id>
            <ns1:package_plan_name>Telstra PSTN (eBill) - Sell Package Plan</ns1:package_plan_name>
            <ns1:package_plan_name_external>PSTN</ns1:package_plan_name_external>
            <ns1:service_plan_name>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name>
            <ns1:service_plan_name_external>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>119468</ns1:package_plan_id>
            <ns1:service_sub_followed_by_id>649888</ns1:service_sub_followed_by_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61398887777</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>5</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Cancelled</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>649888</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2013-10-28T12:29:44+11:00</ns1:service_subscr_start_date>
            <ns1:service_subscr_end_date>2018-11-21T15:24:03+11:00</ns1:service_subscr_end_date>
            <ns1:package_subscription_id>578266</ns1:package_subscription_id>
            <ns1:package_plan_name>Telstra PSTN (eBill) - Sell Package Plan</ns1:package_plan_name>
            <ns1:package_plan_name_external>PSTN</ns1:package_plan_name_external>
            <ns1:service_plan_name>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name>
            <ns1:service_plan_name_external>Telstra PSTN (eBill) - Sell Service Plan</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>119468</ns1:package_plan_id>
            <ns1:service_sub_followed_by_id>3307895</ns1:service_sub_followed_by_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61398887777</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
         <ns2:serviceHistoryItem>
            <ns1:service_subscription_status_id>2</ns1:service_subscription_status_id>
            <ns1:service_subscr_status_name>Active</ns1:service_subscr_status_name>
            <ns1:service_status_id>1</ns1:service_status_id>
            <ns1:service_status_name>Active</ns1:service_status_name>
            <ns1:service_subscription_id>3307895</ns1:service_subscription_id>
            <ns1:service_subscr_start_date>2018-11-21T15:24:03+11:00</ns1:service_subscr_start_date>
            <ns1:package_subscription_id>2387889</ns1:package_subscription_id>
            <ns1:package_plan_name>24022015 PKG PLAN</ns1:package_plan_name>
            <ns1:package_plan_name_external>24022015 PKG PLAN</ns1:package_plan_name_external>
            <ns1:service_plan_name>24022015 SELL PLAN</ns1:service_plan_name>
            <ns1:service_plan_name_external>24022015 SELL PLAN</ns1:service_plan_name_external>
            <ns1:service_type_id>61</ns1:service_type_id>
            <ns1:package_plan_id>176719</ns1:package_plan_id>
            <ns1:account_id>466578</ns1:account_id>
            <ns1:service_identifier>61399221111</ns1:service_identifier>
            <ns1:service_start_date>2013-10-28T08:59:15+11:00</ns1:service_start_date>
            <ns1:service_type_name>Telstra</ns1:service_type_name>
         </ns2:serviceHistoryItem>
      </ns2:serviceHistoryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV: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.YesInteger

123456789



Error Handling


Error MessageDescription
Missing or non-existing service IDThe ID could not be found in our system.
You are not the owner of the provided service IDThe service ID exists, but the account attached to your API user is not the owner of it.