Go to full article


Overview

This API call allows you to retrieve service configuration requirements based on a service plan ID and transfer type.  These requirements will be needed when creating an order via API.

WSDL

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

Operation name


getServiceConfigurationRequirements





SOAP Example


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:GetServiceConfigurationRequirements>
         <urn:ServicePlanID>201106</urn:ServicePlanID>
         <urn:TransferType>NEW</urn:TransferType>
      </urn:GetServiceConfigurationRequirements>
   </soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:emersion:types" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="urn:emersion:api">
   <SOAP-ENV:Body>
      <ns2:GetServiceConfigurationRequirementsResponse>
         <ns2:Property>
            <ns1:Type ID="133">VANITY_IDENTIFIER</ns1:Type>
            <ns1:ValueType ID="7">String</ns1:ValueType>
            <ns1:ValueValidationRules xsi:nil="true"/>
            <ns1:TypeOption xsi:nil="true"/>
            <ns1:IsMandatory>false</ns1:IsMandatory>
         </ns2:Property>
         <ns2:Property>
            <ns1:Type ID="797">VOCUS_SERVICE_ID</ns1:Type>
            <ns1:ValueType ID="3">Integer</ns1:ValueType>
            <ns1:ValueValidationRules xsi:nil="true"/>
            <ns1:TypeOption xsi:nil="true"/>
            <ns1:IsMandatory>false</ns1:IsMandatory>
         </ns2:Property>
         <ns2:Property>
            <ns1:Type ID="872">NBN_CPE_PLAN_ID</ns1:Type>
            <ns1:ValueType ID="4">List</ns1:ValueType>
            <ns1:ValueValidationRules xsi:nil="true"/>
            <ns1:TypeOption>SI</ns1:TypeOption>
            <ns1:IsMandatory>true</ns1:IsMandatory>
            <ns1:ValueList>
               <ns1:ValueListItem>
                  <ns1:Value>SI</ns1:Value>
                  <ns1:Label>Standard Install</ns1:Label>
               </ns1:ValueListItem>
               <ns1:ValueListItem>
                  <ns1:Value>PI</ns1:Value>
                  <ns1:Label>Professional Install</ns1:Label>
               </ns1:ValueListItem>
            </ns1:ValueList>
         </ns2:Property>
         <ns2:Property>
            <ns1:Type ID="876">AGG_CVC_ID</ns1:Type>
            <ns1:ValueType ID="7">String</ns1:ValueType>
            <ns1:ValueValidationRules xsi:nil="true"/>
            <ns1:TypeOption xsi:nil="true"/>
            <ns1:IsMandatory>false</ns1:IsMandatory>
         </ns2:Property>
      </ns2:GetServiceConfigurationRequirementsResponse>
   </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 

ServicePlanID

Service Plan ID for the service plan to retrieve requirements for.YesInt

201106



TransferType

Transfer Type of any potential order that you need to gather service requirements for. YesString
NEW
CHURN
INTERNAL CHURN



Error Handling

Error MessageDescription
Service Plan does not exist

Invalid Transfer Type. Valid input: 'NEW', 'CHURN' or 'INTERNAL CHURN