Difference between revisions of "API/Services/GetServiceConfigurationRequirements"

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

Revision as of 15:35, 21 July 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>
     <urn:GetServiceConfigurationRequirements>
        <urn:ServicePlanID>1234567</urn:ServicePlanID>
        <urn:TransferType>CHURN</urn:TransferType>
     </urn:GetServiceConfigurationRequirements>
  </soapenv:Body>

Output 

  <SOAP-ENV:Body>
     <ns2:GetServiceConfigurationRequirementsResponse>
        <ns2:Property>
           <ns1:Type ID="221">MOBILE_AUTH_DOB</ns1:Type>
           <ns1:ValueType ID="1">DateOfBirth</ns1:ValueType>
           <ns1:ValidationRules/>
           <ns1:TypeOption/>
           <ns1:IsMandatory>false</ns1:IsMandatory>
        </ns2:Property>
        <ns2:Property>
           <ns1:Type ID="359">KEY_HIDE_YN</ns1:Type>
           <ns1:ValueType ID="4">List</ns1:ValueType>
           <ns1:ValidationRules/>
           <ns1:TypeOption/>
           <ns1:IsMandatory>true</ns1:IsMandatory>
           <ns1:ValueLists>
              <ns1:ValueList>
                 <ns1:Value>Yes</ns1:Value>
                 <ns1:Label>Yes</ns1:Label>
              </ns1:ValueList>
              <ns1:ValueList>
                 <ns1:Value>No</ns1:Value>
                 <ns1:Label>No</ns1:Label>
              </ns1:ValueList>
           </ns1:ValueLists>
        </ns2:Property>
     </ns2:GetServiceConfigurationRequirementsResponse>
  </SOAP-ENV:Body>

Error String

  • "Missing Service Plan ID" - Service Plan ID is not supplied.
  • "Invalid Service Plan ID" - Service Plan ID supplied does not belong to the same parent group as the API caller.
  • "Service Plan does not exist" - Service Plan ID supplied does not exist in system.
  • "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 Type)" - Service Plan ID supplied does not have a valid Service Type.
  • "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetServiceConfigurationRequirements&oldid=4507"