POST api/Operations/UpdateTaskPickup/{auth}/{EntityGUID}/{EntityType}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
auth | string |
Required |
|
EntityGUID | string |
Required |
|
EntityType | string |
Required |
Body Parameters
TaskPickupParmName | Description | Type | Additional information |
---|---|---|---|
ActualPickupDate | date |
None. |
|
ActualPickupTime | date |
None. |
|
CheckInDate | date |
None. |
|
CheckInTime | date |
None. |
|
CourierServiceID | integer |
Required |
|
Weight | decimal number |
Required |
|
Distance | integer |
Required |
|
WaitingTime | integer |
None. |
|
AttemptCount | integer |
None. |
|
WeightUOM | string |
Required |
|
DistanceUOM | string |
Required |
|
NextStep | string |
Required |
|
LockCost | boolean |
Required |
Request Formats
application/json, text/json
Sample:
{ "ActualPickupDate": "2024-12-28T09:32:23.7705592+00:00", "ActualPickupTime": "2024-12-28T09:32:23.7705592+00:00", "CheckInDate": "2024-12-28T09:32:23.7705592+00:00", "CheckInTime": "2024-12-28T09:32:23.7705592+00:00", "CourierServiceID": 1, "Weight": 2.0, "Distance": 3, "WaitingTime": 1, "AttemptCount": 1, "WeightUOM": "sample string 4", "DistanceUOM": "sample string 5", "NextStep": "sample string 6", "LockCost": true }
application/xml, text/xml
Sample:
<TaskPickupParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ActualPickupDate>2024-12-28T09:32:23.7705592+00:00</ActualPickupDate> <ActualPickupTime>2024-12-28T09:32:23.7705592+00:00</ActualPickupTime> <AttemptCount>1</AttemptCount> <CheckInDate>2024-12-28T09:32:23.7705592+00:00</CheckInDate> <CheckInTime>2024-12-28T09:32:23.7705592+00:00</CheckInTime> <CourierServiceID>1</CourierServiceID> <Distance>3</Distance> <DistanceUOM>sample string 5</DistanceUOM> <LockCost>true</LockCost> <NextStep>sample string 6</NextStep> <WaitingTime>1</WaitingTime> <Weight>2</Weight> <WeightUOM>sample string 4</WeightUOM> </TaskPickupParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
TaskUpdateRespName | 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:
<TaskUpdateResp 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> </TaskUpdateResp>