GET api/workordernotes/{id}
Get a work order note by the id
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
(Required) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
WorkOrderNote| Name | Description | Type | Additional information |
|---|---|---|---|
| WorkorderNotesId |
Work Order Notes Id. Primary key of work orders notes table |
integer |
None. |
| WorkorderId |
Work Order Id. See the GET api/workorders/{id} route to get the work order data. |
integer |
None. |
| UserId |
User Id. See the GET api/users/{id} route to get the user data. |
integer |
None. |
| WorkorderNotesDate |
Work Order Notes Date. |
date |
None. |
| WorkorderNotes |
Work Order Notes. |
string |
None. |
| WorkorderNotesType |
If set to N belongs to the Notes section. If set to A to the Additional Notes and Actions section. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"WorkorderNotesId": 1,
"WorkorderId": 1,
"UserId": 1,
"WorkorderNotesDate": "2025-12-24T05:23:53.6723791-05:00",
"WorkorderNotes": "sample string 2",
"WorkorderNotesType": "sample string 3"
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)