Properties

Scope

Property Get / Property Set

Get properties all

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/all/

Gets all of the properties that the mananger has rights to administer

Response Example

Status: OK (200)

{
  "data": {
    "ids": [
      1,
      2,
      3,
      4,
      5,
      6,
      7,
      8,
      9,
      10,
      11,
      12,
      13,
      14,
      15,
      16,
      17,
      18,
      19,
      20,
      21,
      22,
      23,
      24,
      25,
      27,
      28,
      29,
      30,
      31,
      32
    ]
  },
  "meta": {
    "code": 200
  }
}

Get property availability

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/availabilities/{{property_availability_start}}/{{property_availability_end}}

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{property_availability_start}} (Required parameter)
{{property_availability_end}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "available_rooms": {
      "54": {
        "room_uid": 54,
        "room_name": "",
        "room_number": "02",
        "room_classes_uid": 1,
        "room_features_uid": "",
        "max_people": 2
      },
      "55": {
        "room_uid": 55,
        "room_name": "",
        "room_number": "02",
        "room_classes_uid": 3,
        "room_features_uid": "5,4",
        "max_people": 1
      },
      "56": {
        "room_uid": 56,
        "room_name": "asdf",
        "room_number": "03",
        "room_classes_uid": 4,
        "room_features_uid": "",
        "max_people": 2
      },
      "79": {
        "room_uid": 79,
        "room_name": "",
        "room_number": "03",
        "room_classes_uid": 33,
        "room_features_uid": "5,4",
        "max_people": 2
      },
      "80": {
        "room_uid": 80,
        "room_name": "",
        "room_number": "04",
        "room_classes_uid": 36,
  ...
  (Response truncated for brevity)
}

Get property availability - timeline events

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/availabilities/timeline/{{property_availability_start}}/{{property_availability_end}}

This function replicates the ajax call that builds the timeline data

Path Parameters

Parameter Description
{{property_id}} (Required parameter)
{{property_availability_start}} (Required parameter)
{{property_availability_end}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "dashboard_availabilities": "[{\"id\":\"91_53\",\"resourceId\":\"53\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"53\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_54\",\"resourceId\":\"54\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"54\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_55\",\"resourceId\":\"55\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"55\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_56\",\"resourceId\":\"56\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"56\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_79\",\"resourceId\":\"79\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"79\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_80\",\"resourceId\":\"80\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"80\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_81\",\"resourceId\":\"81\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"81\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_82\",\"resourceId\":\"82\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"82\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_83\",\"resourceId\":\"83\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"83\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_84\",\"resourceId\":\"84\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"84\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_85\",\"resourceId\":\"85\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"85\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_86\",\"resourceId\":\"86\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"86\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_87\",\"resourceId\":\"87\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"87\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_88\",\"resourceId\":\"88\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"88\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_89\",\"resourceId\":\"89\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"89\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_90\",\"resourceId\":\"90\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"90\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_91\",\"resourceId\":\"91\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"91\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_92\",\"resourceId\":\"92\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"92\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_93\",\"resourceId\":\"93\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"93\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_94\",\"resourceId\":\"94\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"94\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_95\",\"resourceId\":\"95\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"95\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_96\",\"resourceId\":\"96\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"96\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_97\",\"resourceId\":\"97\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"97\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]},{\"id\":\"91_98\",\"resourceId\":\"98\",\"start\":\"2019-11-04T12:00:00\",\"end\":\"2019-11-12T11:59:59\",\"title\":\"Black booking\",\"url\":\"http:\\/\\/localhost\\/joomla_portal\\/index.php?option=com_bookyflow&Itemid=103&lang=en&bookyflowlang=en-GB&task=show_black_booking&contract_uid=91&thisProperty=1\",\"className\":\"label label-black\",\"description\":\"From: Monday, 04 November 2019<br\\/>To: Tuesday, 12 November 2019<hr\\/>Out of service due to property holiday<br\\/>\",\"contract_uid\":\"91\",\"room_uid\":\"98\",\"this_contract_room_uids\":[\"53\",\"54\",\"55\",\"56\",\"79\",\"80\",\"81\",\"82\",\"83\",\"84\",\"85\",\"86\",\"87\",\"88\",\"89\",\"90\",\"91\",\"92\",\"93\",\"94\",\"95\",\"96\",\"97\",\"98\"]}]"
  },
  "meta": {
    "code": 200
  }
}

