Difference between revisions of "API/Services/SetServiceFeatureSetup"

From Emersion
Jump to: navigation, search
(Created page with "=== Get Service Feature Set Up === '''Purpose:''' Based on the requirements (optional or mandatory) gathered in the API call API/Services/SetServiceConfiguration| Set Servi...")
 
 
Line 7: Line 7:
 
   <soapenv:Header/>
 
   <soapenv:Header/>
 
   <soapenv:Body>
 
   <soapenv:Body>
−
       <ord:SetServiceFeatureSetup>
+
       <urn:SetServiceFeatureSetup>
−
         <ord:AccountPresaleSQID>112233</ord:AccountPresaleSQID>
+
         <urn:AccountPresaleSQID>112233</urn:AccountPresaleSQID>
 
         <!--Optional:-->
 
         <!--Optional:-->
−
         <ord:ServiceFeatureCollections>
+
         <urn:ServiceFeatures>
 
             <!--Zero or more repetitions:-->
 
             <!--Zero or more repetitions:-->
−
             <ser:ServiceFeature>
+
             <urn1:ServiceFeature>
−
               <ser:ServiceFeatureType ID="1">1</ser:ServiceFeatureType>
+
               <urn1:Type ID="1">1</urn1:Type>
−
               <!--Optional:-->
+
               <urn1:FeatureIdentifier>abc123</urn1:FeatureIdentifier>
−
              <ser:FeatureIdentifier>abc123</ser:FeatureIdentifier>
+
               <urn1:OptionType ID="1">1</urn1:OptionType>
−
               <!--Optional:-->
+
             </urn1:ServiceFeature>
−
              <ser:OptionTypeID ID="1">1</ser:OptionTypeID>
+
         </urn:ServiceFeatures>
−
             </ser:ServiceFeature>
+
       </urn:SetServiceFeatureSetup>
−
         </ord:ServiceFeatureCollections>
 
−
       </ord:SetServiceFeatureSetup>
 
 
   </soapenv:Body>
 
   </soapenv:Body>
  
Line 38: Line 36:
 
* "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 Package Plan" - Package Plan must be selected before calling this function.
 
* "Missing Package Plan" - Package Plan must be selected before calling this function.
−
* "Error(s) found:" - could be one of more of the following:
+
* "No Service Features to set for Account Presale SQ:"
−
* "Option Type ID ([option_type_id]) supplied for Service Feature Type ([feature_type_id]) is not valid"
+
* Error(s) found are stored in serialized array, and could be one of more of the following:
 +
** "Option Type ID ([option_type_id]) supplied for Service Feature Type ([feature_type_id]) is not valid"
 
** "Service Feature Type ([feature_type_id]) cannot have identifier"
 
** "Service Feature Type ([feature_type_id]) cannot have identifier"
 
** "Service Feature Type ([feature_type_id]) must have identifier"
 
** "Service Feature Type ([feature_type_id]) must have identifier"
 +
** "UnknownFeatureTypeID" - Feature Type ID shown is unknown.

Latest revision as of 16:05, 21 July 2016

Get Service Feature Set Up

Purpose: Based on the requirements (optional or mandatory) gathered in the API call Set Service Configuration this API call is used to configure any service features. Note: This cannot be configured until the 'Package Plan' is selected.

Inputs 

  <soapenv:Header/>
  <soapenv:Body>
     <urn:SetServiceFeatureSetup>
        <urn:AccountPresaleSQID>112233</urn:AccountPresaleSQID>
        <urn:ServiceFeatures>
           <urn1:ServiceFeature>
              <urn1:Type ID="1">1</urn1:Type>
              <urn1:FeatureIdentifier>abc123</urn1:FeatureIdentifier>
              <urn1:OptionType ID="1">1</urn1:OptionType>
           </urn1:ServiceFeature>
        </urn:ServiceFeatures>
     </urn:SetServiceFeatureSetup>
  </soapenv:Body>

Output 

  <SOAP-ENV:Body>
     <ns1:SetServiceFeatureSetupResponse>
        <ns1:Status>true</ns1:Status>
     </ns1:SetServiceFeatureSetupResponse>
  </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.
  • "No Service Features to set for Account Presale SQ:"
  • Error(s) found are stored in serialized array, and could be one of more of the following:
    • "Option Type ID ([option_type_id]) supplied for Service Feature Type ([feature_type_id]) is not valid"
    • "Service Feature Type ([feature_type_id]) cannot have identifier"
    • "Service Feature Type ([feature_type_id]) must have identifier"
    • "UnknownFeatureTypeID" - Feature Type ID shown is unknown.
Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=API/Services/SetServiceFeatureSetup&oldid=4725"