Emersion - User contributions [en]

API/Services

2018-06-25T18:36:24Z

Moconnor:

== Services ==

The 'Services' section of the Emersion API layer primarily contains account management and point of sale based functions.
This contains an extended create customer interface, an update customer interface, and a way to do very simple point of sale transactions via the API.

The WSDL is at https://external.emersion.com.au/Services.wsdl

=== API Documentation on the Emersion Knowledge Base ===
As with the rest of Emersion's documentation, we are migrating the API documentation to the Emersion Knowledge Base.

The following API calls have been documented in the Emersion Knowledge Base.

[https://resources.emersion.com/display/EKB/Get+Service+Types+for+a+GNAF+Address Get Service Types for an Address]
[https://resources.emersion.com/display/EKB/Update+Address+Availability Update Address Availability]

=== Existing API Documentation ===

{{#subpages:page=API/Services}}.

API/Services

2018-06-25T18:34:40Z

Moconnor:

== Services ==

The 'Services' section of the Emersion API layer primarily contains account management and point of sale based functions.
This contains an extended create customer interface, an update customer interface, and a way to do very simple point of sale transactions via the API.

The WSDL is at https://external.emersion.com.au/Services.wsdl

=== API Documentation on the Emersion Knowledge Base ===
As with the rest of Emersion's documentation, we are slowly migrating the API documentation to the Emersion Knowledge Base.

The following API calls have been documented in the Emersion Knowledge Base.

[https://resources.emersion.com/display/EKB/Get+Service+Types+for+a+GNAF+Address Get Service Types for an Address]
[https://resources.emersion.com/display/EKB/Update+Address+Availability Update Address Availability]

=== Existing API Documentation ===

{{#subpages:page=API/Services}}.

API/Services/serviceDetail

2018-06-25T18:34:28Z

Moconnor:

'''Purpose '''

Returns service subscription information for a particular service.

'''Inputs'''

<soapenv:Header/>
<soapenv:Body>
<ser:serviceDetail>
<ser:service_id>1</ser:service_id>
</ser:serviceDetail>
</soapenv:Body>

'''Output'''

<SOAP-ENV:Body>
<ns2:serviceDetailResponse>
<ns2:serviceDetailItem>
<ns1:service_subscription_status_id></ns1:service_subscription_status_id>
<ns1:service_subscr_status_name></ns1:service_subscr_status_name>
<ns1:service_status_id></ns1:service_status_id>
<ns1:service_status_name></ns1:service_status_name>
<ns1:service_subscription_id></ns1:service_subscription_id>
<ns1:service_subscr_start_date></ns1:service_subscr_start_date>
<ns1:package_subscription_id></ns1:package_subscription_id>
<ns1:address></ns1:address>
<ns1:package_plan_name></ns1:package_plan_name>
<ns1:package_plan_name_external></ns1:package_plan_name_external>
<ns1:service_plan_name></ns1:service_plan_name>
<ns1:service_plan_name_external></ns1:service_plan_name_external>
<ns1:service_type_id></ns1:service_type_id>
<ns1:package_plan_id></ns1:package_plan_id>
<ns1:account_credit_limit></ns1:account_credit_limit>
<ns1:account_id></ns1:account_id>
<ns1:service_identifier></ns1:service_identifier>
<ns1:service_start_date></ns1:service_start_date>
<ns1:service_type_name></ns1:service_type_name>
<ns1:service_auth_identifier></ns1:service_auth_identifier>
<ns1:password></ns1:password>
<ns1:gnaf_address>
<ns1:gnaf_address_id></ns1:gnaf_address_id>
<ns1:unit_number></ns1:unit_number>
<ns1:unit_type_code></ns1:unit_type_code>
<ns1:address_sitename></ns1:address_sitename>
<ns1:road_number_1></ns1:road_number_1>
<ns1:road_number_2></ns1:road_number_2>
<ns1:road_name></ns1:road_name>
<ns1:road_type_code></ns1:road_type_code>
<ns1:locality_name></ns1:locality_name>
<ns1:state_territory_code></ns1:state_territory_code>
<ns1:mailing_address1></ns1:mailing_address1>
<ns1:mailing_suburb></ns1:mailing_suburb>
<ns1:mailing_state></ns1:mailing_state>
<ns1:mailing_postcode></ns1:mailing_postcode>
<ns1:business_residential></ns1:business_residential>
</ns1:gnaf_address>
</ns2:serviceDetailItem>
</ns2:serviceDetailResponse>
</SOAP-ENV:Body>

'''Error String'''

136. Missing service_id

API/Services/serviceDetail

2018-06-25T18:34:09Z

Moconnor:

'''Purpose '''

Returns service subscription information for a particular service.

'''Inputs'''

<soapenv:Header/>
<soapenv:Body>
<ser:serviceDetail>
<ser:service_id>1</ser:service_id>
</ser:serviceDetail>
</soapenv:Body>

'''Output'''

{{{
<SOAP-ENV:Body>
<ns2:serviceDetailResponse>
<ns2:serviceDetailItem>
<ns1:service_subscription_status_id></ns1:service_subscription_status_id>
<ns1:service_subscr_status_name></ns1:service_subscr_status_name>
<ns1:service_status_id></ns1:service_status_id>
<ns1:service_status_name></ns1:service_status_name>
<ns1:service_subscription_id></ns1:service_subscription_id>
<ns1:service_subscr_start_date></ns1:service_subscr_start_date>
<ns1:package_subscription_id></ns1:package_subscription_id>
<ns1:address></ns1:address>
<ns1:package_plan_name></ns1:package_plan_name>
<ns1:package_plan_name_external></ns1:package_plan_name_external>
<ns1:service_plan_name></ns1:service_plan_name>
<ns1:service_plan_name_external></ns1:service_plan_name_external>
<ns1:service_type_id></ns1:service_type_id>
<ns1:package_plan_id></ns1:package_plan_id>
<ns1:account_credit_limit></ns1:account_credit_limit>
<ns1:account_id></ns1:account_id>
<ns1:service_identifier></ns1:service_identifier>
<ns1:service_start_date></ns1:service_start_date>
<ns1:service_type_name></ns1:service_type_name>
<ns1:service_auth_identifier></ns1:service_auth_identifier>
<ns1:password></ns1:password>
<ns1:gnaf_address>
<ns1:gnaf_address_id></ns1:gnaf_address_id>
<ns1:unit_number></ns1:unit_number>
<ns1:unit_type_code></ns1:unit_type_code>
<ns1:address_sitename></ns1:address_sitename>
<ns1:road_number_1></ns1:road_number_1>
<ns1:road_number_2></ns1:road_number_2>
<ns1:road_name></ns1:road_name>
<ns1:road_type_code></ns1:road_type_code>
<ns1:locality_name></ns1:locality_name>
<ns1:state_territory_code></ns1:state_territory_code>
<ns1:mailing_address1></ns1:mailing_address1>
<ns1:mailing_suburb></ns1:mailing_suburb>
<ns1:mailing_state></ns1:mailing_state>
<ns1:mailing_postcode></ns1:mailing_postcode>
<ns1:business_residential></ns1:business_residential>
</ns1:gnaf_address>
</ns2:serviceDetailItem>
</ns2:serviceDetailResponse>
</SOAP-ENV:Body>

}}}

'''Error String'''

136. Missing service_id

API/Services/serviceDetail

2018-06-25T18:33:13Z

Moconnor:

'''Purpose '''

Returns service subscription information for a particular service.

'''Inputs'''

<soapenv:Header/>
<soapenv:Body>
<ser:serviceDetail>
<ser:service_id>1</ser:service_id>
</ser:serviceDetail>
</soapenv:Body>

'''Output'''

{{{
<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:serviceDetailResponse>
<ns2:serviceDetailItem>
<ns1:service_subscription_status_id></ns1:service_subscription_status_id>
<ns1:service_subscr_status_name></ns1:service_subscr_status_name>
<ns1:service_status_id></ns1:service_status_id>
<ns1:service_status_name></ns1:service_status_name>
<ns1:service_subscription_id></ns1:service_subscription_id>
<ns1:service_subscr_start_date></ns1:service_subscr_start_date>
<ns1:package_subscription_id></ns1:package_subscription_id>
<ns1:address></ns1:address>
<ns1:package_plan_name></ns1:package_plan_name>
<ns1:package_plan_name_external></ns1:package_plan_name_external>
<ns1:service_plan_name></ns1:service_plan_name>
<ns1:service_plan_name_external></ns1:service_plan_name_external>
<ns1:service_type_id></ns1:service_type_id>
<ns1:package_plan_id></ns1:package_plan_id>
<ns1:account_credit_limit></ns1:account_credit_limit>
<ns1:account_id></ns1:account_id>
<ns1:service_identifier></ns1:service_identifier>
<ns1:service_start_date></ns1:service_start_date>
<ns1:service_type_name></ns1:service_type_name>
<ns1:service_auth_identifier></ns1:service_auth_identifier>
<ns1:password></ns1:password>
<ns1:gnaf_address>
<ns1:gnaf_address_id></ns1:gnaf_address_id>
<ns1:unit_number></ns1:unit_number>
<ns1:unit_type_code></ns1:unit_type_code>
<ns1:address_sitename></ns1:address_sitename>
<ns1:road_number_1></ns1:road_number_1>
<ns1:road_number_2></ns1:road_number_2>
<ns1:road_name></ns1:road_name>
<ns1:road_type_code></ns1:road_type_code>
<ns1:locality_name></ns1:locality_name>
<ns1:state_territory_code></ns1:state_territory_code>
<ns1:mailing_address1></ns1:mailing_address1>
<ns1:mailing_suburb></ns1:mailing_suburb>
<ns1:mailing_state></ns1:mailing_state>
<ns1:mailing_postcode></ns1:mailing_postcode>
<ns1:business_residential></ns1:business_residential>
</ns1:gnaf_address>
</ns2:serviceDetailItem>
</ns2:serviceDetailResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

}}}

'''Error String'''

136. Missing service_id

API/Services/serviceDetail

2018-06-25T18:30:00Z

Moconnor:

'''Purpose '''

Returns service subscription information for a particular service.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:serviceDetail>
<ser:service_id>1</ser:service_id>
</ser:serviceDetail>
</soapenv:Body>

'''Output'''
<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:serviceDetailResponse>
<ns2:serviceDetailItem>
<ns1:service_subscription_status_id></ns1:service_subscription_status_id>
<ns1:service_subscr_status_name></ns1:service_subscr_status_name>
<ns1:service_status_id></ns1:service_status_id>
<ns1:service_status_name></ns1:service_status_name>
<ns1:service_subscription_id></ns1:service_subscription_id>
<ns1:service_subscr_start_date></ns1:service_subscr_start_date>
<ns1:package_subscription_id></ns1:package_subscription_id>
<ns1:address></ns1:address>
<ns1:package_plan_name></ns1:package_plan_name>
<ns1:package_plan_name_external></ns1:package_plan_name_external>
<ns1:service_plan_name></ns1:service_plan_name>
<ns1:service_plan_name_external></ns1:service_plan_name_external>
<ns1:service_type_id></ns1:service_type_id>
<ns1:package_plan_id></ns1:package_plan_id>
<ns1:account_credit_limit></ns1:account_credit_limit>
<ns1:account_id></ns1:account_id>
<ns1:service_identifier></ns1:service_identifier>
<ns1:service_start_date></ns1:service_start_date>
<ns1:service_type_name></ns1:service_type_name>
<ns1:service_auth_identifier></ns1:service_auth_identifier>
<ns1:password></ns1:password>
<ns1:gnaf_address>
<ns1:gnaf_address_id></ns1:gnaf_address_id>
<ns1:unit_number></ns1:unit_number>
<ns1:unit_type_code></ns1:unit_type_code>
<ns1:address_sitename></ns1:address_sitename>
<ns1:road_number_1></ns1:road_number_1>
<ns1:road_number_2></ns1:road_number_2>
<ns1:road_name></ns1:road_name>
<ns1:road_type_code></ns1:road_type_code>
<ns1:locality_name></ns1:locality_name>
<ns1:state_territory_code></ns1:state_territory_code>
<ns1:mailing_address1></ns1:mailing_address1>
<ns1:mailing_suburb></ns1:mailing_suburb>
<ns1:mailing_state></ns1:mailing_state>
<ns1:mailing_postcode></ns1:mailing_postcode>
<ns1:business_residential></ns1:business_residential>
</ns1:gnaf_address>
</ns2:serviceDetailItem>
</ns2:serviceDetailResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

'''Error String'''

136. Missing service_id

API/Services/serviceDetail

2018-06-25T18:29:11Z

Moconnor:

'''Purpose '''

Returns service subscription information for a particular service.

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:serviceDetail>
<ser:service_id>1</ser:service_id>
</ser:serviceDetail>
</soapenv:Body>

'''Output'''
<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:serviceDetailResponse>
<ns2:serviceDetailItem>
<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>812061</ns1:service_subscription_id>
<ns1:service_subscr_start_date>2014-05-21T00:00:00+10:00</ns1:service_subscr_start_date>
<ns1:package_subscription_id>710609</ns1:package_subscription_id>
<ns1:address>269-289 BIRKDALE Road, BIRKDALE QLD 4159 Australia</ns1:address>
<ns1:package_plan_name>Superfast Bundle - Unlimited - Launch Promo</ns1:package_plan_name>
<ns1:package_plan_name_external>Superfast Independent Living Bundle - Unlimited Broadband Plan - Launch Promo</ns1:package_plan_name_external>
<ns1:service_plan_name>Frontier Superfast Broadband Unlimited Launch Promo on VDSL2</ns1:service_plan_name>
<ns1:service_plan_name_external>Superfast Broadband Unlimited Launch Promo</ns1:service_plan_name_external>
<ns1:service_type_id>3768</ns1:service_type_id>
<ns1:package_plan_id>168918</ns1:package_plan_id>
<ns1:account_credit_limit>0</ns1:account_credit_limit>
<ns1:account_id>882822</ns1:account_id>
<ns1:service_identifier>FTN000000573767</ns1:service_identifier>
<ns1:service_start_date>2014-05-21T00:00:00+10:00</ns1:service_start_date>
<ns1:service_type_name>Broadband VDSL2</ns1:service_type_name>
<ns1:service_auth_identifier>bmoey402</ns1:service_auth_identifier>
<ns1:password>mhberyl402</ns1:password>
<ns1:gnaf_address>
<ns1:gnaf_address_id>513395</ns1:gnaf_address_id>
<ns1:unit_number>402</ns1:unit_number>
<ns1:unit_type_code>UNIT</ns1:unit_type_code>
<ns1:address_sitename>Wellington Manor</ns1:address_sitename>
<ns1:road_number_1>269</ns1:road_number_1>
<ns1:road_number_2>289</ns1:road_number_2>
<ns1:road_name>BIRKDALE</ns1:road_name>
<ns1:road_type_code>Road</ns1:road_type_code>
<ns1:locality_name>BIRKDALE</ns1:locality_name>
<ns1:state_territory_code>QLD</ns1:state_territory_code>
<ns1:mailing_address1>269-289 Birkdale Rd</ns1:mailing_address1>
<ns1:mailing_suburb>BIRKDALE</ns1:mailing_suburb>
<ns1:mailing_state>QLD</ns1:mailing_state>
<ns1:mailing_postcode>4159</ns1:mailing_postcode>
<ns1:business_residential>1</ns1:business_residential>
</ns1:gnaf_address>
</ns2:serviceDetailItem>
</ns2:serviceDetailResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

'''Error String'''

136. Missing service_id