POST api/Integration/MarkRecovered
Request Information
URI Parameters
None.
Body Parameters
MarkRecoverParmName | Description | Type | Additional information |
---|---|---|---|
FromCompanyGUID | string |
None. |
|
FromShipmentGUID | string |
None. |
|
FromShipmentNumber | integer |
None. |
|
ToCompanyGUID | string |
None. |
|
ToShipmentGUID | string |
None. |
|
RecoverDateTimeUTC | date |
None. |
|
Latitude | decimal number |
None. |
|
Longitude | decimal number |
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": "2024-12-28T08:57:30.7387363+00:00", "Latitude": 1.0, "Longitude": 1.0 }
application/xml, text/xml
Sample:
<MarkRecoverParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <FromCompanyGUID>sample string 1</FromCompanyGUID> <FromShipmentGUID>sample string 2</FromShipmentGUID> <FromShipmentNumber>3</FromShipmentNumber> <Latitude>1</Latitude> <Longitude>1</Longitude> <RecoverDateTimeUTC>2024-12-28T08:57:30.7387363+00: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
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful | boolean |
None. |
|
ErrorMessage | 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/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>