/jobnote/list
This action returns a list job notes associated with a work order.
Request
| Field | Description | Type | Required |
|---|---|---|---|
report_id | Unique identifier for the work order | number | Yes |
Example:
{
"report_id": 40945
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"report_id": 40945}' \
https://ppw.web/svc/jobnote/list
Response
| Field | Description | Type |
|---|---|---|
report_id | Unique identifier for the work order | number |
wo_notes | List of work order notes | array |
prop_notes | List of property notes | array |
Each item in the wo_notes and prop_notes array is a JSON object
with the following fields:
| Field | Description | Type |
|---|---|---|
report_id | Unique identifier for the work order | number |
note_id | Unique identifier for the job note | number |
revisions | List of job note revisions. Each item in this list is a note_id. | array |
base_revision | First revision (note_id) of the job note. | number |
The revisions and base_revision fields will be set in the above
JSON object only when the job note has multiple revisions.
Example successful response:
{
"report_id": 40945,
"wo_notes": [{
"note_id": 232,
"revisions": [224, 225, 229, 232],
"base_revision": 224
}, {
"note_id": 233,
"revisions": [226, 228, 233],
"base_revision": 226
}, {
"note_id": 236
}],
"prop_notes": [{
"note_id": 234,
"revisions": [227, 234],
"base_revision": 227
}, {
"note_id": 235,
"revisions": [230, 231, 235],
"base_revision": 230
}]
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
invalid_report_id | Unique work order identifier is invalid | 400 |