GET api/Customer/{customerDID}/Note
Gets a list of notes for the specified Customer
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerDID |
The Customer's DID |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of CustomerNoteViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ID |
Unique ID for the note record |
integer |
None. |
| CustomerDID |
The Customer's DID |
string |
None. |
| CustomerNoteCategoryID |
The Customer Note Category ID |
integer |
Required |
| CorrespondenceTypeID |
The Correspondence Type ID |
integer |
Required |
| Subject |
The Subject or Title of the Note |
string |
None. |
| Message |
Full Description and Content of the Note |
string |
None. |
| OrderID |
Order ID the note is associated with, if applicable. |
integer |
None. |
| Unresolved |
Is the note unresolved |
boolean |
Required |
| IsCritical |
Is the note critical |
boolean |
Required |
| DateCreated | date |
None. |
|
| CreatedBy | string |
None. |
|
| DateLastModified | date |
None. |
|
| LastModifiedBy | string |
None. |
Response Formats
application/xml, text/xml
Sample:
<ListOfCustomerNoteViewModel>
<CustomerNoteViewModel>
<ID>1</ID>
<CustomerDID>sample string 1</CustomerDID>
<CustomerNoteCategoryID>2</CustomerNoteCategoryID>
<CorrespondenceTypeID>3</CorrespondenceTypeID>
<Subject>sample string 4</Subject>
<Message>sample string 5</Message>
<OrderID>1</OrderID>
<Unresolved>True</Unresolved>
<IsCritical>True</IsCritical>
<DateCreated>10/28/2025 17:40:26</DateCreated>
<CreatedBy>sample string 9</CreatedBy>
<DateLastModified>10/28/2025 17:40:26</DateLastModified>
<LastModifiedBy>sample string 10</LastModifiedBy>
</CustomerNoteViewModel>
<CustomerNoteViewModel>
<ID>1</ID>
<CustomerDID>sample string 1</CustomerDID>
<CustomerNoteCategoryID>2</CustomerNoteCategoryID>
<CorrespondenceTypeID>3</CorrespondenceTypeID>
<Subject>sample string 4</Subject>
<Message>sample string 5</Message>
<OrderID>1</OrderID>
<Unresolved>True</Unresolved>
<IsCritical>True</IsCritical>
<DateCreated>10/28/2025 17:40:26</DateCreated>
<CreatedBy>sample string 9</CreatedBy>
<DateLastModified>10/28/2025 17:40:26</DateLastModified>
<LastModifiedBy>sample string 10</LastModifiedBy>
</CustomerNoteViewModel>
</ListOfCustomerNoteViewModel>
application/json, text/json
Sample:
[
{
"ID": 1,
"CustomerDID": "sample string 1",
"CustomerNoteCategoryID": 2,
"CorrespondenceTypeID": 3,
"Subject": "sample string 4",
"Message": "sample string 5",
"OrderID": 1,
"Unresolved": true,
"IsCritical": true,
"DateCreated": "2025-10-28T17:40:26.2464494-04:00",
"CreatedBy": "sample string 9",
"DateLastModified": "2025-10-28T17:40:26.2464494-04:00",
"LastModifiedBy": "sample string 10"
},
{
"ID": 1,
"CustomerDID": "sample string 1",
"CustomerNoteCategoryID": 2,
"CorrespondenceTypeID": 3,
"Subject": "sample string 4",
"Message": "sample string 5",
"OrderID": 1,
"Unresolved": true,
"IsCritical": true,
"DateCreated": "2025-10-28T17:40:26.2464494-04:00",
"CreatedBy": "sample string 9",
"DateLastModified": "2025-10-28T17:40:26.2464494-04:00",
"LastModifiedBy": "sample string 10"
}
]