Difference between revisions of "API/Services/SetServiceConfiguration"

From Emersion
Jump to: navigation, search
(Created page with "=== Set Service Configuration === '''Purpose:''' This call is used to configure any service configuration that is part of an order. '''Inputs''' <soapenv:Header/> <so...")
 
 
Line 7: Line 7:
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
       <ord:SetServiceConfiguration>
+
       <urn:SetServiceConfiguration>
         <ord:AccountID>1234567</ord:AccountID>
+
         <urn:PresaleSQID>112233</urn:PresaleSQID>
        <ord:PresaleSQID>112233</ord:PresaleSQID>
 
 
         <!--Optional:-->
 
         <!--Optional:-->
         <ord:PropertyCollections>
+
         <urn:Properties>
 
             <!--Zero or more repetitions:-->
 
             <!--Zero or more repetitions:-->
             <com:Property>
+
             <urn1:PropertyValue>
               <com:PropertyTypeID>133</com:PropertyTypeID>
+
               <urn1:TypeID>?</urn1:TypeID>
 
               <!--Optional:-->
 
               <!--Optional:-->
               <com:PropertyValue>string_value</com:PropertyValue>
+
               <urn1:Value>?</urn1:Value>
             </com:Property>
+
             </urn1:PropertyValue>
         </ord:PropertyCollections>
+
         </urn:Properties>
       </ord:SetServiceConfiguration>
+
       </urn:SetServiceConfiguration>
 
   </soapenv:Body>
 
   </soapenv:Body>
  
Line 32: Line 31:
 
'''Error String'''
 
'''Error String'''
  
* "Missing Account ID" - Account ID is not supplied.
+
* "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
 +
* "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
 
* "Account does not exist" - Account ID supplied does not exist in system.
 
* "Account does not exist" - Account 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.
 
* "Invalid Account ID" - Account ID supplied does not belong to the same parent group as the API caller.
* "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
 
* "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
 
 
* "Missing Package Plan" - Package Plan must be selected before calling this function.
 
* "Missing Package Plan" - Package Plan must be selected before calling this function.
* "Property(/ies) '[array dump]' required but missing in the Property Collection" - Required properties not supplied.
+
* "Missing required properties" (affected items in serialized array) - Required properties not supplied.
* "Property(/ies) '[array dump]' is/are unknown to Service Configuration" - Unknown properties supplied.
+
* "Unknown properties received" (affected items in serialized array) - Unknown properties supplied.

Latest revision as of 15:58, 21 July 2016

Set Service Configuration

Purpose: This call is used to configure any service configuration that is part of an order.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <urn:SetServiceConfiguration>
        <urn:PresaleSQID>112233</urn:PresaleSQID>
        <urn:Properties>
           <urn1:PropertyValue>
              <urn1:TypeID>?</urn1:TypeID>
              <urn1:Value>?</urn1:Value>
           </urn1:PropertyValue>
        </urn:Properties>
     </urn:SetServiceConfiguration>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:SetServiceConfigurationResponse>
        <ns1:Status>true</ns1:Status>
     </ns1:SetServiceConfigurationResponse>
  </SOAP-ENV:Body>

Error String

  • "Missing Account Presale SQ ID" - Account Presale SQ ID is not supplied.
  • "Account Presale SQ does not exist" - Account Presale SQ ID supplied does not exist in system.
  • "Account does not exist" - Account 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 Package Plan" - Package Plan must be selected before calling this function.
  • "Missing required properties" (affected items in serialized array) - Required properties not supplied.
  • "Unknown properties received" (affected items in serialized array) - Unknown properties supplied.