Difference between revisions of "API/Services/GetServiceConfigurationRequirements"

Latest revision as of 17:02, 7 March 2019

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:ValueList>
              <ns1:ValueListItem>
                 <ns1:Value>Yes</ns1:Value>
                 <ns1:Label>Yes</ns1:Label>
              </ns1:ValueListItem>
              <ns1:ValueListItem>
                 <ns1:Value>No</ns1:Value>
                 <ns1:Label>No</ns1:Label>
              </ns1:ValueListItem>
           </ns1:ValueList>
        </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.