Response

The <readSubscriberNaiResp> 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 eight 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

lengthInBytes
<readSubscriberNaiResp [id="id"]>
[
    originalXMLRequest
]
    <res error="error" affected="affected" [description="description"]/>
[
    <rset>
        <nai host="host" user="user">
    [       <imshss>imshss</imshss>       ]
    [       <ltehss>ltehss</ltehss>       ]
    [       <pcrf>pcrf</pcrf>             ]
    [       <ocs>ocs</ocs>                ]
    [       <ofcs>ofcs</ofcs>             ]
    [       <aaa>aaa</aaa>                ]
    [       <userdef1>userdef1</userdef1> ]
    [       <userdef2>userdef2</userdef2> ]
        </nai>
    [
        ...
        <nai host="host" user="user">
    [       <imshss>imshss</imshss>       ]
    [       <ltehss>ltehss</ltehss>       ]
    [       <pcrf>pcrf</pcrf>             ]
    [       <ocs>ocs</ocs>                ]
    [       <ofcs>ofcs</ofcs>             ]
    [       <aaa>aaa</aaa>                ]
    [       <userdef1>userdef1</userdef1> ]
    [       <userdef2>userdef2</userdef2> ]
        </nai>
    ]
    </rset>
]
</readSubscriberResp>

Response Parameters

<readSubscriberNaiResp> Parameters (XML)
Parameter	Description	Values
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 <readSubscriber> XML request that was sent. This is only present if the resonly=”n” attribute is set in the original request.	A string with 1 to 4096 characters.
error	Whether or not operation was successfully executed by the SDS.	0 - success, non zero - failure.
affected	The number of routing entities read.	0-10
description (Optional)	A textual description associated with the response. This may contain more information as to why a request failed. Only present when the request fails.	A string with 1 to 1024 characters.
<rset> XML tag (Optional)	Indicates rows of data are returned. If no records are being returned, this tag is not be present.
host	A 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 (Optional)	The name of the second user defined destination.	A string with 1 to 32 characters.

Response Error Codes

Table 2 lists the common error codes for the <readSubscriberNaiResp> command. See SDS Response Message Error Codes for a complete list of error codes.

<readSubscriberNaiResp> Error Codes (XML)
Error Code	Description
SUCCESS	The delete request was successfully completed.
NAI_HOST_NOT_FOUND	Host name does not exist.
NAI_NOT_FOUND	None of the specified NAI exists.
TOO_MANY_NAI	Too many NAI values supplied.
MISSING_PARAMETER	A mandatory parameter is missing.