Table of contents

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

KeyOccursFormatDescription
type1String

The status type of the answer

code1String

Combination of result type S, E, N and task code.

text1StringSystem message with details about the status.
object1object

The object to which the status refers.
The type of the object indicates which type of object is in the data block.

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>