v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve all blockout times of an employee

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

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

Path parameters

employee_idstring required

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

Query parameters

center_idstring required

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

start_datestring date

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

end_datestring date

Optional End date until which this API returns the corresponding blockout times information of the employee.

Response

200

{"stackTrail":"paths:/v1/employees/{employee_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": "9354d793-19b5-4aaa-9523-1095c8bebd49",
      "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": "8f89d3a1-c3d3-4772-b871-6238023a1f09",
        "time_period": "Daily",
        "interval": 1,
        "rec_start_date": "2018-09-07T00:00:00",
        "occurences": 3
      }
    }
  ]
}