Purge Estimate
The
purgeEstimate
operation accepts a criteria comprising start date, end date, and order type. For each invocation, the estimated number of orders that are to be purged, based on the input criterion, is returned to the web service client. In case of a malformed request or error in the processing, a fault message is sent back as a web service response.
End-point URL:
http://<HOST>:<PORT>/omsServer/api/purgeOrderService
The request message format is as follows:
Element Name | Element Type | Description |
---|---|---|
startDate | DateTime
(Mandatory, Choice) |
The start date and time specified in the purge estimate criterion |
endDate | DateTime | The end date and time specified in purge estimate criterion |
orderType | String
(Mandatory, Choice) |
Order type
Valid values for order type are:
|
The response message format is as follows:
Element Name | Element Type | Description |
---|---|---|
ordersEstimate | integer | The number of orders that are estimated to be purged |