Response
The
<readSubscriberResp>
response
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).
Variations can occur in the response, depending on whether a subscriber is being retrieved or routing entities are being retrieved.
group="y"
was not specified or
group="n"
was specified):
- There will not be any
<subscriber>
or<accountId>
tags. - The destination values are listed within each IMSI, MSISDN, or External Identifier routing entity value.
If a subscriber is retrieved (group="y"
is specified):
- The
<subscriber>
tag is used within the<rset>
tag. - The
<accountId>
tag is displayed if the subscriber has an Account ID value defined. - The destination values are listed once, after the last routing entity.
Response Format (group="y"
is not specified)
lengthInBytes
<readSubscriberResp [id="id"]>
[
originalXMLRequest
]
<res error="error" affected="affected" [description="description"]/>
[
<rset>
[
<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=”externalIdentifier">
[ <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="externalIdentifier">
[ <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>
]
</rset>
]
</readSubscriberResp>
Response Format (group="y"
) is specified
lengthInBytes
<readSubscriberResp [id="id"]>
[
originalXMLRequest
]
<res error="error" affected="affected" [description="description"]/>
[
<rset>
<subscriber>
[ <accountiId>accountId</accountId>]
[ <imsi>imsi</imsi> ]
...
[ <imsi>imsi</imsi> ]
[ <msisdn>msisdn</msisdn> ]
...
[ <msisdn>msisdn</msisdn> ]
[ <imshss>imshss</imshss> ]
[ <externalId>extId</externalId> ]
...
[ <externalId>extId</externalId> ]
[ <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>
</rset>
]
</readSubscriberResp>
Response Parameters
Table 5-18 <readSubscriberResp> Parameters (XML)
Parameter | Description | Response |
---|---|---|
lengthinbytes | Number of bytes following to form XML request. This is a 4 byte binary value. | 0-4294967295 |
id (Optional) | Transaction ID value provided in request and passed back in the response. | 1-4294967295 |
originalXMLRequest (Optional) |
The text of the original
Note: This is only present if the
|
A string with 1 to 4096 characters. |
error | Error code. Whether or not operation was successfully executed by the XDS. | 0 - success, non zero - failure. |
affected | If
group="y" , then the number of subscribers read
(0 or 1). Otherwise, the number of routing entities read (0 - 10).
|
0-10 |
description (Optional) | A textual description associated with the response. This may contain more information as to why a request failed. | A string with 1 to 1024 characters. |
rset | Contains 1 row for each extracted record. Each row contains a standalone routing entity (MSISDN or IMSI value with its destination values) or a subscriber (list of related MSISDN, IMSI and Account ID values with the destination values that are used by all routing entities assigned to the subscriber.) | |
subscriber (Optional) | Contains all IMSI and MSISDN values for a specific subscriber with 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). | 10 to 15 numeric digits. |
msisdn (Optional) | An MSISDN (specified in E.164 international public telecommunication numbering plan format). | 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. |
Response Error Codes
readSubscriberResp
> command. See
SDS Response Message Error Codes
for a complete list of error codes.
Table 5-19 <readSubscriberResp> Error Codes (XML)
Error Code | Description |
---|---|
SUCCESS | The read request was successfully completed. |
TOO_MANY_ADDR | Too many address values supplied. |
TOO_MANY_EXTERNAL_IDENTFIER | Too many external identifier address values supplied. |
MISSING_PARAMETER | A mandatory parameter is missing. |
IMSI_NOT_FOUND | The specified IMSI does not exist. |
MSISDN_NOT_FOUND | The specified MSISDN does not exist. |
EXTERNAL_IDENTIFIER_NOT_FOUND | External Identifier does not exist. |
SUBSCRIBER_NOT_FOUND | The subscriber does not exist. |
MULTIPLE_SUBSCRIBERS | Specified parameters refer to multiple subscribers. |
ROUTE_TYPE_MISMATCH | Standalone and subscriber routes are not allowed in same command. |