Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

get_notes – Get Job Notes

Job notes can be sent via PPWLink by initiating the get_notes event. This event takes 2 inputs: A report_id and a remote_report_id. The report_id is the PPW work order from which you want to fetch the job notes from. The remote_report_id is the PPW work order to which you want the job notes to be posted. The types of these notes can be “wo” for work order note or “prop” for property notes.

For this event to fire, the Job Notes Import needs to be active. This can be done in the Auto Import. When active there needs to be at least one note group set. The groups selected here will be given permission to view the notes created by this import.

FieldTypeDescriptionRequired
remote_report_id numberReport_id of which the note will be added/inserted intoNo
report_idnumberReport_id of which the note originated fromYes

Request payload JSON

{
  "username": "demo",
  "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
  "event_name": "get_notes",
  "event_data": "{\"remote_report_id\":\"154687\",\"report_id\":\"122367\"}"
}
curl -X POST \
  --data 'payload={
    "username": "demo",
    "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
    "event_name": "get_notes",
    "event_data": "{\"remote_report_id\":\"154687\",\"report_id\":\"122367\"}"
  }' \
  https://www.propertypreswizard.com/api/link/receiver.php

Response JSON

{
  "remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
  "error": false,
  "success": true,
  "return_error_msg": null,
  "result_data": [{
      "note_id": 1843,
      "note_rev": 0,
      "report_id": 45321,
      "remote_report_id": 154687,
      "note_type": "wo",
      "note_text": "Some Note Text",
      "insert_by": "USER_ID Of User who created the note",
      "insert_date": "2024-09-19 12:07:03",
      "org_name": "PPW Organization",
      "has_attachments": "True"
    },
    {
      "note_id": 1844,
      "note_rev": 1843,
      "report_id": 45321,
      "remote_report_id": 154687,
      "note_type": "wo",
      "note_text": "Some Note Text. Edited",
      "insert_by": 131667,
      "insert_date": "2024-09-19 12:08:03",
      "org_name": "PPW Organization",
      "has_attachments": "True"
    }

  ]
}
Field NameDescription
note_idNote_id of which we fetched the data from.
note_revOriginal note_id from which this edit stemmed from.
report_id Report_id in which the note was originally created.
remote_report_idReport_id in which we will be adding the note to.
note_type Type of note. "wo" = Work Order, "prop" = Property.
note_text Text from the note.
insert_by User ID of the user who added the note.
insert_date Original date the note was created.
org_name Org name from which the note originated from. Used in the UI to show Imported From: <Org Name>.
has_attachments True or False based of if the note has any attachments. If True will fire off the get_file event