Get property name

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/name

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_name": "Fawlty Towers"
  },
  "meta": {
    "code": 200
  }
}

Get property description

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/description

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_description": "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin posuere, nisl at porttitor dignissim, risus tortor aliquam augue, ut consectetur dui quam vitae purus. Vestibulum id tellus ligula, vel elementum est. Ut in ligula est, id lobortis justo. Mauris pretium posuere blandit. Sed suscipit orci sed ipsum interdum accumsan. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Integer eu felis sapien. Nulla ultrices dapibus dapibus. Etiam suscipit lorem et augue elementum congue. Mauris id euismod arcu. Nam commodo rhoncus urna sit amet faucibus. Phasellus sed dui mauris. Proin quis felis lectus. Sed nec nulla nulla, posuere consequat urna. Nunc porta turpis ut urna dictum gravida.</p>"
  },
  "meta": {
    "code": 200
  }
}

Get property checkin times

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/property_checkin_times

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_checkin_times": "<p>Any time from 2pm onwards</p>"
  },
  "meta": {
    "code": 200
  }
}

Get property area activities

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/property_area_activities

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_area_activities": "<p>Surfing, rock climbing, fishing &amp; lazing in the sun.</p>"
  },
  "meta": {
    "code": 200
  }
}

Get property driving directions

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/property_driving_directions

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_driving_directions": "<p>Second star to the right and straight on till morning.</p>"
  },
  "meta": {
    "code": 200
  }
}

Get property policies

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/property_policies_disclaimers

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "property_policies_disclaimers": "<p>Requests for bed type and smoking preferences will be submitted to the hotel but are not guaranteed. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin posuere, nisl at porttitor dignissim, risus tortor aliquam augue, ut consectetur dui quam vitae purus. Vestibulum id tellus ligula, vel elementum est. Ut in ligula est, id lobortis justo. Mauris pretium posuere blandit. Sed suscipit orci sed ipsum interdum accumsan.Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin posuere, nisl at porttitor dignissim, risus tortor aliquam augue, ut consectetur dui quam vitae purus. Vestibulum id tellus ligula, vel elementum est. Ut in ligula est, id lobortis justo. Mauris pretium posuere blandit. Sed suscipit orci sed ipsum interdum accumsan.</p>"
  },
  "meta": {
    "code": 200
  }
}

Get property location

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/lat_long

Returns the property's lat and long settings

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "lat_long": {
      "lat": "50.4922892",
      "long": "-4.0848398"
    }
  },
  "meta": {
    "code": 200
  }
}

Get property accommodation tax rate

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/accommodation_tax_rate

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "accommodation_tax_rate": 20
  },
  "meta": {
    "code": 200
  }
}

Get property room types

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/property_room_types

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "this_property_room_classes": {
      "1": {
        "abbv": "Room Double beds",
        "desc": "<p>asdf as fdas</p>\r\n<p>sdf</p>\r\n<p>asd fsad</p>\r\n<p>f sadfs</p>\r\n<p>sd f</p>\r\n<p>sd fsa dasfd</p>\r\n<p>sadf sadf s</p>\r\n<p>a</p>",
        "image": "double.png"
      },
      "2": {
        "abbv": "Room Twin beds",
        "desc": "",
        "image": "twin.png"
      },
      "3": {
        "abbv": "Room Single",
        "desc": "",
        "image": "single.png"
      },
      "4": {
        "abbv": "Room 4 Poster bed",
        "desc": "",
        "image": "fourposter.png"
      },
      "33": {
        "abbv": "Custom room type 111",
        "desc": "<p>English room type description</p>",
        "image": "3bedrooms.png"
      },
      "36": {
        "abbv": "Custom room type 3",
        "desc": "asdfas\u00f1df asd f",
        "image": "camping_6_man_tent_pitch.png"
      },
      "image_rel_path": "C:\\wamp64\\www\\joomla_portal\\bookyflow\\uploadedimages\\/rmtypes/"
    }
  },
  "meta": {
    "code": 200
  }
}

