v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve all blockout times of a room

Use this API to retrieve all blockout times of the specified room.

You must specify center_id, start_date and end_date. Note: The duration between the start_date and the end_date must be less than 10 days.

get/v1/rooms/{room_id}/blockouttimes?center_id={center_id}&start_date={start_date}&end_date={end_date}&expand[]=ReccuringDetails

Path parameters

room_idstring required

Mandatory Unique 32-character identifier of the room for which this API returns the corresponding blockout times information.

Query parameters

center_idstring required

Unique 32-character identifier of the center for which you want to retrieve the room's blockout times.

start_datestring date required

Start date from which this API returns the corresponding blockout times information of the room.

end_datestring date required

End date until which this API returns the corresponding blockout times information of the room. Note: The duration between the start_date and the end_date must be less than 10 days.

Response

200

{"stackTrail":"paths:/v1/rooms/{room_id}/blockouttimes?center_id={center_id}&start_date={start_date}&end_date={end_date}&expand[]=ReccuringDetails:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "block_out_times": [
    {
      "block_out_time_id": "83c057c1-166a-44e2-99c8-9feb2fb3040c",
      "room": {
        "id": "699ec863-c155-4c4b-bf58-5310a7d1df1c",
        "name": "15% Premium Room"
      },
      "block_out_time_type": {
        "id": 103,
        "name": "modelling",
        "duration": 15
      },
      "start_time": "2018-10-09T11:45:00",
      "end_time": "2018-10-09T11:45:00",
      "start_time_in_center": "2018-10-09T17:15:00",
      "end_time_in_center": "2018-10-09T17:15:00",
      "notes": "leaving for lunch",
      "recurring_block_out_time": {
        "rec_start_date": "0001-01-01T00:00:00"
      }
    }
  ]
}