/jobnote/get
The action returns information about a job note associated to a work order.
Request
| Field | Description | Type | Required |
|---|---|---|---|
report_id | Unique identifier for the work order | number | Yes |
note_id | Unique identifier for the job note | number | Yes |
Use the /jobnote/list action to get the
note_id for a job note.
Example:
{
"report_id": 40945,
"note_id": 232
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"report_id":40945,"note_id": 232}' \
https://ppw.web/svc/jobnote/get
Response
| Field | Description | Type |
|---|---|---|
report_id | Unique identifier for the work order | number |
note_id | Unique identifier for the job note | number |
base_revision | First revision (note_id) of the job note. It will be 0 if the job note does not have multiple revisions | number |
note_type | Note type. It wo if it is a work order note and prop if it is a property note | string |
note_text | Job note body | string |
created_by | user_id of the user that created the job note. user_id is the unique identifier for a PPW user | number |
create_time | Time when the job note was created. The format is unix time | number |
sent_to_users | List of PPW users the job note was sent to. Each item in the list is a user_id | array |
sent_to_emails | List of email addresses the job note was sent to | array |
reminder_date | Job note reminder date in YYYY-MM-DD format | string |
reminder_time | Job note reminder time. See /jobnote/reminder/times | string |
group_permissions | List of user groups that have permission to view the job note. See /user/group/list | array |
The sent_to_users and sent_to_emails fields will get set in the
response when the job note was sent to more or more PPW users or email
addresses. The reminder_date and reminder_time will set in the
response only when the job note has a job note reminder.
Example successful response:
{
"report_id": 40945,
"note_id": 234,
"base_revision": 227,
"note_type": "prop",
"note_text": "Responded to a leak under the kitchen sink. Replaced worn-out washer and tightened connections. No further leaks detected. Customer advised to check periodically for any signs of moisture.",
"created_by": 45592,
"create_time": 1722363851,
"sent_to_users": [45592, 131705],
"reminder_date": "2024-07-05",
"reminder_time": "023000",
"group_permissions": [3651, 3654, 3653, 3652]
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
invalid_report_id | Unique work order identifier is invalid | 400 |
invalid_note_id | Unique job note identifier is invalid | 400 |
note_not_found | Job note not found | 404 |