POST api/Vendor/UpdateTaskProofOfDelivery
Update information for Proof of Delivery Task (DELIVER)
Request Information
URI Parameters
None.
Body Parameters
TaskProofOfDeliveryParm| Name | Description | Type | Additional information |
|---|---|---|---|
| UserGUID |
Unique system generated user identifier |
string |
None. |
| EntityGUID |
Unique system generated entity identifier (ShipmentGUID) |
string |
None. |
| Signature |
Text representation of the signature (not image) |
string |
None. |
| WaitingTime |
Waiting time in minutes at delivery |
integer |
None. |
| Attempts |
Number of delivery attempts |
integer |
None. |
| Comment |
Comments regarding the delivery |
string |
None. |
| SignatureImage |
Signature image data, base64 string |
string |
None. |
| LocationData |
Geocoded location data from device |
string |
None. |
| Photos |
List of photo images (base64) |
Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{
"UserGUID": "sample string 1",
"EntityGUID": "sample string 2",
"Signature": "sample string 3",
"WaitingTime": 1,
"Attempts": 1,
"Comment": "sample string 4",
"SignatureImage": "sample string 5",
"LocationData": "sample string 6",
"Photos": [
"sample string 1",
"sample string 2"
]
}
application/xml, text/xml
Sample:
<TaskProofOfDeliveryParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Mobile.Models">
<Attempts>1</Attempts>
<Comment>sample string 4</Comment>
<EntityGUID>sample string 2</EntityGUID>
<LocationData>sample string 6</LocationData>
<Photos xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Photos>
<Signature>sample string 3</Signature>
<SignatureImage>sample string 5</SignatureImage>
<UserGUID>sample string 1</UserGUID>
<WaitingTime>1</WaitingTime>
</TaskProofOfDeliveryParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful |
Used to determine if method call was successful (true) or failure (false) |
boolean |
Required |
| 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/ParcelLogic.WebApi.Mobile.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>