Difference between revisions of "API/Services/SetServiceIdentifier"

From Emersion
Jump to: navigation, search
(Created page with "=== Set Service Identifier === '''Purpose:''' Based on the requirements gathered in Get Service Contact Requirements this metho...")
 
 
Line 1: Line 1:
 
=== Set Service Identifier ===
 
=== Set Service Identifier ===
  
'''Purpose:''' Based on the requirements gathered in [[API/Services/GetServiceContactRequirements|Get Service Contact Requirements]] this method will populate the service contact information that is required for an order.
+
'''Purpose:''' Based on the requirements gathered in [[API/Services/GetServiceIdentifierRequirements|Get Service Identifier Requirements]] this method will populate the service identifier information that is required for an order.
  
 
'''Inputs'''
 
'''Inputs'''
Line 8: Line 8:
 
   <soapenv:Body>
 
   <soapenv:Body>
 
       <ord:SetServiceIdentifier>
 
       <ord:SetServiceIdentifier>
         <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID>
+
         <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID> <!-- mandatory -->
         <ord:Username>emersion</ord:Username>
+
         <ord:Username>emersion</ord:Username> <!-- mandatory -->
         <ord:Realm>communitytelco.com.au</ord:Realm>
+
         <ord:Realm>yourrealm.com.au</ord:Realm> <!-- optional -->
         <ord:Password>emersion123!</ord:Password>
+
         <ord:Password>emersion123!</ord:Password> <!-- optional -->  
 
       </ord:SetServiceIdentifier>
 
       </ord:SetServiceIdentifier>
 
   </soapenv:Body>
 
   </soapenv:Body>

Latest revision as of 13:16, 26 April 2019

Set Service Identifier

Purpose: Based on the requirements gathered in Get Service Identifier Requirements this method will populate the service identifier information that is required for an order.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ord:SetServiceIdentifier>
        <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID> 
        <ord:Username>emersion</ord:Username> 
        <ord:Realm>yourrealm.com.au</ord:Realm> 
        <ord:Password>emersion123!</ord:Password>  
     </ord:SetServiceIdentifier>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:SetServiceIdentifierResponse>
        <ns1:Status>true</ns1:Status>
     </ns1:SetServiceIdentifierResponse>
  </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 Username" - Username is not supplied.
  • "Invalid Username" - Username does not meet username policy.
  • "Missing Password" - Password is not supplied.
  • "Invalid Password" - Password does not meet password policy.