Difference between revisions of "API/Services/GetServiceIdentifierRequirements"

Latest revision as of 15:43, 21 July 2016

Get Service Identifier Requirements

Purpose: This request is designed to advise of any service identifier requirements beyond service-based identifiers which are part of the SQ process. E.g. Those used for authentication purposes.

Inputs

  <soapenv:Header/>
  <soapenv:Body>
     <urn:GetServiceIdentifierRequirements>
        <urn:ServicePlanID>1234567</urn:ServicePlanID>
     </urn:GetServiceIdentifierRequirements>
  </soapenv:Body>

Outputs

  <SOAP-ENV:Body>
     <ns2:GetServiceIdentifierRequirementsResponse>
        <ns2:ServiceIdentifier>
           <ns1:Type ID="100161">Service Number</ns1:Type>
           <ns1:RealmIsRequired>true</ns1:RealmIsRequired>
           <ns1:IsAuthenticationBased>true</ns1:IsAuthenticationBased>
        </ns2:ServiceIdentifier>
     </ns2:GetServiceIdentifierRequirementsResponse>
  </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 Type)" - Service Plan ID supplied does not have a valid Service Type.
• "Invalid Service Plan (Missing Service Check Type)" - Service Plan ID supplied does not have a valid Service Check Type.