1. Provisioning Interface
  2. SOAP Message Definitions
  3. Read Subscriber
  4. Response

Response

The <readSubscriberResponse> message returns the result of the request to read subscriber routing entities. Only those subscribers or routing entities that are found are returned. The response message contains up to nine destinations (one for each destination type, such as <ltehss>) for each routing entity or subscriber. Only provisioned destination names are displayed. (for example, destination names= "none" are not displayed).

Some variations in the response occur, depending on whether a subscriber or routing entities are being retrieved.

Routing entities are retrieved (group="y" is not specified or group="n" is specified):
  • No <subscriber> or <accountId> tags are used.
  • The destination values are listed within each IMSI, MSISDN, or External Identifier routing entity value.
A subscriber is retrieved (group="y" was specified):
  • The <subscriber> tag is used within the <resultSet> tag.
  • The <accountId> tag is displayed if the subscriber has an Account ID value defined.
  • The destination values are listed one time, after the last routing entity.

Response Format (group="y" is not specified)

The response is displayed between the <soapenv:Body> and </soapenv:Body> XML tags of a SOAP response message, as shown in SOAP Response Messages. 
<readSubscriberResponse>
    <result affected="affected" error="error" [description="description"]>
    </result>
    [
    <resultSet>
    [
        <imsi imsi="imsi">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]
        [   <mtchss>mtchss</mtchss>       ]
        </imsi>
              ...
        <imsi imsi="imsi">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]
        [   <mtchss>mtchss</mtchss>       ]
        </imsi>
    ]
    [
        <msisdn msisdn="msisdn">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]
        [   <mtchss>mtchss</mtchss>       ]
        </msisdn>
                ...
        <msisdn msisdn="msisdn">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]
        [   <mtchss>mtchss</mtchss>       ]
        </msisdn>
    ]
    [
        <externalId externalId="extId">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]        
        [   <mtchss>mtchss</mtchss>       ]        
        </externalId>
                ...
        <externalId externalId="extId">
        [   <imshss>imshss</imshss>       ]
        [   <ltehss>ltehss</ltehss>       ]
        [   <pcrf>pcrf</pcrf>             ]
        [   <ocs>ocs</ocs>                ]
        [   <ofcs>ofcs</ofcs>             ]
        [   <aaa>aaa</aaa>                ]
        [   <userdef1>userdef1</userdef1> ]
        [   <userdef2>userdef2</userdef2> ]        
        [   <mtchss>mtchss</mtchss>       ]
        </externalId>
    ]
    </resultSet>
]
</readSubscriberResponse>

Response Format (group="y" is specified)

The response is displayed between the <soapenv:Body> and </soapenv:Body> XML tags of a SOAP response message, as shown in SOAP Response Messages. 
<readSubscriberResponse>
    <result affected="affected" error="error" [description="description"]/>
    [
    <resultSet>
        <subscriber>
        [   <accountId>accountId</accountId> ]
        [
        [   <imsi>imsi</imsi>                ]
                  ...
        [   <imsi>imsi</imsi>                ]
        [   <msisdn>msisdn</msisdn>          ]
                    ...
        [   <msisdn>msisdn</msisdn>          ]
        [   <externalId>extId1</externalId>  ]
                    ...
        [   <externalId>extIdn</externalId>  ]
        [   <imshss>imshss</imshss>          ]
        [   <ltehss>ltehss</ltehss>          ]
        [   <pcrf>pcrf</pcrf>                ]
        [   <ocs>ocs</ocs>                   ]
        [   <ofcs>ofcs</ofcs>                ]
        [   <aaa>aaa</aaa>                   ]
        [   <userdef1>userdef1</userdef1>    ]
        [   <userdef2>userdef2</userdef2>    ]
        [   <mtchss>mtchss</mtchss>          ]
        </subscriber>
    </resultSet>
    ]
</readSubscriberResponse>

Response Parameters

Table 4-16 <readSubscriberResponse> Parameters (SOAP)

Parameter Description Values
group (Optional) Indicates if all of the subscriber’s data should be retrieved or just specified IMSI, MSISDN, or External Identifier routing entities.

y - Read subscriber and all of its IMSI, MSISDN, and External Identifier routing entities.

n - Only read specified MSISDN, IMSI, and External Identifier routing entities (default).

error Error code that indicates whether or not operation was successfully executed. 0 for success, non-zero for failure.
affected The number of routing entities or subscribers (for group=”y”) read. 0-12
description A textual description associated with the response. This field may contain more information as to why a request failed. A string with 1 to 1024 characters.
resultSet Contains 1 row for each extracted record. Each row contains a standalone routing entity (IMSI, MSISDN, or External Identifier value and its destination values) or a subscriber (list of related IMSI, MSISDN, External Identifier, and Account ID values and the destination values used by all routing entities assigned to the subscriber).
subscriber (Optional) Contains all of the IMSI, MSISDN, and External Identifier values for a specific subscriber, an optional Account ID, and all destinations defined for the subscriber.  
accountId (Optional) A user-defined Account ID value. 1 to 26 numeric digits.
imsi (Optional) An IMSI (specified in E.212 format) value. 10 to 15 numeric digits.
msisdn (Optional) An MSISDN (specified in E.164 international public telecommunication numbering plan format) value. 8 to 15 numeric digits.
externalId (Optional) An External Identifier (specified in NAI format) value. A string with 3 to 257 characters.
imshss (Optional) The name of the IMS HSS destination. A string with 1 to 32 characters.
ltehss (Optional) The name of the LTE HSS destination. A string with 1 to 32 characters.
pcrf (Optional) The name of the PCRF destination. A string with 1 to 32 characters.
ocs (Optional) The name of the OCS destination. A string with 1 to 32 characters.
ofcs (Optional) The name of the OFCS destination. A string with 1 to 32 characters.
aaa (Optional) The name of the AAA server destination. A string with 1 to 32 characters.
userdef1 (Optional) The name of the first user defined destination. A string with 1 to 32 characters.
userdef2 (Optional) The name of the second user defined destination. A string with 1 to 32 characters.
mtchss (Optional) The name of the MTC HSS destination. A string with 1 to 32 characters.

Error Codes

Table 4-17 lists common errors for the <readSubscriberResponse> command. See SDS Response Message Error Codes for a complete list of error codes.

Table 4-17 <readSubscriberResponse> Error Codes (SOAP)

Error Code Description
SUCCESS The read request was successfully completed.
IMSI_NOT_FOUND IMSI does not exist.
MSISDN_NOT_FOUND MSISDN does not exist.
SUBSCIRIBER_NOT_FOUND The subscriber could not be found in the database.
MULTIPLE_SUBSCRIBERS Specified parameters refer to multiple subscribers.
ROUTE_TYPE_MISMATCH Standalone and subscriber routes are not allowed in same command.
NO_ROUTES_SPECIFIED At least one IMSI, MSISDN, or External Identifier must be specified.
DOMAIN_IDENTIFIER_NOT_FOUND Domain Identifier does not exist.
EXTERNAL_IDENTIFIER_NOT_FOUND External Identifier does not exist.