Function: changeOrder

Update or alter an existing order by adding or changing the properties of the order.

Usage: changeOrder

Once the initial order has been sent to a contractor, it may be updated in order to supply additional information. For instance the (temporary) location where a service should be done, or a specific date which has been agreed with the client.

# Variant Description
1 correction Replace the entire order by a new version.
2 update Apply a partial change to the order.

Technical specifications: changeOrder

Input: changeOrder

The orderNumber must be supplied in the path header parameter, the functionVariant parameter directing the change is included in the body.
From a functional point of view there are no mandatory attributes, the body section can be used to provide a complete or partial set of claim information.

Name Variant Type Description
orderStructure
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
order all Request for a service by a third party.
Any attributes of the order entity.

Output: changeOrder

Name Variant Type Description
orderStructure
commonFunctional Entity for general information with regard to structure, handling and processing.
entityType all string Set to ‘default’.
dataCatalogVersion all ADNAFM Version of the data catalog on which the message is based.
functionVariant all APIVAR The function variant is used to determine the additional set of required and optional input and output data.
order all Request for a service by a third party.
Any attributes of the order entity.

Errors

When a negative response is generated, it follows the general rules as described in the Error section of the Status codes and error handling chapter.

Click below to see the Open Api Specification (3.0.0)

Under construction.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment