Difference between revisions of "API/Services/GetServiceFeatureConfigurationRequirements"

Revision as of 13:17, 29 June 2016

Get Service Feature Configuration Requirements

Purpose: In line with the current ordering process, there are frequently some service features that are either mandatory or optional. This call provides that list, taking into account any service features that are part of a group where only one can be chosen.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <ser:GetServiceFeatureConfigurationRequirements>
        <ser:ServicePlanID>1234567</ser:ServicePlanID>
     </ser:GetServiceFeatureConfigurationRequirements>
  </soapenv:Body>

Output

  <SOAP-ENV:Body>
     <ns1:GetServiceFeatureConfigurationRequirementsResponse>
        <ns1:ServiceFeature>
           <ns1:ServiceFeatureType ID="2905">GSM Voice Mail</ns1:ServiceFeatureType>
           <ns1:Product ID="1932022">GSM Voice Mail</ns1:Product>
           <ns1:AccessFee>
              <ns1:Amount>0.00</ns1:Amount>
              <ns1:TaxType ID="2">Australian GST</ns1:TaxType>
           </ns1:AccessFee>
           <ns1:Grouping>VOICEMAIL</ns1:Grouping>
           <ns1:BillingType>Advance</ns1:BillingType>
           <ns1:FeatureIdentifierType ID="2">CANNOT_HAVE_IDENT</ns1:FeatureIdentifierType>
           <ns1:DefaultOption ID="1">On</ns1:DefaultOption>
           <ns1:FeatureBehaviour>Forced, Removeable</ns1:FeatureBehaviour>
        </ns1:ServiceFeature>
        <ns1:ServiceFeature>
           <ns1:ServiceFeatureType ID="2904">GSM SMSMT</ns1:ServiceFeatureType>
           <ns1:Product ID="1932021">GSM SMSMT</ns1:Product>
           <ns1:AccessFee>
              <ns1:Amount>0.00</ns1:Amount>
              <ns1:TaxType ID="2">Australian GST</ns1:TaxType>
           </ns1:AccessFee>
           <ns1:BillingType>Advance</ns1:BillingType>
           <ns1:FeatureIdentifierType ID="2">CANNOT_HAVE_IDENT</ns1:FeatureIdentifierType>
           <ns1:DefaultOption ID="1">On</ns1:DefaultOption>
           <ns1:FeatureBehaviour>Forced, Irremovable</ns1:FeatureBehaviour>
        </ns1:ServiceFeature>
     </ns1:GetServiceFeatureConfigurationRequirementsResponse>
  </SOAP-ENV:Body>

Error String

• "Missing Service Plan ID" - Service Plan ID is not supplied.
• "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.
• "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.