Time Schedules¶

The Time notion is mapped in Broadsoft on the Schedule of type “Time”.

Retrieve the user’s time schedules list¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/¶: The API is implemented using the UserScheduleGetListRequest forcing the scheduleType to “Time”.

Create a new user’s time schedule instance¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/¶: The API is implemented by using UserScheduleAddRequest for creating the Schedule (forcing the scheduleType to “Time”).

Additionaly, the API is implemented by using UserScheduleAddEventRequest for creating new Periods (forcing the scheduleType to “Time”).

Retrieve a user’s time schedule instance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/¶: The API is implemented using the UserScheduleGetRequest forcing the scheduleType to “Time”.

Additionally, the API is implemented to get the list of periods by using:

- UserScheduleGetEventListRequest forcing the scheduleType to “Time” or,

- UserScheduleGetEventDetailListRequest when “full_list” is true, forcing the scheduleType to “Time”.

Update a user’s time schedule instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/¶: The API is implemented by using UserScheduleModifyRequest for updating the Schedule (forcing the scheduleType to “Time”).

Additionaly, the API is implemented by using:

- UserScheduleAddEventRequest for creating a new Period (forcing the scheduleType to “Time”),

- UserScheduleModifyEventRequest for updating an existing Period (forcing the scheduleType to “Time”),

- UserScheduleDeleteEventRequest for removing an existing Period (forcing the scheduleType to “Time”).

Delete user’s time schedules list¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/¶: The API is implemented using the UserScheduleDeleteListRequest forcing the scheduleType to “Time”.

Delete a user’s time schedule instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/¶: The API is implemented using the UserScheduleDeleteListRequest by providing only 1 entry and forcing the scheduleType to “Time”.

Time Schedule Periods¶

Create a new user’s time schedule period instance¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/¶

The API is implemented using the UserScheduleAddEventRequest forcing the scheduleType to “Time”.

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Retrieve a user’s time schedule period instance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/(string: sub_instance_name)/¶

The API is implemented using the UserScheduleGetEventRequest forcing the scheduleType to “Time”.

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Update a user’s time schedule period instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/(string: sub_instance_name)/¶

The API is implemented using the UserScheduleModifyEventRequest forcing the scheduleType to “Time”.

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Delete a user’s time schedule period instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/time_schedules/(string: instance_name)/(string: sub_instance_name)/¶: The API is implemented using the UserScheduleDeleteEventRequest forcing the scheduleType to “Time”.