Calendar Schedules

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

Retrieve the user’s calendar schedules list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/

The API is implemented using the UserScheduleGetListRequest forcing the scheduleType to “Holidays”.

Create a new user’s calendar schedule instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/

The API is implemented by using UserScheduleAddRequest for creating the Schedule (forcing the scheduleType to “Holidays”).

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

Retrieve a user’s calendar schedule instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/(string: instance_name)/

The API is implemented using the UserScheduleGetRequest forcing the scheduleType to “Holidays”.

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

- UserScheduleGetEventListRequest forcing the scheduleType to “Holidays” or,

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

Update a user’s calendar schedule instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/(string: instance_name)/

The API is implemented by using UserScheduleModifyRequest for updating the Schedule (forcing the scheduleType to “Holidays”).

Additionally, the API is implemented by using:

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

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

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

Delete user’s calendar schedules list

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/

The API is implemented using the UserScheduleDeleteListRequest forcing the scheduleType to “Holidays”.

Delete a user’s calendar schedule instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/(string: instance_name)/

The API is implemented using the UserScheduleDeleteListRequest by providing only 1 entry and forcing the scheduleType to “Holidays”.

Calendar Schedule Periods

Create a new user’s calendar schedule period instance

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

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

Retrieve a user’s calendar schedule period instance

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

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

Update a user’s calendar schedule period instance

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

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

Delete a user’s calendar schedule period instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/calendar_schedules/(string: instance_name)/(string: sub_instance_name)/

The API is implemented using the UserScheduleDeleteEventRequest forcing the scheduleType to “Holidays”.