POST api/Report/VerificationAtPickup
Generate the Verification At Pickup report
Request Information
URI Parameters
None.
Body Parameters
VerificationReportParmName | Description | Type | Additional information |
---|---|---|---|
auth |
Authorication token |
string |
None. |
PickupDateTime |
Pickup date/time (yyyy-MM-dd HH:mm) |
string |
None. |
DeliveryDateTime |
Delivery date/time (yyyy-MM-dd HH:mm) |
string |
None. |
PickupPostalCode | string |
None. |
|
DeliveryPostalCode | string |
None. |
|
ServiceID | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "DeliveryDateTime": "sample string 3", "DeliveryPostalCode": "sample string 5", "PickupDateTime": "sample string 2", "PickupPostalCode": "sample string 4", "ServiceID": 1, "auth": "sample string 1" }
application/xml, text/xml
Sample:
<VerificationReportParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <DeliveryDateTime>sample string 3</DeliveryDateTime> <DeliveryPostalCode>sample string 5</DeliveryPostalCode> <PickupDateTime>sample string 2</PickupDateTime> <PickupPostalCode>sample string 4</PickupPostalCode> <ServiceID>1</ServiceID> <auth>sample string 1</auth> </VerificationReportParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
VerificationReportRespName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
FileData |
Raw file data |
string |
None. |
FileName |
File name |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorMessage": "sample string 2", "FileData": "sample string 3", "FileName": "sample string 4", "IsSuccessful": true }
application/xml, text/xml
Sample:
<VerificationReportResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models"> <ErrorMessage>sample string 2</ErrorMessage> <FileData>sample string 3</FileData> <FileName>sample string 4</FileName> <IsSuccessful>true</IsSuccessful> </VerificationReportResp>