Go to full article


Overview

This API call can be used to perform a stand alone service qualification against GNAF Addresses in conjunction with Emersion's infrastructure module.

WSDL

https://api.emersion.com/Orders.wsdl

Operation name

PerformGeneralAddressSQ

Business Rules

1. The Service Type used in the call must be made available to the RSP account either via the wholesale package catalog, or via  a service type map, mapped directly to the RSP in question.




SOAP Example


Sample Call
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:urn="urn:emersion:api" xmlns:utype="urn:emersion:types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:PerformGeneralAddressSQRequest>
         <urn:AccountPresaleID>531929</urn:AccountPresaleID>
         <urn:ServiceTypeID>4453</urn:ServiceTypeID>
         <urn:TransferType>NEW</urn:TransferType>
         <urn:ServiceIdentifierDetails xsi:type="utype:ServiceIdentifierGNAFAddressDetails">
            <utype:GNAFAddressID>1850720</utype:GNAFAddressID>
         </urn:ServiceIdentifierDetails>
      </urn:PerformGeneralAddressSQRequest>
   </soapenv:Body>
</soapenv:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns1:PerformGeneralAddressSQResponse>
         <ns1:AccountPresaleSQID>573466</ns1:AccountPresaleSQID>
         <ns1:ServiceQualificationMessage>Service available at this address. Class number 5, FOXTEL wall plate ready, set top box install required. FOXTEL has previously been installed at the service address.</ns1:ServiceQualificationMessage>
         <ns1:ServiceQualificationResult>Success</ns1:ServiceQualificationResult>
      </ns1:PerformGeneralAddressSQResponse>
   </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 
AccountPresaleID
As the name suggests, the ID of the Account Presale Order.  This ID can be retrieved via API operation: StartOrder in the following wsdl https://api.emersion.com/Orders.wsdlYesInt28

531929



ServiceTypeID
ID of the Service Type you wish to perform the SQ against.YesInt284553
TransferType
Transfer Type you wish to perform an  SQ against.YesString64NEW, CHURN, INTERNAL CHURN
ServceIdentifierDetailsIdentifier of the service. For API calls of this type, it will be the GNAF address ID.  Take care with the namespace formatting.  See the sample API call for an example.YesInt281850720

Reports

The following Cumulus reports can be used to obtain the reference data needed to use this function. Reports can be accessed in Cumulus under Reports > List. Click the sub tab that matches the report group in the table below.

Data

Report ID

Report Name

Report Group

Service Type List

863

Service Type List

Reference


Alternative Locations

  • GNAF Address IDs can be obtained by using the Get Address From Address Library API call or;
  • via Services >Address > Export Address List or;
  • directly from a customer's service subscription record. Go to Customer > Service Subscriptions > Service Address tab and see the GNAF address ID.