GET api/Note/GetNotes/{auth}/{EntityGUID}/{EntityType}/{IncludeUserNote}/{IncludeSystemGenerated}/{IncludeDeleted}

Used to provide the list of notes for the specified entity

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	The authorization GUID for this user session	string	Required
EntityGUID	The entity identifier that contains the note	string	Required
EntityType	The entity type that contains the note (S=shipment, M=manifest, P=pickup)	string	Required
IncludeUserNote	Should user generated notes be included in returned result set (true)	boolean	Required
IncludeSystemGenerated	Should system generated notes be included in returned result set	boolean	Required
IncludeDeleted	Should deleted notes be included in returned result set	boolean	Required

Body Parameters

None.

Response Information

Resource Description

List of Notes for the specified entity

Collection of NoteItem

Name	Type	Additional information
NoteGUID	string	None.
Note	string	None.
VisibleToCustomers	boolean	None.
IsBillingNote	boolean	None.
IsSystemGenerated	boolean	None.
EmailVisible	boolean	None.
EmailAddress	string	None.
InsertUserID	integer	None.
InsertUserName	string	None.
InsertDateTime	date	None.
InsertDateTimeUser	date	None.
DeletedUserGUID	string	None.
DeletedUserName	string	None.
DeletedDateTime	date	None.
DeletedToolTip	string	None.
NoteColor	string	None.
CanDelete	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "NoteGUID": "sample string 1",
    "Note": "sample string 2",
    "VisibleToCustomers": true,
    "IsBillingNote": true,
    "IsSystemGenerated": true,
    "EmailVisible": true,
    "EmailAddress": "sample string 6",
    "InsertUserID": 7,
    "InsertUserName": "sample string 8",
    "InsertDateTime": "2024-09-27T19:52:05.5642213-07:00",
    "InsertDateTimeUser": "2024-09-27T19:52:05.5642213-07:00",
    "DeletedUserGUID": "sample string 11",
    "DeletedUserName": "sample string 12",
    "DeletedDateTime": "2024-09-27T19:52:05.5642213-07:00",
    "DeletedToolTip": "sample string 13",
    "NoteColor": "Red",
    "CanDelete": true
  },
  {
    "NoteGUID": "sample string 1",
    "Note": "sample string 2",
    "VisibleToCustomers": true,
    "IsBillingNote": true,
    "IsSystemGenerated": true,
    "EmailVisible": true,
    "EmailAddress": "sample string 6",
    "InsertUserID": 7,
    "InsertUserName": "sample string 8",
    "InsertDateTime": "2024-09-27T19:52:05.5642213-07:00",
    "InsertDateTimeUser": "2024-09-27T19:52:05.5642213-07:00",
    "DeletedUserGUID": "sample string 11",
    "DeletedUserName": "sample string 12",
    "DeletedDateTime": "2024-09-27T19:52:05.5642213-07:00",
    "DeletedToolTip": "sample string 13",
    "NoteColor": "Red",
    "CanDelete": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfNoteItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <NoteItem>
    <CanDelete>true</CanDelete>
    <DeletedDateTime>2024-09-27T19:52:05.5642213-07:00</DeletedDateTime>
    <DeletedToolTip>sample string 13</DeletedToolTip>
    <DeletedUserGUID>sample string 11</DeletedUserGUID>
    <DeletedUserName>sample string 12</DeletedUserName>
    <EmailAddress>sample string 6</EmailAddress>
    <InsertDateTime>2024-09-27T19:52:05.5642213-07:00</InsertDateTime>
    <InsertDateTimeUser>2024-09-27T19:52:05.5642213-07:00</InsertDateTimeUser>
    <InsertUserID>7</InsertUserID>
    <InsertUserName>sample string 8</InsertUserName>
    <IsBillingNote>true</IsBillingNote>
    <IsSystemGenerated>true</IsSystemGenerated>
    <Note>sample string 2</Note>
    <NoteGUID>sample string 1</NoteGUID>
    <VisibleToCustomers>true</VisibleToCustomers>
  </NoteItem>
  <NoteItem>
    <CanDelete>true</CanDelete>
    <DeletedDateTime>2024-09-27T19:52:05.5642213-07:00</DeletedDateTime>
    <DeletedToolTip>sample string 13</DeletedToolTip>
    <DeletedUserGUID>sample string 11</DeletedUserGUID>
    <DeletedUserName>sample string 12</DeletedUserName>
    <EmailAddress>sample string 6</EmailAddress>
    <InsertDateTime>2024-09-27T19:52:05.5642213-07:00</InsertDateTime>
    <InsertDateTimeUser>2024-09-27T19:52:05.5642213-07:00</InsertDateTimeUser>
    <InsertUserID>7</InsertUserID>
    <InsertUserName>sample string 8</InsertUserName>
    <IsBillingNote>true</IsBillingNote>
    <IsSystemGenerated>true</IsSystemGenerated>
    <Note>sample string 2</Note>
    <NoteGUID>sample string 1</NoteGUID>
    <VisibleToCustomers>true</VisibleToCustomers>
  </NoteItem>
</ArrayOfNoteItem>