POST api/Note/Update

Request Information

URI Parameters

None.

Body Parameters

UpdateNoteParm
NameDescriptionTypeAdditional information
auth

string

None.

ShipmentNoteID

integer

None.

VisibleToCustomers

boolean

None.

IsBillingNote

boolean

None.

IsCritical

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "ShipmentNoteID": 2,
  "VisibleToCustomers": true,
  "IsBillingNote": true,
  "IsCritical": true
}

application/xml, text/xml

Sample:
<UpdateNoteParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <IsBillingNote>true</IsBillingNote>
  <IsCritical>true</IsCritical>
  <ShipmentNoteID>2</ShipmentNoteID>
  <VisibleToCustomers>true</VisibleToCustomers>
  <auth>sample string 1</auth>
</UpdateNoteParm>

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>