Get property settings

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/details/settings

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "settings": {
      "newTariffModels": "2",
      "singlePersonSuppliment": "0",
      "singlePersonSupplimentCost": "10",
      "perPersonPerNight": "0",
      "depositIsPercentage": "1",
      "depositValue": "20",
      "errorChecking": "0",
      "bookyflowdotnet": "www.bookyflow.net",
      "visitorscanbookonline": "1",
      "fixedPeriodBookings": "0",
      "fixedPeriodBookingsNumberOfDays": "7",
      "numberofFixedPeriods": "4",
      "singleRoomProperty": "0",
      "fixedArrivalDateYesNo": "0",
      "fixedArrivalDay": "0",
      "showAvailabilityCalendar": "1",
      "avlcal_todaycolor": "#CC0000",
      "avlcal_inmonthface": "#000000",
      "avlcal_outmonface": "#666666",
      "avlcal_inbgcolour": "#6AFB92",
      "avlcal_outbgcolour": "#FFCCFF",
      "avlcal_occupiedcolour": "#FF0000",
      "avlcal_provisionalcolour": "#FFFC17",
      "showRoomsListingLink": "1",
      "cformat": "2",
      "weekenddays": "5,6",
      "avlcal_black": "#BEBEBE",
      "avlcal_booking": "green",
      "avlcal_pastcolour": "#BEBEBE",
      "avlcal_weekendborder": "#BEBEBE",
      "cal_output": "jS M Y",
      "cal_input": "%d/%m/%Y",
      "fixedPeriodBookingsShortYesNo": "0",
      "fixedPeriodBookingsShortNumberOfDays": "4",
      "showExtras": "1",
      "limitAdvanceBookingsYesNo": "0",
      "advanceBookingsLimit": "90",
  ...
  (Response truncated for brevity)
}

Get property images main

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/images/main/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "images": {
      "large": "/bookyflow/uploadedimages/1/property/0/alpha.png",
      "medium": "/bookyflow/uploadedimages/1/property/0/medium/alpha.png",
      "small": "/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
    }
  },
  "meta": {
    "code": 200
  }
}

Get property images slideshow

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/images/slideshow/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "images": [
      [
        {
          "large": "/bookyflow/uploadedimages/1/slideshow/0/2.jpg",
          "medium": "/bookyflow/uploadedimages/1/slideshow/0/medium/2.jpg",
          "small": "/bookyflow/uploadedimages/1/slideshow/0/thumbnail/2.jpg"
        },
        {
          "large": "/bookyflow/uploadedimages/1/slideshow/0/3.jpg",
          "medium": "/bookyflow/uploadedimages/1/slideshow/0/medium/3.jpg",
          "small": "/bookyflow/uploadedimages/1/slideshow/0/thumbnail/3.jpg"
        },
        {
          "large": "/bookyflow/uploadedimages/1/slideshow/0/4.jpg",
          "medium": "/bookyflow/uploadedimages/1/slideshow/0/medium/4.jpg",
          "small": "/bookyflow/uploadedimages/1/slideshow/0/thumbnail/4.jpg"
        }
      ]
    ]
  },
  "meta": {
    "code": 200
  }
}

