GET api/Operations/SelectTaskInRouteToPickup/{auth}/{EntityGUID}/{EntityType}

Request Information

URI Parameters

Name	Type	Additional information
auth	string	Required
EntityGUID	string	Required
EntityType	string	Required

Body Parameters

None.

Response Information

Resource Description

TaskInRouteToPickupResp

Name	Type	Additional information
PickupGUID	string	None.
PickupNumber	integer	None.
CompanyID	integer	None.
OfficeID	integer	None.
DispatchOfficeID	integer	None.
State	string	None.
Status	integer	None.
OrderByName	string	None.
OrderByPhone	string	None.
OrderByFax	string	None.
OrderByEmail	string	None.
CustomerID	integer	None.
AddressID	integer	None.
AddressCode	string	None.
CompanyName	string	None.
Address1	string	None.
Address2	string	None.
Address3	string	None.
CityName	string	None.
StateProvID	string	None.
PostalCode	string	None.
CountryID	string	None.
TimezoneID	string	None.
PhoneNumber	string	None.
AfterHoursNumber	string	None.
FaxNumber	string	None.
EmailAddress	string	None.
PersonToSee	string	None.
ReadyDateTime	date	None.
CloseDateTime	date	None.
SchedPickupDateTime	date	None.
UpdatedPickupDateTime	date	None.
ActualPickupArrival	date	None.
ActualPickupDepart	date	None.
AirportID	string	None.
Instructions	string	None.
InsertUserID	integer	None.
InsertDateTime	date	None.
CourierID	integer	None.
CourierKey	string	None.
CourierName	string	None.
CourierPhoneNumber	string	None.
CourierEmailAddress	string	None.
CourierServiceID	integer	None.
AlertStatus	integer	None.
AlertVia	string	None.
AlertHow	string	None.
AlertUserID	integer	None.
SpokeWith	string	None.
SentDateTime	date	None.
AcceptedDateTime	date	None.
WaitingTime	integer	None.
AttemptCount	integer	None.
Distance	integer	None.
Weight	decimal number	None.
DistanceUOM	string	None.
WeightUOM	string	None.
TSANotice	string	None.
LockCost	boolean	None.
OrderInstructions	string	None.
IsSuccessful	boolean	None.
ErrorMessage	string	None.

Response Formats

application/json, text/json

Sample:

{
  "PickupGUID": "sample string 1",
  "PickupNumber": 2,
  "CompanyID": 3,
  "OfficeID": 4,
  "DispatchOfficeID": 1,
  "State": "sample string 5",
  "Status": 6,
  "OrderByName": "sample string 7",
  "OrderByPhone": "sample string 8",
  "OrderByFax": "sample string 9",
  "OrderByEmail": "sample string 10",
  "CustomerID": 11,
  "AddressID": 1,
  "AddressCode": "sample string 12",
  "CompanyName": "sample string 13",
  "Address1": "sample string 14",
  "Address2": "sample string 15",
  "Address3": "sample string 16",
  "CityName": "sample string 17",
  "StateProvID": "sample string 18",
  "PostalCode": "sample string 19",
  "CountryID": "sample string 20",
  "TimezoneID": "sample string 21",
  "PhoneNumber": "sample string 22",
  "AfterHoursNumber": "sample string 23",
  "FaxNumber": "sample string 24",
  "EmailAddress": "sample string 25",
  "PersonToSee": "sample string 26",
  "ReadyDateTime": "2024-09-19T09:19:32.606675+00:00",
  "CloseDateTime": "2024-09-19T09:19:32.606675+00:00",
  "SchedPickupDateTime": "2024-09-19T09:19:32.606675+00:00",
  "UpdatedPickupDateTime": "2024-09-19T09:19:32.606675+00:00",
  "ActualPickupArrival": "2024-09-19T09:19:32.606675+00:00",
  "ActualPickupDepart": "2024-09-19T09:19:32.606675+00:00",
  "AirportID": "sample string 29",
  "Instructions": "sample string 30",
  "InsertUserID": 31,
  "InsertDateTime": "2024-09-19T09:19:32.606675+00:00",
  "CourierID": 1,
  "CourierKey": "sample string 33",
  "CourierName": "sample string 34",
  "CourierPhoneNumber": "sample string 35",
  "CourierEmailAddress": "sample string 36",
  "CourierServiceID": 1,
  "AlertStatus": 37,
  "AlertVia": "sample string 38",
  "AlertHow": "sample string 39",
  "AlertUserID": 1,
  "SpokeWith": "sample string 40",
  "SentDateTime": "2024-09-19T09:19:32.606675+00:00",
  "AcceptedDateTime": "2024-09-19T09:19:32.606675+00:00",
  "WaitingTime": 1,
  "AttemptCount": 1,
  "Distance": 41,
  "Weight": 42.0,
  "DistanceUOM": "sample string 43",
  "WeightUOM": "sample string 44",
  "TSANotice": "sample string 45",
  "LockCost": true,
  "OrderInstructions": "sample string 47",
  "IsSuccessful": true,
  "ErrorMessage": "sample string 49"
}

