Page Comparison

...

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

...

XML Response

JSON Response

Expand

title	XML Response

<calendars>
    <calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="6">
        <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
        <comments>Default System Calendar</comments>
        <customDays>
            <customDay>
                <name>uc - Memorial Day</name>
                <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>
            </customDay>
            <customDay>
                <name>uc - Thanksgiving Day USA</name>
                <sysId>b355ca6ea2c94aaa9a8895d496396e57</sysId>
            </customDay>
        </customDays>
        <firstDayOfWeek>Sunday</firstDayOfWeek>
        <localCustomDays>
              <localCustomDay>
                     <adjustment>None</adjustment>
                     <adjustmentAmount>1</adjustmentAmount>
                     <adjustmentType>Day</adjustmentType>
                     <category>Holiday</category>
                     <comments/>
                     <ctype>Single Date</ctype>
                     <date>2017-08-23</date>
                     <dateList />
                     <day>1</day>
                     <dayofweek>Sun</dayofweek>
                     <month>Jan</month>
                     <name>local custom day</name>
                     <relfreq>1st</relfreq>
                     <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
        </localCustomDays>
        <firstDayOfWeek>Sunday</firstDayOfWeek>
        <name>System Default</name>
        <opswiseGroups />
        <sysId>77171434c0a801c9016d5b2b5d17ddee</sysId>
    </calendar>
    <calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="2"> 
        <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
        <comments>American Calendar</comments>
        <customDays />
        <firstDayOfWeek>Sunday</firstDayOfWeek>
        <localCustomDays>
              <localCustomDay>
                     <adjustment>None</adjustment>
                     <adjustmentAmount>1</adjustmentAmount>
                     <adjustmentType>Day</adjustmentType>
                     <category>Holiday</category>
                     <comments/>
                     <ctype>Single Date</ctype>
                     <date>2017-08-23</date>
                     <dateList/>
                     <day>1</day>
                     <dayofweek>Sun</dayofweek>
                     <month>Jan</month>
                     <name>local custom day</name>
                     <relfreq>1st</relfreq>
                     <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
        </localCustomDays>
        <name>uc - American Calendar</name>
        <opswiseGroups/>
        <sysId>da24b953c0a8016501fbcb18464d8328</sysId>
    </calendar>
</calendars>

Expand

title	JSON Response

[
  {
  "businessDays": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "Default System Calendar",
  "customDays": [
    {
    "name": "uc - Memorial Day",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Thanksgiving Day USA",
    "sysId": "b355ca6ea2c94aaa9a8895d496396e57"
    }
  ],
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_calendar",
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
     {
     "adjustment": "None",
     "adjustmentAmount": 1,
     "adjustmentType": "Day",
     "category": "Holiday",
     "comments": null,
     "ctype": "Single Date",
     "date": "2017-08-23",
     "dateList": "
     "day": 1,
     "dayofweek": "Sun",
     "month": "Jan",
     "name": "local custom day",
     "relfreq": "1st",
     "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
     }
  ],
  "name": "System Default",
  "opswiseGroups: [],
  "sysId": "77171434c0a801c9016d5b2b5d17ddee",
  "version": 6
  },
  {
  "businessDays": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [],
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_calendar",
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
    {
    "adjustment": "None",
    "adjustmentAmount": 1,
    "adjustmentType": "Day",
    "category": "Holiday",
    "comments": null,
    "ctype": "Single Date",
    "date": "2017-08-23",
    "dateList": null,
    "day": 1,
    "dayofweek": "Sun",
    "month": "Jan",
    "name": "local custom day",
    "relfreq": "1st",
    "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
    }
  ],
  "name": "uc - American Calendar",
  "opswiseGroups": [],
  "sysId": "da24b953c0a8016501fbcb18464d8328",
  "version": 2 
  }
]

...

Anchor
Read a Calendar Example Response
Read a Calendar Example Response
Read a Calendar: Example Response

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

XML Response

JSON Response

Expand

title	XML Response

<calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" retainSysIds="true" version="1">
       <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
       <customDays>
              <customDay>
                     <name>uc - Christmas</name>
                     <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>
              </customDay>
              <customDay>
                     <name>uc - Flag Day</name>
                     <sysId>daf16d8fc0a801650040c4d54b2432fb</sysId>
              </customDay>
       </customDays>
       <comments>American Calendar</comments>
       <firstDayOfWeek>Sunday</firstDayOfWeek>
       <localCustomDays>
              <localCustomDay>
                     <adjustment>None</adjustment>
                     <adjustmentAmount>1</adjustmentAmount>
                     <adjustmentType>Day</adjustmentType>
                     <category>Holiday</category>
                     <comments/>
                     <ctype>Single Date</ctype>
                     <date>2017-08-23</date>
                     <dateList/>
                     <day>1</day>
                     <dayofweek>Sun</dayofweek>
                     <month>Jan</month>
                     <name>local custom day</name>
                     <relfreq>1st</relfreq>
                     <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
       </localCustomDays>
       <name>uc - American Calendar</name>
       <opswiseGroups />
       <sysId>da24b953c0a8016501fbcb18464d8328</sysId>
</calendar>

Expand

title	JSON Response

{
  "businessDays": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Flag Day",
    "sysId": "daf16d8fc0a801650040c4d54b2432fb"
    }
  ],
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_calendar",
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
    {
    "adjustment": "None",
    "adjustmentAmount": 1,
    "adjustmentType": "Day",
    "category": "Holiday",
    "comments": null,
    "ctype": "Single Date",
    "date": "2017-08-23",
    "dateList": [],
    "day": 1,
    "dayofweek": "Sun",
    "month": "Jan",
    "name": "local custom day",
    "relfreq": "1st",
    "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
    }
  ],
  "name": "uc - American Calendar",
  "opswiseGroups": [],
  "retainSysIds": true,
  "sysId": "da24b953c0a8016501fbcb18464d8328",
  "version": 1
}

...

Versions Compared

Old Version 6

New Version 7

Key

Anchor
Read a Calendar Example Response
Read a Calendar Example Response
Read a Calendar: Example Response

Page Comparison

Versions Compared

Old Version 6

New Version 7

Key

AnchorRead a Calendar Example ResponseRead a Calendar Example ResponseRead a Calendar: Example Response

Anchor
Read a Calendar Example Response
Read a Calendar Example Response
Read a Calendar: Example Response