Response
This is the start of your topic.
The
<readDomainResp>
response returns the result of
the request to read Domain Identifiers. Only those Domain Identifiers that are
found are returned. The response message contains up to nine destinations (1
for each destination type, such as
<ltehss>
) for each domain identifier value. Only
provisioned destination names are displayed. (that is, destination names="none"
are not displayed).
Response Format
<readDomainResp>
request is show here. For more
information, see
XML Response Messages.
lengthInBytes
<readDomainResp [id="id"]>
[
originalXMLRequest
]
<res error="error" affected="affected" [description="description"]/>
[
<rset>
<domain="domainidentifier">
[ <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> ]
</domain>
[
...
<domain="domainidentifier">
[ <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> ]
</domain>
]
</rset>
]
</readDomainResp>
Response Parameters
Table 5-32 <readDomainResp> Parameters (XML)
Parameter | Description | Value |
---|---|---|
lengthInBytes | Number of bytes following to form XML request. This is a 4 byte binary value. | 0-4294967295 |
respName |
The name of the response based on the original XML request
sent. Value is the request name appended with "Resp". For example, for the
Note: This is only present if the
|
A string with 64 characters. |
id | Transaction ID value provided in request and passed back in the response. | 0-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 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. | 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 will not be present. | |
domain | The domain Identifier name, which is used for configuring external identifier by associating them with local identifier values. Must have one or up to 10 domain identifier values. | A string with 1 to 128 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
Table 5-33 lists common error codes for this command. See SDS Response Message Error Codes for a complete list of error codes.
Table 5-33 <readDomainResp> Error Codes (XML)
Error Code | Description |
---|---|
SUCCESS | The update request was successfully completed. |
DOMAIN_IDENTIFIER_NOT_FOUND | Domain Identifier does not exist. |
NO_DOMAIN_VAL | No Domain Identifier value supplied. |
TOO_MANY_ADDR | Too many address values supplied. |