Cisco Unity Express -- Business Schedule and Holidays REST PI Service Operation

From DocWiki

Jump to: navigation, search

Main page: Cisco Unity Express -- REST PI Service Operations

Previous page: Cisco Unity Express -- Applications REST PI Service Operation

Next page: Cisco Unity Express -- Language and Prompts REST PI Service Operation


Search the Cisco Unity Express documentation on the DocWiki:

Loading




Contents

Business Schedule and Holidays

Classes

Figure 9: Business Schedule

CUE80 Business Schedule.jpg


Day
Class Name

Day (Enumeration Class)

Extends From
Description

Enumeration for days of the week.

XML Namespace

http://schedule.model.rest.aesop.cisco.com

Enum Values

SUN, MON, TUE, WED, THU, FRI, SAT, MON_FRI, SAT_SUN, ALL


HalfHourlyTime
Class Name

HalfHourlyTime (Enumeration Class)

Extends From
Description

Enumeration for dividing 24 Hour day into half hourly slots.

XML Namespace

http://schedule.model.rest.aesop.cisco.com

Enum Values

T_0000 (00:00Hrs), T_0030 (00:30Hrs), T_0100 (01:00Hrs)

...

...

T_2300 (23:00Hrs), T_2330 (23:30Hrs), T_2400 (00:00Hrs)


State
Class Name

State (Enumeration Class)

Extends From
Description

Enumeration for denoting the state during a given schedule slot. In the context of busness schedule it denotes the open or close state.

XML Namespace

http://schedule.model.rest.aesop.cisco.com

Enum Values

ACTIVE (business is open), INACTIVE (business is closed)


ScheduleTuple
Class Name

ScheduleTuple

Extends From

BaseElement

Description

Class representing a single record in the business hour schedule.

XML Namespace

http://schedule.model.rest.aesop.cisco.com

Enum Values

ACTIVE (business is open), INACTIVE (business is closed)

Field Name Type Constraints Comments

day

Day

Day of the week to which this tuple applies. The day could be a range value like ALL or MON_FRI or and individual day of the week.

timeFrom

HalfHourlyTime

The start time of the time range.

timeTo

HalfHourlyTime

The end time of the time range.

state

State

Mark the time range represented by this tuple as open (Active) or closed (Inactive).


BusinessSchedule
Class Name

BusinessSchedule

Extends From

Schedule

Description

Class representing business hours schedule (open and close hours).

XML Namespace

http://bschedule.model.rest.aesop.cisco.com

Enum Values

ACTIVE (business is open), INACTIVE (business is closed)

Field Name Type Constraints Comments

scheduleName

String

Length 2 -64

Schedule name

scheduleTuples

Collection <ScheduleTuple>

Collection of tuples indicating open and close hours.


Holiday
Class Name

Holiday

Extends From

ManagedBaseElement

Description

Class representing a business holiday.

XML Namespace

http://holiday.model.rest.aesop.cisco.com

Field Name Type Constraints Comments

mmdd

String

Holiday month and day

year

String

Year must be specified as "fixed" or as yyyy. Value could be current -1, current or current + 1 year).

Holiday year

description

String

Holiday description


Resources

Resource URI Operation Input Return Value

/businessSchedules

GET (read all business schedules defined)

BaseElementList Containing list of BusinessSchedule objects.

POST (define a new business schedule)

BusinessSchedule

/businessSchedules/{schedulename}

GET (read a business schedule)

BusinessSchedule

PUT (update a business schedule)

BusinessSchedule

DELETE (delete a business schedule)

/holidays

GET (Read all holidays defined)

BaseElementList Containing list of Holiday objects.

/holidays/fixed

GET (Read all fixed holidays defined)

BaseElementList Containing list of Holiday objects.

POST (Create a fixed holiday)

Holiday

/rest/holidays/fixed/(mmdd)

GET (Define a new fixed holiday for date mmdd}

Holiday

PUT (Update a fixed holiday)

Holiday

DELETE (Delete a fixed holiday)

/holidays/{yyyy}

GET (Read all holidays defined for a given year yyyy)

BaseElementList Containing list of Holiday objects.

POST (Create a holiday in a given year)

Holiday

/rest/holidays/{yyyy}/{mmdd}

GET (Define a new holiday for a given year yyyy and date mmdd}

Holiday

PUT (Update a holiday)

Holiday

DELETE (Delete a holiday)

Rating: 0.0/5 (0 votes cast)

Personal tools