Notes.Edit

Updates an existing photocopy status note without creating a new record. The original note date, time, and stop are preserved.

Try it in Swagger

Endpoint

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 or Session/Create.

Path Parameters

Field Type Required Notes
workOrder string Yes Route segment.
lineItem int Yes Note / status identifier returned by Notes/Add.

JSON Body

Body type: NoteRequestDto

Editable fields use the same names as Notes.Add. date and time in the body are ignored. If facilityLineItem is sent, it must match the existing stop.

Field Type Required Notes
report string Yes Replacement note text.
comment bool No Alias for isOfficeNote.
contactName string No When sent, replaces the stored contact name.
nextAction int No Alias for actionCode. Supplying any assignment field rebuilds Action Person.
assignedTo string No Alias for actionEmployee.
actionDate DateTime No Calendar next action date.

Request Sample

{
  "workOrder": "646982",
  "facilityLineItem": 2646058,
  "date": "2026-07-24",
  "time": "14:32",
  "report": "Spoke with records clerk, ready for pickup.",
  "comment": false,
  "contactName": "GINA",
  "nextAction": 10,
  "assignedTo": "NCUR",
  "actionDate": "2026-07-28"
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request Invalid assignment values or a facilityLineItem that does not match the note.
404 Not Found The note does not exist or is hidden.

Success Body

Response type: NoteDetailDto

Response Sample

{
  "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"
}