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_all_updates – Retreive Updates on Existing Orders

Retreiving updates to work orders is done with the get_all_updates event. A timestamp can be passed and only updates since that time will be sent. This will only send work orders that are currently in an open status for the user.

Work orders can be returned to the vendor (RTV) by setting the wo_status to RTV. The reason for the followup will be passed in the update_value field.

Fields that can be updated are as follows

  • address
  • city
  • comments
  • cust_text
  • date_due
  • key_code
  • loan_number
  • loan_type_other
  • lock_code
  • lot_size
  • mortgage_name
  • start_date
  • state
  • zip
FieldTypeDescription
timestampstringUnix timestamp

Request payload JSON

{
  "username": "demo",
  "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
  "event_name": "get_all_updates",
  "event_data": "{\"timestamp\":\"1491699142\"}"
}
curl -X POST \
  --data 'payload={
    "username": "demo",
    "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
    "event_name": "get_all_updates",
    "event_data": "{\"timestamp\":\"1491699142\"}"
  }' \
  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": [{
      "report_id": "12249320",
      "wo_number": "import test 3-1",
      "org_wo_num": "2272",
      "wo_status": "In Field",
      "update_field": "lot_size",
      "update_value": "45,000 sqft"
    },
    {
      "report_id": "12249453",
      "wo_number": "import test 3-5",
      "org_wo_num": "2298",
      "wo_status": "In Field",
      "update_field": "comments",
      "update_value": "These are new comments"
    },
    {
      "report_id": "12249320",
      "wo_number": "import test 3-1",
      "org_wo_num": "2272",
      "wo_status": "RTV",
      "update_field": "",
      "update_value": "Take better photos of exterior debris."
    }
  ]
}
Field NameType/LengthDescription
report_idnumberThe unique id of the order. Must be an integer.
wo_numberstringThe work order number displayed to the user.
org_wo_numnumberThe PPW # for the work order.
wo_statusstringWill be set to the work order status. Follow Up orders will be set to RTV
update_fieldstringField to update.
update_valuestringNew value for the field.