Site Structure

This refers to various assests that aren't tied to individual properties, such as room types, property types, property features, property feature categories, countries, regions and categories.

Get room types

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/room_types

Response Example

Status: OK (200)

{
  "data": {
    "room_types": {
      "1": {
        "room_classes_uid": 1,
        "room_class_abbv": "Room Double beds",
        "room_class_full_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",
        "ptype_xref": [
          "5",
          "1"
        ],
        "property_uid": 0
      },
      "2": {
        "room_classes_uid": 2,
        "room_class_abbv": "Room Twin beds",
        "room_class_full_desc": "",
        "image": "twin.png",
        "ptype_xref": [
          "1",
          "5"
        ],
        "property_uid": 0
      },
      "3": {
        "room_classes_uid": 3,
        "room_class_abbv": "Room Single",
        "room_class_full_desc": "",
        "image": "single.png",
        "ptype_xref": [
          "1",
          "5"
        ],
        "property_uid": 0
      },
      "4": {
        "room_classes_uid": 4,
        "room_class_abbv": "Room 4 Poster bed",
        "room_class_full_desc": "",
  ...
  (Response truncated for brevity)
}

Get property types

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/property_types

Response Example

Status: OK (200)

{
  "data": {
    "all_property_types": {
      "1": "hotel",
      "2": "yacht",
      "3": "car",
      "4": "Camp Site",
      "5": "Bed and Breakfast",
      "6": "mansion",
      "7": "Apartment",
      "8": "cottage",
      "9": "revolution",
      "10": "For Sale",
      "11": "2 Berth sailboat"
    }
  },
  "meta": {
    "code": 200
  }
}

Get property features

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/property_features

Response Example

Status: OK (200)

{
  "data": {
    "property_features": {
      "4": {
        "id": 4,
        "abbv": "Minibar",
        "desc": "Minibar in room",
        "image": "air_conditioning.png",
        "property_uid": 0,
        "include_in_filters": 1,
        "ptype_xref": [
          1
        ],
        "cat_id": 0,
        "cat_title": ""
      },
      "5": {
        "id": 5,
        "abbv": "All Inclusive",
        "desc": "All inclusive rates available",
        "image": "allinc.png",
        "property_uid": 0,
        "include_in_filters": 1,
        "ptype_xref": [],
        "cat_id": 9,
        "cat_title": "Services"
      },
      "6": {
        "id": 6,
        "abbv": "Family Friendly",
        "desc": "Children Welcome",
        "image": "baby_friendly.png",
        "property_uid": 0,
        "include_in_filters": 1,
        "ptype_xref": [
          1
        ],
        "cat_id": 0,
        "cat_title": ""
      },
  ...
  (Response truncated for brevity)
}

Get property feature categories

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/property_features_categories

Response Example

Status: OK (200)

{
  "data": {
    "property_features_categories": {
      "1": {
        "id": 1,
        "title": "Activities"
      },
      "2": {
        "id": 2,
        "title": "Amenities"
      },
      "3": {
        "id": 3,
        "title": "Accessibility"
      },
      "4": {
        "id": 4,
        "title": "Views"
      },
      "5": {
        "id": 5,
        "title": "Living Area"
      },
      "6": {
        "id": 6,
        "title": "Media & Technology"
      },
      "7": {
        "id": 7,
        "title": "Food & Drink"
      },
      "8": {
        "id": 8,
        "title": "Parking"
      },
      "9": {
        "id": 9,
        "title": "Services"
      },
      "10": {
  ...
  (Response truncated for brevity)
}

Get countries

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/countries

Response Example

Status: OK (200)

{
  "data": {
    "countries": {
      "AF": {
        "id": "1",
        "countrycode": "AF",
        "countryname": "Afghanistan"
      },
      "AL": {
        "id": "2",
        "countrycode": "AL",
        "countryname": "Albania"
      },
      "DZ": {
        "id": "3",
        "countrycode": "DZ",
        "countryname": "Algeria"
      },
      "AS": {
        "id": "4",
        "countrycode": "AS",
        "countryname": "Am. Samoa"
      },
      "AD": {
        "id": "5",
        "countrycode": "AD",
        "countryname": "Andorra"
      },
      "AO": {
        "id": "6",
        "countrycode": "AO",
        "countryname": "Angola"
      },
      "AI": {
        "id": "7",
        "countrycode": "AI",
        "countryname": "Anguilla"
      },
      "AQ": {
        "id": "8",
  ...
  (Response truncated for brevity)
}

Get regions

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/regions

Response Example

Status: OK (200)

{
  "data": {
    "regions": {
      "1": {
        "id": "1",
        "countrycode": "AD",
        "regionname": "canillo"
      },
      "2": {
        "id": "2",
        "countrycode": "AD",
        "regionname": "Encamp"
      },
      "3": {
        "id": "3",
        "countrycode": "AD",
        "regionname": "La Massana"
      },
      "4": {
        "id": "4",
        "countrycode": "AD",
        "regionname": "ordinate"
      },
      "5": {
        "id": "5",
        "countrycode": "AD",
        "regionname": "Sant Julia de Loria"
      },
      "6": {
        "id": "6",
        "countrycode": "AD",
        "regionname": "Andorra la Vella"
      },
      "7": {
        "id": "7",
        "countrycode": "AD",
        "regionname": "Escaldes-Engordany"
      },
      "8": {
        "id": "8",
  ...
  (Response truncated for brevity)
}

Get categories

Endpoint

GET https://yourdomain.com/bookyflow/api/site_structure/categories

Response Example

Status: OK (200)

{
  "data": {
    "categories": {
      "1": {
        "id": 1,
        "title": "Rentals",
        "description": ""
      },
      "2": {
        "id": 2,
        "title": "Tours",
        "description": ""
      }
    }
  },
  "meta": {
    "code": 200
  }
}