Difference between revisions of "API/Services/GetServiceConfigurationRequirements"

From Emersion
Jump to: navigation, search
(new page created for GetServiceConfigurationRequirements API function)
 
Line 7: Line 7:
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
       <ser:GetServiceConfigurationRequirements>
+
       <ord:SetServiceConfiguration>
         <ser:ServicePlanID>1234567</ser:ServicePlanID>
+
         <ord:PresaleSQID>112233</ord:PresaleSQID>
         <ser:TransferType>CHURN</ser:TransferType>
+
         <!--Optional:-->
       </ser:GetServiceConfigurationRequirements>
+
        <ord:PropertyCollections>
 +
            <!--Zero or more repetitions:-->
 +
            <com:Property>
 +
              <com:PropertyTypeID>133</com:PropertyTypeID>
 +
              <!--Optional:-->
 +
              <com:PropertyValue>string_value</com:PropertyValue>
 +
            </com:Property>
 +
        </ord:PropertyCollections>
 +
       </ord:SetServiceConfiguration>
 
   </soapenv:Body>
 
   </soapenv:Body>
  
 +
'''Output'''
  
'''Output'''
 
 
   <SOAP-ENV:Body>
 
   <SOAP-ENV:Body>
       <ns1:GetServiceConfigurationRequirementsResponse>
+
       <ns1:SetServiceConfigurationResponse>
         <ns1:Property>
+
         <ns1:Status>true</ns1:Status>
            <ns1:PropertyTypeName>MOBILE_AUTH_DOB</ns1:PropertyTypeName>
+
       </ns1:SetServiceConfigurationResponse>
            <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>
 
   </SOAP-ENV:Body>
 
  
 
'''Error String'''
 
'''Error String'''

Revision as of 15:11, 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 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.