POST api/Integration/MarkRecovered
Used to mark a shipment recovered
Request Information
URI Parameters
None.
Body Parameters
MarkRecoverParm| Name | Description | Type | Additional information |
|---|---|---|---|
| FromCompanyGUID | string |
None. |
|
| FromShipmentGUID | string |
None. |
|
| FromShipmentNumber | integer |
None. |
|
| ToCompanyGUID | string |
None. |
|
| ToShipmentGUID | string |
None. |
|
| RecoverDateTimeUTC | date |
None. |
Request Formats
application/json, text/json
Sample:
{
"FromCompanyGUID": "sample string 1",
"FromShipmentGUID": "sample string 2",
"FromShipmentNumber": 3,
"ToCompanyGUID": "sample string 4",
"ToShipmentGUID": "sample string 5",
"RecoverDateTimeUTC": "2025-11-03T09:05:56.3022954-08:00"
}
application/xml, text/xml
Sample:
<MarkRecoverParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <FromCompanyGUID>sample string 1</FromCompanyGUID> <FromShipmentGUID>sample string 2</FromShipmentGUID> <FromShipmentNumber>3</FromShipmentNumber> <RecoverDateTimeUTC>2025-11-03T09:05:56.3022954-08:00</RecoverDateTimeUTC> <ToCompanyGUID>sample string 4</ToCompanyGUID> <ToShipmentGUID>sample string 5</ToShipmentGUID> </MarkRecoverParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Set to true if method was successful |
boolean |
None. |
| ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>