API/Services/GetServiceConfigurationRequirements

From Emersion
Revision as of 15:11, 29 June 2016 by Scarpenter (talk)
Jump to: navigation, search

Purpose

Retrieve all the object properties that need to be entered (along with whether they are mandatory or not).


Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ord:SetServiceConfiguration>
        <ord:PresaleSQID>112233</ord:PresaleSQID>
        <ord:PropertyCollections>
           <com:Property>
              <com:PropertyTypeID>133</com:PropertyTypeID>
              <com:PropertyValue>string_value</com:PropertyValue>
           </com:Property>
        </ord:PropertyCollections>
     </ord:SetServiceConfiguration>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:SetServiceConfigurationResponse>
        <ns1:Status>true</ns1:Status>
     </ns1:SetServiceConfigurationResponse>
  </SOAP-ENV:Body>

Error String

  • "Missing Service Plan ID" - Service Plan ID is not supplied.
  • "Service Plan does not exist" - Service Plan ID supplied does not exist in system.
  • "Invalid Service Plan ID" - Service Plan ID supplied does not belong to the same parent group as the API caller.
  • "Missing Transfer Type" - Transfer Type is not supplied.
  • "Invalid Transfer Type. Valid input: 'NEW', 'CHURN' or 'INTERNAL CHURN'" - Invalid input received.
  • "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.