WorkPerformed.GetByStop
Returns work-performed records for a specific photocopy stop. Hidden records are excluded. Newest records are first.
Endpoint
- Method:
GET - Route:
WorkPerformed/{workOrder}/{facilityLineItem} - Authentication:
Authorize
Request Schema
Headers
| 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, Session/Create, or Employee/SignIn. |
Route Parameters
| Field | Type | Required | Notes |
|---|---|---|---|
workOrder |
string |
Yes | Photocopy work order. |
facilityLineItem |
int |
Yes | Stop identifier (CWorkOrderFacility.LineItem). |
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. An empty items array is returned when the stop exists but has no visible work-performed records. |
400 Bad Request |
Missing work order or invalid facility line item. Returns a ProblemDetails with errorCode ValidationError. |
404 Not Found |
The work order or stop does not exist. Returns a ProblemDetails with errorCode NotFound. |
503 Service Unavailable |
The tenant database does not have CWorkOrderWorkPerformed, or the API SQL login cannot SELECT/INSERT it. Other API endpoints are unaffected. Returns a ProblemDetails with errorCode WorkPerformedNotEnabled. |
Success Body
Response type: WorkPerformedListDto
| Field | Type | Notes |
|---|---|---|
items |
WorkPerformedDto[] |
Work-performed rows for the stop, newest first. |
id |
int |
Work-performed identifier (CWorkOrderWorkPerformed.LineItem). |
itemCode |
int |
Billing item code when itemTitle matches BillingItem.Title. |
itemTitle |
string |
Work item stored on the record. |
units |
decimal |
Units completed. |
performedBy |
string |
Employee code that recorded the work. |
performedDate |
DateTime |
Date the work was performed. |
note |
string |
Optional comment. Empty string when none was stored. |
Response Sample
{
"items": [
{
"id": 1182,
"itemCode": 41,
"itemTitle": "bookmark",
"units": 47,
"performedBy": "NCUR",
"performedDate": "2026-07-24T00:00:00",
"note": ""
}
]
}
Error Body
Validation, not-found, and missing-table failures return a standard ProblemDetails with the failure message in detail and a machine-readable errorCode:
{
"title": "Resource not found.",
"status": 404,
"detail": "Work order or stop not found.",
"errorCode": "NotFound"
}
{
"title": "Work performed is not available.",
"status": 503,
"detail": "Work performed is not enabled for this tenant. The CWorkOrderWorkPerformed table has not been created.",
"errorCode": "WorkPerformedNotEnabled"
}