Get property images room

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/images/room/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "images": {
      "1": [
        {
          "large": "/bookyflow/uploadedimages/1/rooms/1/5.jpg",
          "medium": "/bookyflow/uploadedimages/1/rooms/1/medium/5.jpg",
          "small": "/bookyflow/uploadedimages/1/rooms/1/thumbnail/5.jpg"
        }
      ],
      "2": [
        {
          "large": "/bookyflow/uploadedimages/1/rooms/2/5.jpg",
          "medium": "/bookyflow/uploadedimages/1/rooms/2/medium/5.jpg",
          "small": "/bookyflow/uploadedimages/1/rooms/2/thumbnail/5.jpg"
        }
      ],
      "53": [
        {
          "large": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "medium": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "small": "http://localhost/joomla_portal/bookyflow/assets/images/noimage_small.gif"
        }
      ],
      "54": [
        {
          "large": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "medium": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "small": "http://localhost/joomla_portal/bookyflow/assets/images/noimage_small.gif"
        }
      ],
      "55": [
        {
          "large": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "medium": "http://localhost/joomla_portal/bookyflow/assets/images/noimage.gif",
          "small": "http://localhost/joomla_portal/bookyflow/assets/images/noimage_small.gif"
        }
      ],
      "56": [
        {
  ...
  (Response truncated for brevity)
}

Get property tariffs

Endpoint

GET https://yourdomain.com/bookyflow/api/properties/{{property_id}}/tariffs/

Path Parameters

Parameter Description
{{property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "tariffs": [
      {
        "rates_uid": 257,
        "rate_title": "Tariff",
        "rate_description": "",
        "validfrom": "2018/11/01",
        "validto": "2019/12/31",
        "roomrateperday": 100,
        "mindays": 1,
        "maxdays": 365,
        "minpeople": 1,
        "maxpeople": 100,
        "roomclass_uid": "33",
        "ignore_pppn": 0,
        "allow_we": 1
      },
      {
        "rates_uid": 262,
        "rate_title": "Tariff",
        "rate_description": "",
        "validfrom": "2019/03/01",
        "validto": "2020/12/31",
        "roomrateperday": 100,
        "mindays": 1,
        "maxdays": 365,
        "minpeople": 1,
        "maxpeople": 100,
        "roomclass_uid": "3",
        "ignore_pppn": 0,
        "allow_we": 1
      },
      {
        "rates_uid": 263,
        "rate_title": "Tariff",
        "rate_description": "",
        "validfrom": "2019/03/01",
        "validto": "2019/12/31",
        "roomrateperday": 80,
  ...
  (Response truncated for brevity)
}

Property add

Endpoint

POST https://yourdomain.com/bookyflow/api/properties/add

Form Data Parameters

Parameter Type Required Description
property_name text Yes
property_street text Yes
property_town text Yes
region text Yes Use www.example.com/bookyflow/api/properties/regions to retrieve Region ids
property_postcode text Yes
country text Yes Countries sent must be in ISO 3166 format ( http://www.iso.org/iso/country_codes )
property_tel text Yes
price text Yes Real estate type properties only
lat text Yes Latitude
long text Yes Longitude
ptype_id text Yes Use www.example.com/bookyflow/api/properties/types to retrieve possible property types and their available ids
stars text Yes
superior text Yes 1 or 0
property_description text Yes
property_checkin_times text Yes
property_area_activities text Yes
property_driving_directions text Yes
property_airports text Yes
property_othertransport text Yes
property_policies_disclaimers text Yes

Response Example

Status: OK (200)

{
  "data": {
    "id": 33
  },
  "meta": {
    "code": 200
  }
}

Delete property

Endpoint

DELETE https://yourdomain.com/bookyflow/api/properties/{{delete_property_id}}

Path Parameters

Parameter Description
{{delete_property_id}} (Required parameter)

Response Example

Status: OK (200)

{
  "data": {
    "id": "33"
  },
  "meta": {
    "code": 200
  }
}