Pre Announcement

Display user’s pre announcement

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

The API is mapped to UserPreAlertingAnnouncementGetRequest20

Response JSON Object:

• active (boolean) – the status of the service.

• audioSelection (string) – the the selection of the file to be played.

• audioFile (object) – an objects as defined as Audio File attributes.

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

Update a user’s pre announcement

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

The API is mapped to UserPreAlertingAnnouncementModifyRequest20

Request JSON Object:

• active (boolean) – the status of the service.

• audioSelection (string) – the the selection of the file to be played.

• audioFile (object) – an objects as defined as Audio File attributes.

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

Display user’s pre announcement criteria

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

The API is mapped to UserPreAlertingAnnouncementGetCriteriaRequest

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 pre announcement criteria

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

The API is mapped to UserPreAlertingAnnouncementAddCriteriaRequest

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 pre announcement criteria

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

The API is mapped to UserPreAlertingAnnouncementModifyCriteriaRequest

Additional restrictions

Response JSON Object:

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

• newName (string) – (Required) 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 pre announcement criteria

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

The API is mapped to UserPreAlertingAnnouncementDeleteCriteriaRequest

Additional restrictions

Response JSON Object:

• name (string) – the name (see Criteria attributes).