Sequential Ring

Display user’s sequential ring

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

The API is mapped to UserSequentialRingGetRequest14sp4

Additional information

Response JSON Object:

• baseLocationNumberOfRings (integer) – the number of rings to be played. Possible values are 0, 2-20.

• locations (array) – a list of location objects as defined as Location attributes.

• criteria (array) – a list of criteria objects as defined as Criteria attributes.

Update a user’s sequential ring

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/sequential_ring/

The API is mapped to UserSequentialRingModifyRequest

Additional restrictions

Request JSON Object:

• baseLocationNumberOfRings (integer) – the number of rings to be played. Possible values are 0, 2-20.

• locations (array) – a list of location objects as defined as Location attributes.

• criteria (array) – a list of criteria objects as defined as Criteria attributes.

Display user’s sequential ring criteria

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/sequential_ring/criteria/(string: instance_name)/

The API is mapped to UserSequentialRingGetCriteriaRequest16

Additional information

Response JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

Assign a user’s sequential ring criteria

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/sequential_ring/criteria/

The API is mapped to UserSequentialRingAddCriteriaRequest16

Additional restrictions

Response JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

Update a user’s sequential ring criteria

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/sequential_ring/criteria/(string: instance_name)/

The API is mapped to UserSequentialRingModifyCriteriaRequest

Additional restrictions

Request JSON Object:

• name (string) – (Required) see name from Criteria attributes.

• newName (string) – see newName from Criteria attributes.

• timeSchedule (object) – see timeSchedule from Schedule attributes.

• holidaySchedule (object) – see holidaySchedule from Schedule attributes.

• fromDnCriteria (object) – see fromDnCriteria from Criteria From DN attributes.

Disassign a user’s sequential ring criteria

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/sequential_ring/criteria/(string: instance_name)/

The API is mapped to UserSequentialRingDeleteCriteriaRequest

Additional restrictions

Response JSON Object:

• name (string) – (Required) see name from Criteria attributes.