get_foh – Get Front of House Photo

The get_foh event will return a direct link to the property’s Front of House photo. When an order is imported for a property that has a Front of House photo, a flag will be set in the json of the work order called has_foh which will be set to a boolean true or false. When the work order is later processed in PPW, the “get_foh” event will be queued for that work order. When this event is processed, the following payload will be sent to the client:

Request payload JSON

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

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

This will return a direct link to the front of house photo along with the numeric value of the file size in megabytes rounded to the nearest whole number:

Response JSON

{
  "remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
  "error": false,
  "success": true,
  "return_error_msg": null,
  "result_data": {
    "s3_url": "https:\/\/link-to-photo.com",
    "file_metadata": {
      "file_size": "7"
    }
  }
}

File metadata fields