Difference between revisions of "API/Services/GetServiceConfigurationRequirements"

From Emersion
Jump to: navigation, search
Line 31: Line 31:
 
'''Error String'''
 
'''Error String'''
  
−
* "Missing Service Plan ID" - Service Plan ID is not supplied.
+
* "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
−
* "Service Plan does not exist" - Service Plan ID supplied does not exist in system.
+
* "Account Presale SQ does not exist" - Account Presale SQ 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.
+
* "Account does not exist" - Account ID supplied does not exist in system.
−
* "Missing Transfer Type" - Transfer Type is not supplied.
+
* "Invalid Account ID" - Account ID supplied does not belong to the same parent group as the API caller.
−
* "Invalid Transfer Type. Valid input: 'NEW', 'CHURN' or 'INTERNAL CHURN'" - Invalid input received.
+
* "Missing Package Plan" - Package Plan must be selected before calling this function.
−
* "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.
+
* "Property(/ies) '[array dump]' required but missing in the Property Collection" - Required properties not supplied.
 +
* "Property(/ies) '[array dump]' is/are unknown to Service Configuration" - Unknown properties supplied.

Revision as of 15:12, 29 June 2016

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 Account Presale SQ ID" - Account Presale SQ ID is not supplied.
  • "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
  • "Account does not exist" - Account ID supplied does not exist in system.
  • "Invalid Account ID" - Account ID supplied does not belong to the same parent group as the API caller.
  • "Missing Package Plan" - Package Plan must be selected before calling this function.
  • "Property(/ies) '[array dump]' required but missing in the Property Collection" - Required properties not supplied.
  • "Property(/ies) '[array dump]' is/are unknown to Service Configuration" - Unknown properties supplied.
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetServiceConfigurationRequirements&oldid=4505"