v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the blockout time of an employee

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

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

Path parameters

block_out_time_idstring required

Mandatory Unique 32-character identifier of the employee'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 employee's blockout time.

Response

200

block_out_time_idstring

start_timestring

end_timestring

start_time_in_centerstring

end_time_in_centerstring

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

Example response

{
  "block_out_time_id": "22f82cb4-7d3d-461b-b1f5-02ea71c1dc21",
  "employee": {
    "id": "1afd493a-4aad-48a3-8f94-9fdea88691ac",
    "name": "Ajay Kumar Singh"
  },
  "block_out_time_type": {
    "id": 16,
    "name": "Lunch ",
    "duration": 60
  },
  "start_time": "2018-09-07T11:45:00",
  "end_time": "2018-09-07T12:45:00",
  "start_time_in_center": "2018-09-07T17:15:00",
  "end_time_in_center": "2018-09-07T18:15:00",
  "recurring_block_out_time": {
    "id": "eee25098-f3b2-4591-998e-685361f6f23a",
    "time_period": "Daily",
    "interval": 1,
    "rec_start_date": "2018-09-07T00:00:00",
    "occurences": 3
  }
}