2.2.3 Response Message Syntax
A response message specifies the format used to contain sub-responses (section 2.2.3.1) matching sub-requests (section 2.2.2.1) in the following format.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Protocol Version |
Minimum Version |
||||||||||||||||||||||||||||||
|
Signature |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Response Start |
|||||||||||||||||||||||||||||||
|
A |
Reserved |
Response Data (variable) |
|||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Response End |
|||||||||||||||||||||||||||||||
Protocol Version (2bytes): An unsigned integer that specifies the protocol schema version number used in this request. The valid values for this field are 12, 13 and 14.<25>
Minimum Version (2 bytes): An unsigned integer that specifies the oldest version of the protocol schema that this schema is compatible with. This value MUST be 11.
Signature (8 bytes): An unsigned integer that specifies a constant signature, to identify this as a response. This MUST be set to 0x9B069439F329CF9D.
Response Start (4 bytes): A 32-bit Stream Object Header (section 2.2.1.5.2) that specifies a response start.
A - Status (1 bit): If set, a bit that specifies that the request has failed and a Response Error (section 2.2.3.2) MUST follow.
Reserved (7 bits): A 7-bit reserved field that MUST be set to zero and MUST be ignored.
Response Data (variable): A Response Error that specifies the error information if the request failed. If the request did not fail, the response data is specified by the following structure.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Data Element Package (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
Sub-response (variable) |
|||||||||||||||||||||||||||||||
|
… |
|||||||||||||||||||||||||||||||
Data Element Package (variable): An optional Data Element Package structure (section 2.2.1.12) that specifies data elements corresponding to the sub-responses (section 2.2.3.1). If the sub-responses do not reference data elements or no data elements are available for the sub-response, this structure MUST be ignored if present.
Sub-response (variable): Specifies an array of sub-responses corresponding to the sub-requests, as specified in section 2.2.2.1.
Response End (2 bytes): A 16-bit Stream Object Header (section 2.2.1.5.4) that specifies a response end.