v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the block out time of a room

Use this API to retrieve the blockout time of the specified room.

get/v1/blockouttimes/{block_out_time_id}?center_id={center_id}&expand[]=ReccuringDetails&source=1

Path parameters

block_out_time_idstring required

Mandatory Unique 32-character identifier of the room's blockout ID for which this API returns the corresponding blockout time information.

Query parameters

center_idstring required

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

Response

200

block_out_time_idstring

{"stackTrail":"paths:/v1/blockouttimes/{block_out_time_id}?center_id={center_id}&expand[]=ReccuringDetails&source=1:get:responses:200:content:application/json:schema:properties:employee","oasType":"schema","type":"unknown"}

start_timestring

end_timestring

start_time_in_centerstring

end_time_in_centerstring

notesstring

Example response

{
  "block_out_time_id": "3aa1d607-e604-4b8f-9db6-4674c61f0651",
  "room": {
    "id": "699ec863-c155-4c4b-bf58-5310a7d1df1c",
    "name": "15% Premium Room"
  },
  "block_out_time_type": {
    "id": 103,
    "name": "modelling",
    "duration": 15
  },
  "start_time": "2018-09-07T07:30:00",
  "end_time": "2018-09-07T08:00:00",
  "start_time_in_center": "2018-09-07T13:00:00",
  "end_time_in_center": "2018-09-07T13:30:00",
  "notes": "leaving for lunch",
  "recurring_block_out_time": {
    "id": "262b77bc-69ea-42ea-a258-33a033b6a936",
    "time_period": "Daily",
    "interval": 1,
    "rec_start_date": "2018-09-07T00:00:00",
    "occurences": 3
  }
}