POST api/ShipmentSMS/Update

Request Information

URI Parameters

None.

Body Parameters

ShipmentSMSUpdateParm
NameDescriptionTypeAdditional information
auth

string

None.

PhoneNumber

string

None.

NotifyPickup

boolean

None.

NotifyDelivery

boolean

None.

ShipmentSmsGUID

string

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "PhoneNumber": "sample string 2",
  "NotifyPickup": true,
  "NotifyDelivery": true,
  "ShipmentSmsGUID": "sample string 5"
}

application/xml, text/xml

Sample:
<ShipmentSMSUpdateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <NotifyDelivery>true</NotifyDelivery>
  <NotifyPickup>true</NotifyPickup>
  <PhoneNumber>sample string 2</PhoneNumber>
  <ShipmentSmsGUID>sample string 5</ShipmentSmsGUID>
  <auth>sample string 1</auth>
</ShipmentSMSUpdateParm>

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>