get_order – Get Work Order

The work order info, line items and PCR forms are sent using this event.

Request payload JSON

{
  "username": "demo",
  "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
  "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
  "event_name": "get_order",
  "event_data": "{\"report_id\":\"12249320\"}"
}

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

The response will contain an array of objects for each work order. The result data will have the PPW internal Report ID, the Work Order #, and the PPW #. Using these fields you should track each work order and if it has been received yet. Any new work orders will then be imported using the get work order event.

Response JSON

{
  "remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",

  "error": false,
  "success": true,
  "return_error_msg": null,
  "result_data": {
    "wo_number": "import test 3-1",
    "client_company_alias": "Test Client",
    "cust_text": "Investor",
    "loan_number": "XXXXXXX1234",
    "loan_type_other": "CONV",
    "date_received": "20170331",
    "date_due": "20170415",
    "start_date": "20170402",
    "address": "123 Test Dr",
    "city": "Tiffin",
    "state": "OH",
    "zip": "44883",
    "comments": "",
    "work_type_alias": "Inspection",
    "mortgage_name": "",
    "line_items": [{
      "desc": "Inspection",
      "qty": "0.00",
      "price": "0.00",
      "total": "0.00",
      "add": ""
    }],
    "pcr_forms": [{
      "pcr_form_id": "6318",
      "form_id": "Exterior_Inspection",
      "form_ver_id": "1",
      "form_required": "0"
    }],
    "ppw_report_id": "12249320",
    "import_user_id": null,
    "key_values": {
      "bg_checkin_provider": "ags"
    },
    "lot_size": "",
    "lock_code": "",
    "key_code": "",
    "broker_name": null,
    "broker_company": null,
    "broker_phone": null,
    "broker_email": null,
    "vendor_id": "johndoe",
    "has_foh": true
  }
}

The key_values object can be used to set the check in provider. The only option currently is “ags”. This will set the check in provider to Aspen Grove Solutions. Leaving it blank or not even sending the value will require the default PPW mobile check in.

The vendor_id field in the get_order response is not required. If the field is used, it will need to be the username of a PPW user in the account being imported into. If the user exists, it will automatically be assigned to the user. The user needs to be active.

The has_foh flag indicates that the work order is for a property that has a Front of House photo. When the order is processed, it will queue the event to retrieve the Front of House photo from the client.