Overview
The purpose of this API call is to set specific Vocus NBN setup options for an order created by API. Note that these are configuration items above and beyond options set in API Call Set Service Configuration Requirements.
SOAP Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
<soapenv:Header/>
<soapenv:Body>
<urn:VocusNBNPostSQSetup>
<urn:AccountPresaleSQID>658639</urn:AccountPresaleSQID>
<urn:CentralSplitter>Y</urn:CentralSplitter>
</urn:VocusNBNPostSQSetup>
</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:VocusNBNPostSQSetupResponse>
<ns1:Status>true</ns1:Status>
</ns1:VocusNBNPostSQSetupResponse>
</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 | Account Presale Sq ID retrieved using API Call Perform Vocus NBN SQ | Yes | Int | 658559 | |
CentralSplitter | This field determines whether a central splitter will be required for the service. | No | Boolean | 'Y' or 'N' |
Error Handling
| Error Message | Description |
|---|---|
Account Presale SQ ID does not pertain to Vocus NBN service type | |
Central Splitter can only be specified for FTTB/N technology | The original SQ indicated that the Location did not support either the FTTN or FTTB technology types. Central Splitters can only be used with these technology types. |
| Central Splitter cannot be set before setting NBN Ordering Option. Please use the 'SetNBNOrderingOption' API call | |
| Central Splitter cannot be ordered because Voice Continuation was not selected via ordering option 'newWithExisting' | Check the ordering option you made with API call Set NBN Ordering Option |