Page Comparison

...

Universal Controller supports the following RESTful-based web services for Calendar operations, which are listed alphabetically on this page.

Calendar Web Services#Add Add an Existing Custom Day to a CalendarCalendar Web Services#Create
Create a Calendar
Calendar Web Services#Delete Delete a CalendarCalendar Web Services#List
List Calendars
Calendar Web Services#List List Local Custom Day Qualifying DatesCalendar Web Services#List
List Local Custom Day Qualifying Periods
Calendar Web Services#Modify Modify a CalendarCalendar Web Services#Read
Read a Calendar
Calendar Web Services#Read Read All Custom Days of a Calendar
Calendar Web Services#Remove Remove a Custom Day from a Calendar

Formatting specifications for each web service, including details about parameter requirements, are provided.

...

Property

UI Field Name

Description

Specifications

Required

Anchor

	businessDays - CC
	businessDays - CC

businessDays

Business Days

Comma-separated list of days.

Valid values:

Optional: useDefaultIfBlank attribute. Boolean; Valid values: true/false.

The Read a Calendar web service will return useDefaultIfBlank only if businessDays is empty; useDefaultIfBlank will be set to false.

N

Anchor

	comments - CC
	comments - CC

comments

Description

User-defined; description for the calendar.

N

Anchor

	excludeRelated - CC
	excludeRelated - CC

excludeRelated

n/a

Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request.

Valid values: true/false (default is false).

N

Anchor

	exportReleaseLevel - CC
	exportReleaseLevel - CC

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - CC
	exportTable - CC

exportTable

n/a

Record table information.

read only

N

Anchor

	firstDayOfWeek - CC
	firstDayOfWeek - CC

firstDayOfWeek

First Day Of Week

Day that is considered the start of the week.

Valid values:

N

Anchor

	name - CC
	name - CC

name

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor

	opswiseGroups - CC
	opswiseGroups - CC

opswiseGroups

Member of Business Services

List of Business Services:

XML

Panel

JSON

Panel

N

Anchor

	retainSysIds - CC
	retainSysIds - CC

retainSysIds

n/a

Specification for whether or not the Create a Calendar web service will persist the sysId property.

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <calendar> element.

Valid values: true/false (default is true).

N

Anchor

	sysId - CC
	sysId - CC

sysId

n/a

System ID field in the database for this Calendar record.

Persisted only if retainSysIds is set to true.

N

firstQuarterStart

1st Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <firstQuarterStart>
        <day>15</day>
        <month>01</month>
    </firstQuarterStart>

JSON

    "firstQuarterStart": {
        "day": "15",
        "month": "Jan"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

secondQuarterStart

2nd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <secondQuarterStart>
        <day>14</day>
        <month>Apr</month>
    </secondQuarterStart>

JSON

   "secondQuarterStart": {
        "day": "14",
        "month": "Apr"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

thirdQuarterStart

3rd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <thirdQuarterStart>
        <day>16</day>
        <month>Jul</month>
    </thirdQuarterStart>

JSON

   "thirdQuarterStart": {
        "day": "16",
        "month": "Jul"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

fourthQuarterStart

4th Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <fourthQuarterStart>
        <day>13</day>
        <month>10</month>
    </fourthQuarterStart>

JSON

    "fourthQuarterStart": {
        "day": "13",
        "month": "Oct"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties

...

Versions Compared

Old Version 1

New Version 2

Key

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

AnchorCreate a Calendar Custom Day PropertiesCreate a Calendar Custom Day PropertiesCreate a Calendar: Custom Day Properties

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties