API/Services/GetServiceIdentifierRealm

Get Service Identifier Realm

Purpose: This request is designed to be gather requirements related to realms, which are an aspect of service identifiers. This will return a list of available identifier realms that are presently associated against the parent account.

Inputs

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

Outputs

  <SOAP-ENV:Body>
     <ns1:GetServiceIdentifierRealmResponse>
        <ns1:Realm>
           <ns1:RealmID>30024</ns1:RealmID>
           <ns1:RealmName>au.bbtelco</ns1:RealmName>
        </ns1:Realm>
        <ns1:Realm>
           <ns1:RealmID>30025</ns1:RealmID>
           <ns1:RealmName>au.communitytelco</ns1:RealmName>
        </ns1:Realm>
     </ns1:GetServiceIdentifierRealmResponse>
  </SOAP-ENV:Body>

Error String

• "Missing Service Plan ID" - Service Plan ID is not supplied.
• "Invalid Service Plan ID" - Service Plan ID supplied is less than 6 characters.
• "Undefined Service Plan" - Service Plan ID does not exist or not belong to the API caller account.
• "Undefined Service Type" - Service Plan does not contain service type.