Operation: OrderConfirmationQuery
- Michelle Zaczek (Unlicensed)
The element vcr:OrderConfirmationQueryRequest extends vct:RequestType with the following elements:
Name | Type/occurrence | Description |
|---|---|---|
vcr:DateRange | Range for document date. | |
vcr:OrderID | xsd:normalizedString* | Document number(s) of the corresponding order(s). |
The element vcr:OrderConfirmationQueryResponse extends vct:ResponseType with the optional element vcr:DateRange and a list of vcr:OrderConfirmationHeader elements. OrderConfirmationHeader comprises the following elements:
Name | Type/occurrence | Description |
|---|---|---|
vcr:OrderConfirmationID | xsd:normalizedString | Document number of order confirmation. |
cbc:IssueDate |
| Document date. |
vcr:Description | xsd:normalizedString? | Description. |
vcr:OrderID | xsd:normalizedString* | Corresponding orders. |
Rules: Server
An OrderConformationQueryRequest must be processed as follows: Determined are all order confirmations to which the search parameters DateRange and OrderID apply, as described in the section on document management.
The determined list of order confirmations is to be returned in the OrderConfirmationQueryResponse; any limitations of the search result are to be communicated via DateRange as described in document management.
If the server supports the OrderID search parameters, each OrderConfirmationHeader element must also contain at least one non-empty OrderID element, unless the order confirmation is actually not related to any order.
If the QueryRequest element contains an OrderID whereas the server does not support these search parameters, an OrderConfirmationQueryResponse with ResponseCode 404 is communicated.
If the server does not support the OrderID search parameters, it must communicate this in the profile via an UnsupportedQuery element with content OrderConfirmation-OrderID.
Rules: Client
OrderID search parameters may only be used if the server profile has not declared an absence of support for these search parameters.