Properties

Endpoints that affect multiple properties that the channel has created.

Properties / Publish

Endpoint

PUT {{cm_url}}/cmf/properties/publish

Since v0.3

Publish all manager's properties.

If the property status = 2 then we can publish the property.

Request Headers

Properties / Statuses

Endpoint

GET {{cm_url}}/cmf/properties/statuses

Since v0.3

Get the property status for all of the manager's properties.

Request Headers

Properties / List / By / Date

Endpoint

GET {{cm_url}}/cmf/properties/list/by/date

Since v0.2

Request Headers

Properties / Available / Price

Endpoint

GET {{cm_url}}/cmf/properties/available/prices/2020-01-17/2020-02-05/2

Since v0.2

Get all properties available, including prices for the selected manager.

Request Headers

Properties / ids

Endpoint

GET {{cm_url}}/cmf/properties/ids

Since v0.2

Lists those properties on the site that this Channel has created.

Request Headers

Properties All

Endpoint

GET {{cm_url}}/cmf/properties/all

Returns all properties that the user has access to.

It differs from Properties IDs in that this endpoint will return ALL properties that the manager has access to, however not all properties will be available to the Channel because of the API privacy setting (which is included in the response).

Rationale :

Properties IDs lists those properties that the channel has created.

Properties All lists all properties that the manager has access to, including those not created by this Channel. This allows the BookyFlow2bookyflow plugin to export properties from a parent site and import them into a child installation however only those properties that have the API Privacy option set to Off can be exported.

Request Headers

Response Example

Status: OK (200)

{
  "data": {
    "response": [
      {
        "property_id": 1,
        "property_name": "L'Fawlty Towers",
        "property_town": "T'orquay",
        "property_region": "Devon",
        "property_country": "United Kingdom",
        "property_type_title": "Hotel"
      },
      {
        "property_id": 2,
        "property_name": "Best West Hotel",
        "property_town": "London",
        "property_region": "London, City of",
        "property_country": "United Kingdom",
        "property_type_title": "Hotel"
      },
      {
        "property_id": 3,
        "property_name": "Jaguar S Type",
        "property_town": "London",
        "property_region": "London, City of",
        "property_country": "United Kingdom",
        "property_type_title": "Car"
      },
      {
        "property_id": 4,
        "property_name": "Aston Martin DB7",
        "property_town": "London",
        "property_region": "London, City of",
        "property_country": "United Kingdom",
        "property_type_title": "Car"
      },
      {
        "property_id": 5,
        "property_name": "Some Yacht",
        "property_town": "Bristol",
        "property_region": "Bristol, City of",
  ...
  (Response truncated for brevity)
}