Standard Properties
In every request and response, a set of standard properties is always present. If a property is not applicable for a specific method, this will be explicitly mentioned in the method specification.
Request Standard Properties
| Property | Typical Value | Type | Required | Description |
|---|---|---|---|---|
| PROTOCOL | IPP | String | YES | Mandatory at the beginning of the message. Indicates the protocol used. Only IPP is used unless otherwise stated. |
| VERSION | 201 | Integer | YES | Whole number specifying the protocol version. 201 stands for version 2.1. Supported versions: 100, 101, 102, 103, 104, 105, 106, 200, 201. |
| METHOD | PURCHASE | String | YES | Name of the method. |
| SID | 126ca831-93d2-4dfc-ab1f-0cce1d0abe9e | String | YES | Session ID. User-specified unique transmission identifier (up to 127 characters). The terminal does not check for uniqueness. The SID is used in subsequent commands where applicable. The value and format are defined by the caller. |
Response Standard Properties
| Property | Typical Value | Type | Required | Description |
|---|---|---|---|---|
| PROTOCOL | IPP | String | YES (Echo) | Echo from request. |
| METHOD | PURCHASE | String | YES (Echo) | Echo from request. |
| SID | 126ca831-93d2-4dfc-ab1f-0cce1d0abe9e | String | YES (Echo) | Echo from request. |
| STATUS | 0 | Integer | YES | Please refer to Status Stages for details. |
| STAGE | 1 | Integer | YES | Please refer to Stages for details. |
| TIMEOUT | 30 | Integer | NO | (Optional) The time, in seconds, that the caller should wait for the next answer. |
Legend:
- M – Mandatory
- ME – Mandatory, Echo from request
- O – Optional