Notes.Delete
Hides an existing photocopy status note. The row stays in the database and is excluded from Notes/GetAll.
Try it in Swagger
Endpoint
- Method:
DELETE
- Route:
Notes/{workOrder}/{lineItem}
- 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. |
lineItem |
int |
Yes |
Note / status identifier returned by Notes/Add. |
This endpoint does not accept a JSON request body.
Expected Response Schema
Status Codes
| Status |
Notes |
200 OK |
The note was hidden. |
404 Not Found |
The note does not exist or is already hidden. |
Success Body
Response type: NoteHiddenDto
| Field |
Type |
Notes |
lineItem |
int |
Hidden note identifier. |
hidden |
bool |
Always true on success. |
Response Sample
{
"lineItem": 8823451,
"hidden": true
}