API/Services/SetServiceConfiguration

From Emersion
Revision as of 13:45, 29 June 2016 by Scarpenter (talk) (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...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Set Service Configuration

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

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ord:SetServiceConfiguration>
        <ord:AccountID>1234567</ord:AccountID>
        <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 Account ID" - Account ID is not supplied.
  • "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 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.
  • "Property(/ies) '[array dump]' required but missing in the Property Collection" - Required properties not supplied.
  • "Property(/ies) '[array dump]' is/are unknown to Service Configuration" - Unknown properties supplied.