API/Services/GetServiceConfigurationRequirements - Revision history

MZabelov at 06:02, 7 March 2019

2019-03-07T06:02:46Z

JLee at 05:35, 21 July 2016

2016-07-21T05:35:17Z

JLee at 05:34, 21 July 2016

2016-07-21T05:34:50Z

Scarpenter at 05:12, 29 June 2016

2016-06-29T05:12:42Z

Scarpenter at 05:11, 29 June 2016

2016-06-29T05:11:00Z

JLee: new page created for GetServiceConfigurationRequirements API function

2016-06-08T04:17:00Z

new page created for GetServiceConfigurationRequirements API function

New page

'''Purpose '''

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

'''Inputs'''
<soapenv:Header/>
<soapenv:Body>
<ser:GetServiceConfigurationRequirements>
<ser:ServicePlanID>1234567</ser:ServicePlanID>
<ser:TransferType>CHURN</ser:TransferType>
</ser:GetServiceConfigurationRequirements>
</soapenv:Body>

'''Output'''
<SOAP-ENV:Body>
<ns1:GetServiceConfigurationRequirementsResponse>
<ns1:Property>
<ns1:PropertyTypeName>MOBILE_AUTH_DOB</ns1:PropertyTypeName>
<ns1:PropertyTypeID>221</ns1:PropertyTypeID>
<ns1:PropertyValueTypeID>1</ns1:PropertyValueTypeID>
<ns1:PropertyValueTypeName>DateOfBirth</ns1:PropertyValueTypeName>
<ns1:PropertyValueValidationRules/>
<ns1:PropertyTypeOption/>
<ns1:IsMandatory>false</ns1:IsMandatory>
</ns1:Property>
<ns1:Property>
<ns1:PropertyTypeName>KEY_HIDE_YN</ns1:PropertyTypeName>
<ns1:PropertyTypeID>359</ns1:PropertyTypeID>
<ns1:PropertyValueTypeID>4</ns1:PropertyValueTypeID>
<ns1:PropertyValueTypeName>List</ns1:PropertyValueTypeName>
<ns1:PropertyValueValidationRules/>
<ns1:PropertyTypeOption/>
<ns1:IsMandatory>true</ns1:IsMandatory>
<ns1:PropertyValueListItems>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>Yes</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Yes</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>No</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>No</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
</ns1:PropertyValueListItems>
</ns1:Property>
<ns1:Property>
<ns1:PropertyTypeName>WME_HOME_MSA</ns1:PropertyTypeName>
<ns1:PropertyTypeID>458</ns1:PropertyTypeID>
<ns1:PropertyValueTypeID>4</ns1:PropertyValueTypeID>
<ns1:PropertyValueTypeName>List</ns1:PropertyValueTypeName>
<ns1:PropertyValueValidationRules/>
<ns1:PropertyTypeOption/>
<ns1:IsMandatory>true</ns1:IsMandatory>
<ns1:PropertyValueListItems>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>NSW</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>New South Wales</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>NT</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Northern Territory</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>SA</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>South Australia</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>QLD</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Queensland</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>TAS</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Tasmania</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>VIC</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Victoria</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
<ns1:PropertyValueListItem>
<ns1:ValueListItemValue>WA</ns1:ValueListItemValue>
<ns1:ValueListItemLabel>Western Australia</ns1:ValueListItemLabel>
</ns1:PropertyValueListItem>
</ns1:PropertyValueListItems>
</ns1:Property>
</ns1:GetServiceConfigurationRequirementsResponse>
</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.

@@ Line 30: / Line 30: @@
              <ns1:TypeOption/>
              <ns1:IsMandatory>true</ns1:IsMandatory>
-             <ns1:ValueLists>
+             <ns1:ValueList>
-                <ns1:ValueList>
+                <ns1:ValueListItem>
                    <ns1:Value>Yes</ns1:Value>
                    <ns1:Label>Yes</ns1:Label>
-                </ns1:ValueList>
+                </ns1:ValueListItem>
-                <ns1:ValueList>
+                <ns1:ValueListItem>
                    <ns1:Value>No</ns1:Value>
                    <ns1:Label>No</ns1:Label>
-                </ns1:ValueList>
+                </ns1:ValueListItem>
-             </ns1:ValueLists>
+             </ns1:ValueList>
           </ns2:Property>
        </ns2:GetServiceConfigurationRequirementsResponse>

@@ Line 43: / Line 43: @@
        </ns2:GetServiceConfigurationRequirementsResponse>
     </SOAP-ENV:Body>
 '''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.

@@ Line 7: / Line 7: @@
     <soapenv:Header/>
     <soapenv:Body>
-       <ord:SetServiceConfiguration>
+       <urn:GetServiceConfigurationRequirements>
-          <ord:PresaleSQID>112233</ord:PresaleSQID>
+          <urn:ServicePlanID>1234567</urn:ServicePlanID>
-          <!--Optional:-->
+          <urn:TransferType>CHURN</urn:TransferType>
-         <ord:PropertyCollections>
+       </urn:GetServiceConfigurationRequirements>
     </soapenv:Body>
@@ Line 24: / Line 16: @@
     <SOAP-ENV:Body>
-       <ns1:SetServiceConfigurationResponse>
+       <ns2:GetServiceConfigurationRequirementsResponse>
-          <ns1:Status>true</ns1:Status>
+         <ns2:Property>
-       </ns1:SetServiceConfigurationResponse>
+            <ns1:Type ID="221">MOBILE_AUTH_DOB</ns1:Type>
     </SOAP-ENV:Body>
 '''Error String'''