Response Message Structure

Field Name

Type

Description

Version

int

2 (Version number of the message structure).

RequestId

DWORD

Request identifier specified by the client to identify the response. The server fills this slot with the value in the request data.

ResultCode

enum

Enumeration indicating how the request was processed.

Succeeded (0)

The SOAP request was processed successfully and without fault.

Failed (1)

The SOAP request failed. This flag is set by the ‘SOAP Send Response' tool when the body contains a <Fault> element. A client can thus check for a failed request without having to unpack the payload.

Unhandled (2)

The Initiator fired, but the handler did not invoke ‘SOAP Send Response' to return a response (the ‘SOAP Request' handle went out of scope).
The payload and transport control data are empty.

TransportControlSize

DWORD

Size in bytes of the transport control data block

TransportControlData

BYTE[]

Transport control data. This is an XML document that contains transport specific out-of-band control data. For example, for HTTP it contains additional HTTP header fields or status codes to convey special failures. The default character set is UTF-8, but the data may contain an XML declaration with the appropriate encoding attribute. Data block may be empty.

PayloadSize

DWORD

Size in bytes of the SOAP response payload data block. The default character set is UTF-8, but the data may contain an XML declaration with the encoding attribute.

PayloadData

BYTE[]

This is the data of the SOAP response envelope. The data block is empty if the ‘Unhandled' flag is set.