application/xml, text/xml

Sample:

<TaskInRouteToPickupResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 49</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <AcceptedDateTime>2024-09-19T09:19:32.606675+00:00</AcceptedDateTime>
  <ActualPickupArrival>2024-09-19T09:19:32.606675+00:00</ActualPickupArrival>
  <ActualPickupDepart>2024-09-19T09:19:32.606675+00:00</ActualPickupDepart>
  <Address1>sample string 14</Address1>
  <Address2>sample string 15</Address2>
  <Address3>sample string 16</Address3>
  <AddressCode>sample string 12</AddressCode>
  <AddressID>1</AddressID>
  <AfterHoursNumber>sample string 23</AfterHoursNumber>
  <AirportID>sample string 29</AirportID>
  <AlertHow>sample string 39</AlertHow>
  <AlertStatus>37</AlertStatus>
  <AlertUserID>1</AlertUserID>
  <AlertVia>sample string 38</AlertVia>
  <AttemptCount>1</AttemptCount>
  <CityName>sample string 17</CityName>
  <CloseDateTime>2024-09-19T09:19:32.606675+00:00</CloseDateTime>
  <CompanyID>3</CompanyID>
  <CompanyName>sample string 13</CompanyName>
  <CountryID>sample string 20</CountryID>
  <CourierEmailAddress>sample string 36</CourierEmailAddress>
  <CourierID>1</CourierID>
  <CourierKey>sample string 33</CourierKey>
  <CourierName>sample string 34</CourierName>
  <CourierPhoneNumber>sample string 35</CourierPhoneNumber>
  <CourierServiceID>1</CourierServiceID>
  <CustomerID>11</CustomerID>
  <DispatchOfficeID>1</DispatchOfficeID>
  <Distance>41</Distance>
  <DistanceUOM>sample string 43</DistanceUOM>
  <EmailAddress>sample string 25</EmailAddress>
  <FaxNumber>sample string 24</FaxNumber>
  <InsertDateTime>2024-09-19T09:19:32.606675+00:00</InsertDateTime>
  <InsertUserID>31</InsertUserID>
  <Instructions>sample string 30</Instructions>
  <LockCost>true</LockCost>
  <OfficeID>4</OfficeID>
  <OrderByEmail>sample string 10</OrderByEmail>
  <OrderByFax>sample string 9</OrderByFax>
  <OrderByName>sample string 7</OrderByName>
  <OrderByPhone>sample string 8</OrderByPhone>
  <OrderInstructions>sample string 47</OrderInstructions>
  <PersonToSee>sample string 26</PersonToSee>
  <PhoneNumber>sample string 22</PhoneNumber>
  <PickupGUID>sample string 1</PickupGUID>
  <PickupNumber>2</PickupNumber>
  <PostalCode>sample string 19</PostalCode>
  <ReadyDateTime>2024-09-19T09:19:32.606675+00:00</ReadyDateTime>
  <SchedPickupDateTime>2024-09-19T09:19:32.606675+00:00</SchedPickupDateTime>
  <SentDateTime>2024-09-19T09:19:32.606675+00:00</SentDateTime>
  <SpokeWith>sample string 40</SpokeWith>
  <State>sample string 5</State>
  <StateProvID>sample string 18</StateProvID>
  <Status>6</Status>
  <TSANotice>sample string 45</TSANotice>
  <TimezoneID>sample string 21</TimezoneID>
  <UpdatedPickupDateTime>2024-09-19T09:19:32.606675+00:00</UpdatedPickupDateTime>
  <WaitingTime>1</WaitingTime>
  <Weight>42</Weight>
  <WeightUOM>sample string 44</WeightUOM>
</TaskInRouteToPickupResp>