POST api/PickupAlert/Update

Request Information

URI Parameters

None.

Body Parameters

PickupAlertUpdateParm
NameDescriptionTypeAdditional information
auth

string

None.

PickupGUID

string

None.

UpdateType

string

None.

CourierID

integer

None.

CourierServiceID

integer

None.

Weight

decimal number

None.

WeightUOM

string

None.

DistanceUOM

string

None.

WaitingTime_Actual

integer

None.

WaitingTime_Billable

integer

None.

AttemptCount_Actual

integer

None.

AttemptCount_Billable

integer

None.

SpokeWith

string

None.

AlertVia

string

None.

AlertHow

string

None.

SendData

boolean

None.

ShipmentGUID

string

None.

Distance_Actual

integer

None.

Distance_Billable

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Distance_Actual": 1,
  "Distance_Billable": 2,
  "auth": "sample string 1",
  "PickupGUID": "sample string 2",
  "UpdateType": "sample string 3",
  "CourierID": 1,
  "CourierServiceID": 1,
  "Weight": 1.0,
  "WeightUOM": "sample string 4",
  "DistanceUOM": "sample string 5",
  "WaitingTime_Actual": 1,
  "WaitingTime_Billable": 1,
  "AttemptCount_Actual": 1,
  "AttemptCount_Billable": 1,
  "SpokeWith": "sample string 6",
  "AlertVia": "sample string 7",
  "AlertHow": "sample string 8",
  "SendData": true,
  "ShipmentGUID": "sample string 10"
}

application/xml, text/xml

Sample:
<PickupAlertUpdateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AlertHow>sample string 8</AlertHow>
  <AlertVia>sample string 7</AlertVia>
  <AttemptCount_Actual>1</AttemptCount_Actual>
  <AttemptCount_Billable>1</AttemptCount_Billable>
  <CourierID>1</CourierID>
  <CourierServiceID>1</CourierServiceID>
  <DistanceUOM>sample string 5</DistanceUOM>
  <Distance_Actual>1</Distance_Actual>
  <Distance_Billable>2</Distance_Billable>
  <PickupGUID>sample string 2</PickupGUID>
  <SendData>true</SendData>
  <ShipmentGUID>sample string 10</ShipmentGUID>
  <SpokeWith>sample string 6</SpokeWith>
  <UpdateType>sample string 3</UpdateType>
  <WaitingTime_Actual>1</WaitingTime_Actual>
  <WaitingTime_Billable>1</WaitingTime_Billable>
  <Weight>1</Weight>
  <WeightUOM>sample string 4</WeightUOM>
  <auth>sample string 1</auth>
</PickupAlertUpdateParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional 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:
<ResponseBase 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>
</ResponseBase>