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

send_notes – Send Job Notes

Job Notes can now be sent back to the client by initiating the send_notes event. Note MUST be wrapped in a note object. View the Request Payload below for an example.

The details of the JSON object are described below.

Field NameDescriptionRequired
dst_report_idThe Report ID in which the note will be added toyes
noteArray of note objectsyes

Note object fields

Field NameDescriptionRequired
note_idNote ID of which we fetched the data from. Used for tracking as wellyes
note_revOnly required if a revision of a note. This is the Parent Note IDno
note_typewo = Work Order. prop = Property Noteyes
note_textText of the noteyes
insert_dateOriginal Insertion time of the noteno
org_nameOrg name from which the note originated from. Used in the UI to show Imported From: <Org Name>. Default will show user who inserted the note.no
has_attachmentsTrue or False if a note has attachments. This will in return trigger the get_file eventyes

Request payload JSON – send_notes

{

  "username": "demo",
  "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
  "event_name": "send_notes",
  "event_data": {
    "dst_report_id": "12345",
    "org_name": "Sample Org Name",
    "module_type": "job_notes",
    "note": [{
      "note_id": "67890",
      "note_rev": "56789",
      "note_type": "wo",
      "note_text": "This is a sample note text.",
      "insert_date": "2025-01-06T12:00:00Z",
      "has_attachments": true
    }]
  }
}
curl -X POST \
  --data 'payload={
    "username": "demo",
    "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
    "event_name": "send_notes",
    "event_data": "{\"dst_report_id\":\"12345\",\"org_name\":\"Sample Org Name\",\"module_type\":\"job_notes\",\"notes\":[{\"note_id\":\"67890\",\"note_rev\":\"56789\",\"note_type\":\"wo\",\"note_text\":\"This is a sample note text.\",\"insert_date\":\"2025-01-06T12:00:00Z\",\"has_attachments\":true},{\"note_id\":\"67891\",\"note_rev\":\"56790\",\"note_type\":\"wo\",\"note_text\":\"This is a second sample note for testing.\",\"insert_date\":\"2025-01-07T15:30:00Z\",\"has_attachments\":false}]}"
  }' \
  https://www.propertypreswizard.com/api/link/receiver.php

Response JSON

{
  "remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
  "success": true,
  "return_error_msg": null,
  "result_data": {
    "remote_note_id": 42
  },
  "remote_org_id": 283,
  "error": false
}
Field NameDescription
remote_note_idNewly created note id