Notes.GetAll
Returns notes for a work order. Photocopy (WinCopy) orders return stop-level status notes from CWorkOrderStatus. Process, delivery, and court orders return process status notes mapped to the same shape. Hidden notes are excluded. Newest notes are first.
Try it in Swagger
Endpoint
- Method:
GET
- Route:
Notes/GetAll/{workOrder}
- Authentication:
Authorize
Request Schema
| Header |
Required |
Notes |
X-Api-Key |
Required when tenant is not resolved by subdomain |
Resolves the tenant/customer database. |
Authorization: Bearer {token} |
Required for authorized endpoints |
Get a token from Auth/Token or Session/Create. |
Path Parameters
| Field |
Type |
Required |
Notes |
workOrder |
string |
Yes |
Route segment. |
Query Parameters
| Field |
Type |
Required |
Notes |
pageOffset |
int |
No |
Number of notes to skip. Defaults to 0. |
pageSize |
int |
No |
Page size. Defaults to 50. Must be between 1 and 200. |
This endpoint does not accept a JSON request body.
Expected Response Schema
Status Codes
| Status |
Notes |
200 OK |
Returned by the controller for this operation. |
400 Bad Request |
Invalid paging. Returns a ProblemDetails with errorCode ValidationError. |
404 Not Found |
The work order does not exist. Returns a ProblemDetails with errorCode NotFound. |
Success Body
Response type: NoteListDto
| Field |
Type |
Notes |
total |
int |
Total visible notes for the work order. |
notes |
NoteDetailDto[] |
Current page. |
Each note:
| Field |
Type |
Notes |
lineItem |
int |
Note / status identifier. |
workOrder |
string |
Work order. |
facilityLineItem |
int? |
Stop identifier for photocopy notes; null for process notes. |
date |
DateTime? |
Note date. |
time |
string |
Note time (HH:mm). |
report |
string |
Note text. |
comment |
bool |
true when the photocopy note is an office / comment-only entry. |
contactName |
string |
Contact name when stored. |
enteredBy |
string |
Employee / user who entered the note. |
nextAction |
int? |
Next action code. |
nextActionTitle |
string |
Next action title. |
assignedTo |
string |
Assigned employee code. |
assignedToName |
string |
Assigned employee name. |
actionDate |
DateTime? |
Calendar action date. |
Response Sample
{
"total": 34,
"notes": [
{
"lineItem": 8823451,
"workOrder": "646982",
"facilityLineItem": 2646058,
"date": "2026-07-24T00:00:00",
"time": "14:32",
"report": "Spoke with records clerk, ready for pickup.",
"comment": false,
"contactName": "GINA",
"enteredBy": "NCUR",
"nextAction": 10,
"nextActionTitle": "Production Department",
"assignedTo": "NCUR",
"assignedToName": "NATHAN CURTIS",
"actionDate": "2026-07-28T00:00:00"
}
]
}