Core

Core REST API functionality refers to features that are not delivered as plugins, in other words they are a part of BookyFlow itself.

The Report and Get properties endpoints here are typically used by the App server at app.bookyflow.net to gather information about individual sites for use in the syndication network.

Report

Endpoint

GET https://yourdomain.com/bookyflow/api/core/report/

This is a basic report where the installation reports it's base url, API url and a count of the number of published properties available in the system.

Response Example

Status: OK (200)

{
  "data": {
    "report": [
      {
        "api_url": "http%3A%2F%2Flocalhost%2Fjoomla_portal%2Fbookyflow%2Fapi%2F",
        "bookyflow_url": "http%3A%2F%2Flocalhost%2Fjoomla_portal%2Findex.php%3Foption%3Dcom_bookyflow%26Itemid%3D103%26lang%3Den",
        "property_count": 32
      }
    ]
  },
  "meta": {
    "code": 200
  }
}

Get properties

Endpoint

GET https://yourdomain.com/bookyflow/api/core/get_properties/

Returns basic information about published information stored in the system.

Response Example

Status: OK (200)

{
  "data": {
    "properties": [
      {
        "api_url": "http%3A%2F%2Flocalhost%2Fjoomla_portal%2Fbookyflow%2Fapi%2F",
        "bookyflow_url": "http%3A%2F%2Flocalhost%2Fjoomla_portal%2Findex.php%3Foption%3Dcom_bookyflow%26Itemid%3D103%26lang%3Den",
        "properties": [
          {
            "view_property_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=viewproperty&property_uid=1",
            "booking_form_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=dobooking&selectedProperty=1",
            "propertys_uid": 1,
            "name": "Fawlty Towers",
            "multi_room_property": true,
            "lat": "50.4922892",
            "long": "-4.0848398",
            "metadescription": "Faulty Towers Hotel Accommodation in Single, Double and Triple Rooms and Apartments",
            "thumbnail_location": "http://localhost/joomla_portal/bookyflow/uploadedimages/1/property/0/thumbnail/alpha.png"
          },
          {
            "view_property_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=viewproperty&property_uid=2",
            "booking_form_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=dobooking&selectedProperty=2",
            "propertys_uid": 2,
            "name": "Best West Hotel",
            "multi_room_property": true,
            "lat": "41.3661865",
            "long": "2.1164942",
            "metadescription": "",
            "thumbnail_location": "http://localhost/joomla_portal/bookyflow/uploadedimages/2/property/0/thumbnail/2.jpg"
          },
          {
            "view_property_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=viewproperty&property_uid=3",
            "booking_form_url": "http://localhost/joomla_portal/index.php?option=com_bookyflow&Itemid=103&lang=en&task=dobooking&selectedProperty=3",
            "propertys_uid": 3,
            "name": "Jaguar S Type",
            "multi_room_property": false,
            "lat": "51.49506",
            "long": "-0.1181",
            "metadescription": "",
            "thumbnail_location": "http://localhost/joomla_portal/bookyflow/uploadedimages/3/property/0/thumbnail/3.jpg"
          },
  ...
  (Response truncated for brevity)
}