GET api/orders/{OrderNumber}/validateForCompletion

Validates that an order is ready to complete

Request Information

URI Parameters

NameDescriptionTypeAdditional information
OrderNumber

Work order number

integer

Required

Body Parameters

None.

Response Information

Resource Description

A structure indicating the validity of the order with respect to its readiness to complete.

OrderCompletionValidationResponse
NameDescriptionTypeAdditional information
ValidationToken

If successfully validated, a toen to use to actually complete the order

string

None.

Issues

Indicates what is wrong with the order, if anything.

OrderCompletionValidationFailure

None.

Response Formats

application/json, text/json

Sample:
{
  "ValidationToken": "sample string 1",
  "Issues": 0
}

application/xml, text/xml

Sample:
<OrderCompletionValidationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ValidationToken>sample string 1</ValidationToken>
  <Issues>None</Issues>
</OrderCompletionValidationResponse>