Overview
This API call is a part of suite of API calls developed for the Vocus Service Type. After performing an Vocus NBN SQ, this call is used to set the ordering option prior to selecting your Package Plan.
SOAP Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
<soapenv:Header/>
<soapenv:Body>
<urn:SetNBNOrderingOptionRequest>
<urn:AccountPresaleSQID>658639</urn:AccountPresaleSQID>
<urn:OrderingOption>newWithExistingInactive</urn:OrderingOption>
</urn:SetNBNOrderingOptionRequest>
</soapenv:Body>
</soapenv:Envelope>
API Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:api">
<SOAP-ENV:Body>
<ns1:SetNBNOrderingOptionResponse>
<ns1:TransferType>NEW</ns1:TransferType>
</ns1:SetNBNOrderingOptionResponse>
</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..
| Name | Description | Required? | Field Type | Character limit | Values | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
AccountPresaleSQID | The account presale SQ ID retrieve using the Perform Vocus NBN SQ API call. | Yes | 6323432 | ||||||||||||||||
OrderingOption | An available ordering option retrieved using the Perform Vocus NBN SQ | Yes | Valid Options include:
| ||||||||||||||||
| PhoneNumber | This element is only allowed (and is mandatory) when an FTTB/N/C order is trying to provision a new NBN service reusing an existing copper pair, over which, a voice service is already running (i.e. ordering option 'newWithExisting' is being provided). NBN uses this phone number to authenticate the copper pair. | No (Required only in the mentioned scenario) | Numbers | 10 | Standard 10 digit Australian phone number e.g. 0385603040 | ||||||||||||||
| KeepNumber | This element is only allowed (but not mandatory) if "PhoneNumber" element is being provided. This is a flag dictating whether or not the new NBN service would continue the voice service over the phone number. | No | Boolean | True or False (1 or 0) | |||||||||||||||
| NTDID | This element is only required for HFC orders where ordering option is not "new" (i.e. when a new NTD is not being ordered and an existing one is being reused) | No (Required only in the mentioned scenario) | String | A valid NTD ID e.g. NTD400002487611 |
Error Handling
| Error Message | Description |
|---|---|
Ordering Option is not valid for SQ. Please copy one from output of 'PerformVocusNBNSQ' | |
Phone Number not allowed for Ordering Option provided | |
Keep Number not allowed for Ordering Option provided | |
Phone Number required for Ordering Option provided | |
Phone Number is in invalid format | |
NTD ID must be provided for HFC Orders when you are not ordering New NTD | |
NTD ID can only be provided for HFC Orders when you are not ordering New NTD | |
Provided NTD ID does not exist or conflicts with chosen ordering option |