Notes.Add (Status)

Adds a note / status entry. "Notes" and "Status" are the same concept in Tristar: process orders store process status notes, while photocopy (WinCopy) orders store status reports. The path used is determined by workOrderType, or by supplying facilityLineItem for a stop-level photocopy note.

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.

JSON Body

Body type: NoteRequestDto

These fields apply to all note types:

Field Type Required Max Length Notes
workOrder string Yes Process notes: the work order. Photocopy notes: the work order, or {workOrder}-{facilityId} such as C123456-01 when facilityLineItem is omitted.
workOrderType string No Send photocopy (or an alias) to use the photocopy status path. Other values use the standard process status note path. Omitting this and sending facilityLineItem also uses the photocopy path.
noteDate DateTime No Combined note / status report date and time. Used when date / time are omitted.
date DateTime No Date portion only (for example 2026-07-24). Combined with time when either is supplied.
time string No Time portion only (for example 14:32). Combined with date when either is supplied.
report string Yes The note / status report text.

The note is attributed to the authenticated user (the caller's contact code is written to EnteredBy for photocopy notes and to CurrentUser/TristarUser for standard process status notes).

Type / Enum Values

Field Allowed Values Notes
workOrderType photocopy, photo_copy, copy, x Writes a photocopy facility status note to CWorkOrderStatus.

Photocopy Status Fields

The fields below are only used when workOrderType is a photocopy alias (photocopy, photo_copy, copy, x) or when facilityLineItem is supplied. They map to the WinCopy Status Report screen and are persisted to CWorkOrderStatus. They are ignored on the process status path.

Target a stop with facilityLineItem, or keep the existing {workOrder}-{facilityId} form (for example C123456-01) when facilityLineItem is omitted.

Field Type Required Max Length Notes
facilityLineItem int No Stop / facility line item. When set, the photocopy path is used and the facility is resolved by work order + line item.
isOfficeNote bool No true saves an internal office note (Comment = 1); false (default) saves a public, client-visible note (Comment = 0).
comment bool No Alias for isOfficeNote. When set, takes precedence.
actionDate DateTime No Calendar next action date (ActionDate). Used only when updating next action (see guard below).
actionCode int No Calendar next action code. Get options from NextAction/GetAll.
nextAction int No Alias for actionCode. Used when actionCode is omitted.
actionEmployee string No Assigned employee code / SERVER.CODE. Get options from Employee/GetAll.
assignedTo string No Alias for actionEmployee. Used when actionEmployee is omitted.
milestone int No Milestone code. Get options from WinCopyMilestone/GetAll. Defaults to 1 when omitted.
contactName string No Contact name (ContactName).
markedForReport bool No Flags the status report as marked for report.

Next action / Action Person guard: WinCopy Action Person comes from ActionDateIndex. The API rebuilds that index only when at least one of actionDate, actionCode, nextAction, actionEmployee, or assignedTo is supplied. In that case actionDate falls back to the resolved note date if omitted. If none of those fields are supplied, the note is saved without an action date and the current Action Person is left unchanged. Omit next-action fields on heartbeat/submit notes so they do not overwrite a real workflow assignment.

Stop Note 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"
}

Photocopy Request Sample

{
  "workOrder": "C123456-01",
  "workOrderType": "photocopy",
  "noteDate": "2026-05-07T00:00:00",
  "report": "Client called for status.",
  "isOfficeNote": false,
  "actionDate": "2026-05-14T00:00:00",
  "actionCode": 12,
  "actionEmployee": "AS",
  "milestone": 3,
  "contactName": "Jane Smith",
  "markedForReport": true
}

Process Note Request Sample

{
  "workOrder": "336980",
  "noteDate": "2026-05-07T00:00:00",
  "report": "Client called for status."
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request The photocopy workOrder is not in the required {workOrder}-{facilityId} format and facilityLineItem was not supplied, or time is invalid. Returns a ProblemDetails with errorCode ValidationError.
404 Not Found The photocopy facility / stop resolved from workOrder or facilityLineItem does not exist. Returns a ProblemDetails with errorCode NotFound.

Success Body

Response type: NoteCreatedDto

Field Type Notes
lineItem int Created note / status identifier.
workOrder string Work order stored on the note.
facilityLineItem int? Stop / facility line item for photocopy notes; omitted or null for process and investigation notes.

Response Sample

{
  "lineItem": 8823451,
  "workOrder": "646982",
  "facilityLineItem": 2646058
}

Error Body

Validation and not-found failures return a standard ProblemDetails with the failure message in detail and a machine-readable errorCode:

{
  "title": "Validation failed.",
  "status": 400,
  "detail": "Photocopy notes require workOrder in the format '{workOrder}-{facilityId}' or a facilityLineItem.",
  "errorCode": "ValidationError"
}