v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all blockout times of a center

Retrives the list of Blockout times created between the start date and end date of the center whose ID is passed as {center_id} and block out times of all the rooms or employees who had a block out time created in the appointment book for that center.

get/v1/centers/{center_id}/blockouttimes

Path parameters

center_idstring required

Unique identifier of the center.

Query parameters

start_datestring date

Start date for fetching all the blockout times of the center.

end_datestring date

End date for fetching all the blockout times of the center.

sourceinteger

blockout creation source filter

Response

200

{"stackTrail":"paths:/v1/centers/{center_id}/blockouttimes:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "block_out_times": [
    {
      "block_out_time_id": "95e963fa-a252-4fc5-8ae9-f471b2b5d5e6",
      "employee": {
        "id": "1afd493a-4aad-48a3-8f94-9fdea88691ac",
        "name": "Ajay Kumar Singh"
      },
      "block_out_time_type": {
        "id": 16,
        "name": "Lunch ",
        "duration": 60
      },
      "start_time": "2018-10-10T02:30:00",
      "end_time": "2018-10-10T03:30:00",
      "start_time_in_center": "2018-10-10T08:00:00",
      "end_time_in_center": "2018-10-10T09:00:00",
      "recurring_block_out_time": {
        "rec_start_date": "0001-01-01T00:00:00"
      }
    }
  ]
}