Time Schedules¶

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

Retrieve the group’s time schedules list¶

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

Create a new group’s time schedule instance¶

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

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

Retrieve a group’s time schedule instance¶

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

Update a group’s time schedule instance¶

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

Additionaly, the API is implemented by using:

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

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

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

Delete group’s time schedules list¶

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

Delete a group’s time schedule instance¶

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

Time Schedule Periods¶

Create a new group’s time schedule period instance¶

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

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

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Retrieve a group’s time schedule period instance¶

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

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

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Update a group’s time schedule period instance¶

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

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

Additional informations

Response JSON Object:

active (boolean) – Not supported by Broadsoft.

Delete a group’s time schedule period instance¶

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