Response
The
<readSubscriberNaiResponse>
response returns the result of the request to read NAI subscriber routing
entities. Only those NAI subscriber 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.
Only provisioned destination names are displayed. (for example, destination
names=
"none" are not displayed).
Response Format
The response is displayed between the
<soapenv:Body>
and
</soapenv:Body>
XML tags of a
SOAP response message, as shown in
SOAP Response Messages.
<ns3:readSubscriberNaiResponse>
<result affected="affected" error="error" [description="description"]>
</result>
[
<resultSet>
<user="user" nai host="host">
[ <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> ]
</nai>
[
...
<user="user" nai host="host">
[ <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> ]
</nai>
]
</resultSet>
]
</ns3:readSubscriberNaiResponse>
Response Parameters
Table 4-23 <readSubscriberNaiResponse> Parameters (SOAP)
Parameter | Description | Values |
---|---|---|
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 read. | 0-10 |
description (Optional) | A textual description associated with the response. This field may contain more information as to why a request failed or a description of the changes if the request succeeded. | A string with 1 to 1024 characters. |
<resultSet> SOAP tag (optional) | Indicates rows of data are returned. If no records are being returned, this tag is not present. | A string with 1 to 1024 characters. |
host | The host name, which is used with all user values. | A string with 1 to 64 characters. |
user | The NAI user name to be associated with the host to form an NAI. | A string with 1 to 64 characters.
Must have 1-10 user values. |
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 (Optionnal) | The name of the second user defined destination. | A string with 1 to 32 characters. |
Error Codes
Table 4-24
lists the common error codes for the
<readSubscriberNaiResponse>
command. See
SDS Response Message Error Codes
for a complete list of error codes.
Table 4-24 <readSubscriberNaiResponse> Error Codes (SOAP)
Error Code | Description |
---|---|
SUCCESS | The read request was successfully completed. |
NAI_HOST_NOT_FOUND | Host name does not exist. |
NAI__NOT_FOUND | None of the specified NAIs exist. |