Status Object
Description
The Status object shows the processing status of the request. For XML only. Corresponds to the ResponseStatus object in JSON.
There are the following types:
- success - The request was successfully executed.
- error - The request has not been executed successfully.
- notify - The request is still in progress. Corresponds to an intermediate report, e.g. for transfers, here an asynchronous notification follows when the order is completed.
Structure
| Key | Occurs | Format | Description |
|---|---|---|---|
| type | 1 | String | The status type of the answer |
| code | 1 | String | Combination of result type S, E, N and task code. |
| text | 1 | String | System message with details about the status. |
| object | 1 | object | The object to which the status refers. |
XML Example
<status>
<code>S0905</code>
<text>The notification was polled successfully.</text>
<type>success</type>
<object>
<type>message</type>
<value>486721</value>
</object>
</status>