Difference between revisions of "API/Services/GetServiceConfigurationRequirements"

From Emersion
Jump to: navigation, search
(new page created for GetServiceConfigurationRequirements API function)
 
 
(4 intermediate revisions by 2 users not shown)
Line 7: Line 7:
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
−
       <ser:GetServiceConfigurationRequirements>
+
       <urn:GetServiceConfigurationRequirements>
−
         <ser:ServicePlanID>1234567</ser:ServicePlanID>
+
         <urn:ServicePlanID>1234567</urn:ServicePlanID>
−
         <ser:TransferType>CHURN</ser:TransferType>
+
         <urn:TransferType>CHURN</urn:TransferType>
−
       </ser:GetServiceConfigurationRequirements>
+
       </urn:GetServiceConfigurationRequirements>
 
   </soapenv:Body>
 
   </soapenv:Body>
  
 +
'''Output'''
  
−
'''Output'''
 
 
   <SOAP-ENV:Body>
 
   <SOAP-ENV:Body>
−
       <ns1:GetServiceConfigurationRequirementsResponse>
+
       <ns2:GetServiceConfigurationRequirementsResponse>
−
         <ns1:Property>
+
         <ns2:Property>
−
             <ns1:PropertyTypeName>MOBILE_AUTH_DOB</ns1:PropertyTypeName>
+
             <ns1:Type ID="221">MOBILE_AUTH_DOB</ns1:Type>
−
            <ns1:PropertyTypeID>221</ns1:PropertyTypeID>
+
             <ns1:ValueType ID="1">DateOfBirth</ns1:ValueType>
−
             <ns1:PropertyValueTypeID>1</ns1:PropertyValueTypeID>
+
             <ns1:ValidationRules/>
−
            <ns1:PropertyValueTypeName>DateOfBirth</ns1:PropertyValueTypeName>
+
             <ns1:TypeOption/>
−
             <ns1:PropertyValueValidationRules/>
 
−
             <ns1:PropertyTypeOption/>
 
 
             <ns1:IsMandatory>false</ns1:IsMandatory>
 
             <ns1:IsMandatory>false</ns1:IsMandatory>
−
         </ns1:Property>
+
         </ns2:Property>
−
         <ns1:Property>
+
         <ns2:Property>
−
             <ns1:PropertyTypeName>KEY_HIDE_YN</ns1:PropertyTypeName>
+
             <ns1:Type ID="359">KEY_HIDE_YN</ns1:Type>
−
            <ns1:PropertyTypeID>359</ns1:PropertyTypeID>
+
             <ns1:ValueType ID="4">List</ns1:ValueType>
−
             <ns1:PropertyValueTypeID>4</ns1:PropertyValueTypeID>
+
             <ns1:ValidationRules/>
−
            <ns1:PropertyValueTypeName>List</ns1:PropertyValueTypeName>
+
             <ns1:TypeOption/>
−
            <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:IsMandatory>true</ns1:IsMandatory>
−
             <ns1:PropertyValueListItems>
+
             <ns1:ValueList>
−
               <ns1:PropertyValueListItem>
+
               <ns1:ValueListItem>
−
                   <ns1:ValueListItemValue>NSW</ns1:ValueListItemValue>
+
                   <ns1:Value>Yes</ns1:Value>
−
                   <ns1:ValueListItemLabel>New South Wales</ns1:ValueListItemLabel>
+
                   <ns1:Label>Yes</ns1:Label>
−
               </ns1:PropertyValueListItem>
+
               </ns1:ValueListItem>
−
               <ns1:PropertyValueListItem>
+
               <ns1:ValueListItem>
−
                   <ns1:ValueListItemValue>NT</ns1:ValueListItemValue>
+
                   <ns1:Value>No</ns1:Value>
−
                   <ns1:ValueListItemLabel>Northern Territory</ns1:ValueListItemLabel>
+
                   <ns1:Label>No</ns1:Label>
−
               </ns1:PropertyValueListItem>
+
               </ns1:ValueListItem>
−
              <ns1:PropertyValueListItem>
+
             </ns1:ValueList>
−
                  <ns1:ValueListItemValue>SA</ns1:ValueListItemValue>
+
         </ns2:Property>
−
                  <ns1:ValueListItemLabel>South Australia</ns1:ValueListItemLabel>
+
       </ns2:GetServiceConfigurationRequirementsResponse>
−
              </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'''
  
 
* "Missing Service Plan ID" - Service Plan ID is not supplied.
 
* "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.
 
* "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.
 
* "Missing Transfer Type" - Transfer Type is not supplied.
 
* "Invalid Transfer Type. Valid input: 'NEW', 'CHURN' or 'INTERNAL CHURN'" - Invalid input received.
 
* "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.
 
* "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.

Latest revision as of 16: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.
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/GetServiceConfigurationRequirements&oldid=6405"