POST api/Note

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
EntityGUID	string	None.
EntityType	string	None.
IncludeUserNote	boolean	None.
IncludeSystemGenerated	boolean	None.
IncludeDeleted	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "EntityGUID": "sample string 2",
  "EntityType": "sample string 3",
  "IncludeUserNote": true,
  "IncludeSystemGenerated": true,
  "IncludeDeleted": true
}

application/xml, text/xml

Sample:

<NoteSearchParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <EntityGUID>sample string 2</EntityGUID>
  <EntityType>sample string 3</EntityType>
  <IncludeDeleted>true</IncludeDeleted>
  <IncludeSystemGenerated>true</IncludeSystemGenerated>
  <IncludeUserNote>true</IncludeUserNote>
  <auth>sample string 1</auth>
</NoteSearchParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NoteSearchResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
Notes	Collection of NoteItem	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Notes": null
}

application/xml, text/xml

Sample:

<NoteSearchResp 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>
  <Notes i:nil="true" />
</NoteSearchResp>