Data Structure for Calendar

Attribute Name

Base Type

Restrictions

Description

calId

int

minOccurs = 0

maxOccurs = 1

Unique identifier of the calendar.

name

string

1 to 30 characters length

Name of the calendar.

timeZone

string

Valid time zone

The time zone of the calendar.

description

string

1 to 70 characters length

(not mandatory)

The description of the calendar.

calendarType

string

minOccurs = 1

maxOccurs = 1

Indicates the type of the calendar.

1—Full time

2—Fixed Hours

3—Flexible Hours

Note
Selecting either the Fixed Hours or Flexible Hours makes the businessDays attribute as mandatory.

buisnessDays

ccBusinessDays

minOccurs = 0

maxOccurs = 1

The custom weekly business calendar days that are configured.

specialDays

ccSpecialDays

minOccurs = 0

maxOccurs = 1

The special business calendar days that are configured.

holidays

ccHolidays

minOccurs = 0

maxOccurs = 1

The calendar business holidays that are configured.

associations

associations

minOccurs = 0

maxOccurs = 1

Applications and chat widgets that the calendar is associated with.

Other Restrictions

  • There can be a maximum 50 calendars.

  • Calendar name should be unique.

  • Day of week (businessDay) name should be unique for a calendar.

  • Maximum 3 intervals can be configured per day.

  • Interval names to be unique within a businessDay.

  • Interval time range to not overlap within a businessDay.

  • Interval end time to be greater than start time.

  • Maximum 40 Special days and 40 Holidays can be configured per calendar.

  • Special days and Holidays are optional.

  • There should not be any overlap of the dates configured for Specialdays and Holidays.

  • Create calendar does not allow older dates.

  • Allowed only for admin and supervisor.

  • Associations cannot be added or modified by using API.