SOAP Response Messages

4.3 SOAP Response Messages

A SOAP response message is sent by the SOAP provisioning client in response to a SOAP request. Each response contains a series of ASCII characters.

A rowset, contained between the <rset> tags, is present if data is to be returned (for example, for <readSubscriberRequest>, <readSubscriberNaiRequest>, and <readDomainRequest>).

A generic response type can be generated if a SOAP request cannot be parsed, the request is not valid, etc. The responsename for this generic response is errorResponse.

<res error="error" affected="affected" [description="description"]/>

Response Format (<readSubscriberResponse>, <readSubscriberNaiResponse>, and <readDomainRequest> requests)

The bolded text differs for each response message.

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Type: text/xml; charset=utf-8; action="”
Content-Length: lengthInBytes
Connection: keep-alive

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd="http://www.w3.org/2001/XMLSchema”
xmlns:ns2="http://www.tekelec.com/sds/"
xmlns:ns4="http://www.tekelec.com/sds/dsr/"
xmlns:ns3="http://www.tekelec.com/sds/dsr/soap/"
xmlns:ns5="http://www.tekelec.com/sds/soap"
    <SOAP-ENV:Header></SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <respName>
            <result affected="affected" error="error" 
                [description="description"]>
            </result>
        [
            <resultSet>
                <rowName> [ [rowAttributeName]="rowAttributeValue"] …
                            [rowAttributeName]="rowAttributeValue"] ]>
                    <rowValueName>rowValue</rowValueName>
                    ...
                    <rowValueName>rowValue</rowValueName>
                </rowName>
                ...
                <rowName> [ [rowAttributeName]="rowAttributeValue"] …
                           [rowAttributeName]="rowAttributeValue"] ]>
                    <rowValueName>rowValue</rowValueName>
                    ...
                    <rowValueName>rowValue</rowValueName>
                </rowName>
            </resultSet>
        ]
        </respName>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Response Format (All Other Requests)

This example shows the format for all SOAP responses. The bolded text varies for each response message.

HTTP/1.1 200 OK
Server: gSOAP/2.7
Content-Type: text/xml; charset=utf-8; action="”
Content-Length: lengthInBytes
Connection: keep-alive

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/”
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsd="http://www.w3.org/2001/XMLSchema”
xmlns:ns2="http://www.tekelec.com/sds/"
xmlns:ns4="http://www.tekelec.com/sds/dsr/"
xmlns:ns3="http://www.tekelec.com/sds/dsr/soap/"
xmlns:ns5="http://www.tekelec.com/sds/soap"
    <SOAP-ENV:Header></SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <ns2:sdsResult affected="affected" error="error" 
            [description="description"]>
        </ns2:sdsResult>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SOAP Response Message Parameters

Table 4-3 Response Message Parameters (SOAP)

Parameter	Description	Value
lengthInBytes	Number of bytes in the SOAP request.	0-4294967295
error	Error code that indicates whether or not operation was successfully executed. See SDS Response Message Error Codes.	0 for success, non-zero for failure
affected	The number of routing entities or subscribers (when group=”y”) created/updated/deleted/read. This number does not contain number of subscriber records created/update/deleted because “subscriber” data is not used for routing. It is possible to have affected=0 and error=0.	0-10
description (Optional)	A textual description associated with the response. This field may contain more information as to why a request failed or describe the changes if a request succeeds.	A string with 1 to 1024 characters
respName (Optional)	The name of the response.	This field is only used for read responses and errors
rowName	The name of the row type returned.	The value is dependent on the result set returned
rowValue	The value of the row type returned.	The value is dependent on the result set returned
rowAttributeName	The name of the row attribute name returned.	The value is dependent on the result set returned
rowAttributeValue	The value of the row attribute name returned.	The value is dependent on result set returned