POST api/OpsLog/UpdateTaskPickup/{auth}/{EntityGUID}/{EntityType}

Use this method to update information from the Pickup task

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	The authorization GUID for this user session	string	Required
EntityGUID	The entity identifer of the task	string	Required
EntityType	The entity type of the task (should only be "P")	string	Required

Body Parameters

(see example below)

TaskPickupParm

Name	Description	Type	Additional information
ActualPickupDate	Actual date of pickup	date	None.
ActualPickupTime	Actual time of pickup	date	None.
CheckInDate	Check In Date	date	None.
CheckInTime	Check In Time	date	None.
CourierServiceID	Courier service identifier	integer	Required
Weight	Weight of all shipments on pickup	decimal number	Required
Distance	Total distance from pickup to airport/delivery	integer	Required
WaitingTime	Waiting time at pickup in minutes	integer	None.
AttemptCount	Number of pickup attempts	integer	None.
WeightUOM	Weight units (LB,KG)	string	Required
DistanceUOM	Distance unit (MI,KM)	string	Required
NextStep	Next step for courier after pickup (D=drop at carrier, O=out for delivery, R=return to base)	string	Required
LockCost	Lock the costs	boolean	Required

Request Formats

application/json, text/json

Sample:

{
  "ActualPickupDate": "2024-09-21T21:37:52.5622135-07:00",
  "ActualPickupTime": "2024-09-21T21:37:52.5622135-07:00",
  "CheckInDate": "2024-09-21T21:37:52.5622135-07:00",
  "CheckInTime": "2024-09-21T21:37:52.5622135-07: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/Mnx.WebApi.Transportation.Models">
  <ActualPickupDate>2024-09-21T21:37:52.5622135-07:00</ActualPickupDate>
  <ActualPickupTime>2024-09-21T21:37:52.5622135-07:00</ActualPickupTime>
  <AttemptCount>1</AttemptCount>
  <CheckInDate>2024-09-21T21:37:52.5622135-07:00</CheckInDate>
  <CheckInTime>2024-09-21T21:37:52.5622135-07: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

Success or failure and error detail

TaskUpdateResp

Name	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/Mnx.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</TaskUpdateResp>