POST api/PickupAlert

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth		string	None.
PickupGUID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "PickupGUID": "sample string 2"
}

application/xml, text/xml

Sample:

<PickupAlertParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <PickupGUID>sample string 2</PickupGUID>
  <auth>sample string 1</auth>
</PickupAlertParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PickupAlertResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
CourierID	integer	None.
CourierKey	string	None.
CourierName	string	None.
CourierPhoneNumber	string	None.
CourierServiceID	integer	None.
AlertStatus	integer	None.
AlertVia	string	None.
AlertHow	string	None.
AlertUserID	integer	None.
AlertUserName	string	None.
SpokeWith	string	None.
SentDateTime	date	None.
AcceptedDateTime	date	None.
Weight	decimal number	None.
WeightUOM	string	None.
WaitingTime_Actual	integer	None.
WaitingTime_Billable	integer	None.
AttemptCount_Actual	integer	None.
AttemptCount_Billable	integer	None.
Distance_Actual	integer	None.
Distance_Billable	integer	None.
DistanceUOM	string	None.
TSANotice	string	None.
ButtonVisibleResend	boolean	None.
ButtonVisibleSendAlert	boolean	None.
ButtonVisibleSendAndConfirm	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "CourierID": 1,
  "CourierKey": "sample string 3",
  "CourierName": "sample string 4",
  "CourierPhoneNumber": "sample string 5",
  "CourierServiceID": 1,
  "AlertStatus": 6,
  "AlertVia": "sample string 7",
  "AlertHow": "sample string 8",
  "AlertUserID": 1,
  "AlertUserName": "sample string 9",
  "SpokeWith": "sample string 10",
  "SentDateTime": "2024-09-19T09:06:29.8404197+00:00",
  "AcceptedDateTime": "2024-09-19T09:06:29.8404197+00:00",
  "Weight": 1.0,
  "WeightUOM": "sample string 11",
  "WaitingTime_Actual": 1,
  "WaitingTime_Billable": 1,
  "AttemptCount_Actual": 1,
  "AttemptCount_Billable": 1,
  "Distance_Actual": 12,
  "Distance_Billable": 13,
  "DistanceUOM": "sample string 14",
  "TSANotice": "sample string 15",
  "ButtonVisibleResend": true,
  "ButtonVisibleSendAlert": true,
  "ButtonVisibleSendAndConfirm": true
}

application/xml, text/xml

Sample:

<PickupAlertResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AcceptedDateTime>2024-09-19T09:06:29.8404197+00:00</AcceptedDateTime>
  <AlertHow>sample string 8</AlertHow>
  <AlertStatus>6</AlertStatus>
  <AlertUserID>1</AlertUserID>
  <AlertUserName>sample string 9</AlertUserName>
  <AlertVia>sample string 7</AlertVia>
  <AttemptCount_Actual>1</AttemptCount_Actual>
  <AttemptCount_Billable>1</AttemptCount_Billable>
  <ButtonVisibleResend>true</ButtonVisibleResend>
  <ButtonVisibleSendAlert>true</ButtonVisibleSendAlert>
  <ButtonVisibleSendAndConfirm>true</ButtonVisibleSendAndConfirm>
  <CourierID>1</CourierID>
  <CourierKey>sample string 3</CourierKey>
  <CourierName>sample string 4</CourierName>
  <CourierPhoneNumber>sample string 5</CourierPhoneNumber>
  <CourierServiceID>1</CourierServiceID>
  <DistanceUOM>sample string 14</DistanceUOM>
  <Distance_Actual>12</Distance_Actual>
  <Distance_Billable>13</Distance_Billable>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <SentDateTime>2024-09-19T09:06:29.8404197+00:00</SentDateTime>
  <SpokeWith>sample string 10</SpokeWith>
  <TSANotice>sample string 15</TSANotice>
  <WaitingTime_Actual>1</WaitingTime_Actual>
  <WaitingTime_Billable>1</WaitingTime_Billable>
  <Weight>1</Weight>
  <WeightUOM>sample string 11</WeightUOM>
</PickupAlertResp>