Calendar Schedules

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

Retrieve the group’s calendar schedules list

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

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

Create a new group’s calendar schedule instance

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

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

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

Retrieve a group’s calendar schedule instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_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”.

Update a group’s calendar schedule instance

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

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

Additionaly, the API is implemented by using:

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

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

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

Delete group’s calendar schedules list

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

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

Delete a group’s calendar schedule instance

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

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

Calendar Schedule Periods

Create a new group’s calendar schedule period instance

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

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

Retrieve a group’s calendar schedule period instance

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

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

Update a group’s calendar schedule period instance

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

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

Delete a group’s calendar schedule period instance

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

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