get_all_notes
– Get All Job Notes
New job notes can be sent to PPW by initiating the get_all_notes
event. See Sending New Orders for information on this.
An array of objects containing the job notes can be sent at once. These notes will be created in PPW and an acknowledgement will be sent back if a transaction_id
was sent. Job notes can be work order or property notes. The distinction in PPW is a property note will show for all orders at the same property. A work order note will only show for the specific work order it was associated with. Multiple job notes to multiple orders can all be sent at the same time.
Request payload JSON - get_all_notes
{
"username": "demo",
"password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
"site_id": "dcc363d0-8ed1-48a2ba2e-f638275db4f",
"event_name": "get_all_notes",
"event_data": "{\"timestamp\":\"1491699142\"}"
}
curl -X POST \
--data 'payload={
"username": "demo",
"password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
"site_id": "dcc363d0-8ed1-48a2ba2e-f638275db4f",
"event_name": "get_all_notes",
"event_data": "{\"timestamp\":\"1491699142\"}"
}' \
https://www.propertypreswizard.com/api/link/receiver.php
Response JSON - get_all_notes
{
"remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
"error": false,
"success": true,
"return_error_msg": null,
"result_data": [{
"wo_number": "12113528",
"note_id": "rhudf-5196-dfsdf-095mwf",
"note_type": "wo",
"note_text": "Test Note. 1",
"note_from": "XFS",
"transaction_id": "sd1sdf-1624-dfsdf-435fgdf"
},
{
"wo_number": "12113528",
"note_id": "sds1df-5196-dfsdf-435fgdf",
"note_type": "wo",
"note_text": "Test Note. 2",
"note_from": "XFS",
"transaction_id": "sd2sdf-5656-dfsdf-435fgdf"
}
]
}
Field Name | Type/Length | Description |
---|---|---|
wo_number | string | The work order number sent previously. Must exist in PPW account. |
note_id | string | Unique note_id from integrator. Checked for dupes by PPW. |
note_type | string | Can be wo or prop. |
note_text | string | Text of the note. |
note_from | string | Who the note will display as being from. |
transaction_id | string | Transaction ID from integrator. Must be unique. |