Versions Compared

Old Version 5

changes.mady.by.user Former user

Saved on

compared with

New Version 6

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 4

...

exportTable

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 - CCexportReleaseLevel - CC
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN
Anchor
exportTable - CCexportTable - CCn/aRecord table information.read onlyN

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
titleNote

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

[
  {
  "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 } ]
Expand
titleXML 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
titleJSON Response

...

Description

...

URI

...

http://host_name/uc/resources/calendar/localcustomdays/qualifyingdates

...

HTTP Method

...

GET

...

Description

...

Retrieves information on Qualifying Dates for a specific Local Custom Day.

...

URI Parameters

...

See List Local Custom Day Qualifying Dates URI Parameters: URI Parameters, below.

...

Example URI

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

See List Local Custom Day Qualifying Dates: Example Response, below.

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

customdayname

...

Name used within the Controller to identify this Local Custom Day.

...

Maximum 40 alphanumerics.

...

Y

...

calendarid

...

Unique ID for this calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

XML Response

...

JSON Response

...

titleXML Response
<qualifyingDates>
	<qualifyingDate>Mon, Jan 1, 2018</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2019</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2020</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2021</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2022</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2023</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2024</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2025</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2026</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2027</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2028</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2029</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2030</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2031</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2032</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2033</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2034</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2035</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2036</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2037</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2038</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2039</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2040</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2041</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2042</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2043</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2044</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2045</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2046</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2047</qualifyingDate>
</qualifyingDates>

...

titleJSON Response
[
    "Mon, Jan 1, 2018",
    "Tue, Jan 2, 2019",
    "Wed, Jan 1, 2020",
    "Fri, Jan 1, 2021"
]

...

Description

...

URI

...

http://host_name/uc/resources/calendar/localcustomdays/qualifyingperiods

...

HTTP Method

...

GET

...

Description

...

Retrieves information on Qualifying Periods for a specific Local Custom Day.

...

URI Parameters

...

See List Local Custom Day Qualifying Periods URI Parameters: URI Parameters, below.

...

Example URI

...

Authentication

...

HTTP Basic

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

See List Local Custom Day Qualifying Periods: Example Response, below.

...

XML Response

...

JSON Response

...

titleXML Response
<qualifyingPeriods>
    <qualifyingPeriod>
        <startDate>Sun, Jan 1, 2017</startDate>
        <endDate>Sat, Jan 6, 2018</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 7, 2018</startDate>
        <endDate>Sat, Jan 5, 2019</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 6, 2019</startDate>
        <endDate>Sat, Jan 4, 2020</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 5, 2020</startDate>
        <endDate>Sat, Jan 2, 2021</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 3, 2021</startDate>
        <endDate>Sat, Jan 1, 2022</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 2, 2022</startDate>
        <endDate>Sat, Dec 31, 2022</endDate>
    </qualifyingPeriod>
</qualifyingPeriods>

...

titleJSON Response
[
  {
  "startDate": "Sun, Jan 1, 2017",
  "endDate": "Sat, Jan 6, 2018"
  },
  {
  "startDate": "Sun, Jan 7, 2018",
  "endDate": "Sat, Jan 5, 2019"
  }
]

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

customdayname

...

Name used within the Controller to identify this Local Custom Day.

...

Maximum 40 alphanumerics.

...

Y

...

calendarid

...

Unique ID for this calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

Description

...

URI

...

http://host_name/uc/resources/calendar

...

HTTP Method

...

PUT

...

Description

...

Modifies the Calendar specified by the sysId.
 
To modify Calendar properties without modifying related records, see the excludeRelated property.

...

Example URI

...

Consumes Content-Type

...

application/xml, application/json

...

Produces Content-Type

...

n/a

...

Example Request

...

See Modify a Calendar: Example Request, below.

...

Calendar Properties

...

See Create a Calendar: Calendar Properties.

...

Custom Day Properties

...

See Create a Calendar: Custom Day Properties.

...

Local Custom Day Properties

...

See Create a Calendar: Local Custom Day Properties.

...

Example Response

...

  • Status 200 /OK
    Successfully updated the calendar with sysId <sysId> to version <version>.

...

The excludeRelated property is included in the XML as an attribute.
 

...

XML Request

...

JSON Request

...

titleXML Request
<calendar>
       <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>

...

titleJSON Request
{
  "businessDays": {
     "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Flag Day",
    "sysId": "daf16d8fc0a801650040c4d54b2432fb"
    }
  ],
  "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": [],
  "sysId": "da24b953c0a8016501fbcb18464d8328"
}

...

Description

...

URI

...

http://host_name/uc/resources/calendar

...

HTTP Method

...

GET

...

Description

...

Retrieves information on a specific Calendar.

...

URI Parameters

...

See Read a Calendar: URI Parameters, below.

...

Example URI

...

...

Consumes Content-Type

...

n/a

...

Produces Content-Type

...

application/xml, application/json

...

Example Response

...

...

Calendar Properties

...

See Create a Calendar: Calendar Properties.

...

Custom Day Properties

...

See Create a Calendar: Custom Day Properties.

...

Local Custom Day Properties

...

See Create a Calendar: Local Custom Day Properties.

...

 <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
titleJSON 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
List Local Custom Day Qualifying Dates
List Local Custom Day Qualifying Dates
List Local Custom Day Qualifying Dates


Description

URI

http://host_name/uc/resources/calendar/localcustomdays/qualifyingdates

HTTP Method

GET

Description

Retrieves information on Qualifying Dates for a specific Local Custom Day.

URI Parameters

See List Local Custom Day Qualifying Dates URI Parameters: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingdates?customdayname=testLocalCustomDay&calendarname=testCalendar

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Local Custom Day Qualifying Dates: Example Response, below.

Anchor
List Local Custom Day Qualifying Dates URI Parameters
List Local Custom Day Qualifying Dates URI Parameters
List Local Custom Day Qualifying Dates: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

customdayname

Name used within the Controller to identify this Local Custom Day.

Maximum 40 alphanumerics.

Y


calendarid

Unique ID for this calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor
List Local Custom Day Qualifying Dates Example Response
List Local Custom Day Qualifying Dates Example Response
List Local Custom Day Qualifying Dates: Example Response

XML Response

JSON Response

Expand
titleXML Response


<qualifyingDates>
	<qualifyingDate>Mon, Jan 1, 2018</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2019</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2020</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2021</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2022</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2023</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2024</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2025</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2026</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2027</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2028</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2029</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2030</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2031</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2032</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2033</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2034</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2035</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2036</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2037</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2038</qualifyingDate>
	<qualifyingDate>Sat, Jan 1, 2039</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2040</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2041</qualifyingDate>
	<qualifyingDate>Wed, Jan 1, 2042</qualifyingDate>
	<qualifyingDate>Thu, Jan 1, 2043</qualifyingDate>
	<qualifyingDate>Fri, Jan 1, 2044</qualifyingDate>
	<qualifyingDate>Sun, Jan 1, 2045</qualifyingDate>
	<qualifyingDate>Mon, Jan 1, 2046</qualifyingDate>
	<qualifyingDate>Tue, Jan 1, 2047</qualifyingDate>
</qualifyingDates>


Expand
titleJSON Response


[
    "Mon, Jan 1, 2018",
    "Tue, Jan 2, 2019",
    "Wed, Jan 1, 2020",
    "Fri, Jan 1, 2021"
]


Anchor
List Loca Custom Day Qualifying Periods
List Loca Custom Day Qualifying Periods
List Local Custom Day Qualifying Periods


Description

URI

http://host_name/uc/resources/calendar/localcustomdays/qualifyingperiods

HTTP Method

GET

Description

Retrieves information on Qualifying Periods for a specific Local Custom Day.

URI Parameters

See List Local Custom Day Qualifying Periods URI Parameters: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingperiods?customdayname=testLocalCustomDay&calendarname=testCalendar

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Local Custom Day Qualifying Periods: Example Response, below.

Anchor
List Local Custom Day Qualifying Periods Example Response
List Local Custom Day Qualifying Periods Example Response
List Local Custom Day Qualifying Periods: Example Response

XML Response

JSON Response

Expand
titleXML Response


<qualifyingPeriods>
    <qualifyingPeriod>
        <startDate>Sun, Jan 1, 2017</startDate>
        <endDate>Sat, Jan 6, 2018</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 7, 2018</startDate>
        <endDate>Sat, Jan 5, 2019</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 6, 2019</startDate>
        <endDate>Sat, Jan 4, 2020</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 5, 2020</startDate>
        <endDate>Sat, Jan 2, 2021</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 3, 2021</startDate>
        <endDate>Sat, Jan 1, 2022</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 2, 2022</startDate>
        <endDate>Sat, Dec 31, 2022</endDate>
    </qualifyingPeriod>
</qualifyingPeriods>


Expand
titleJSON Response


[
  {
  "startDate": "Sun, Jan 1, 2017",
  "endDate": "Sat, Jan 6, 2018"
  },
  {
  "startDate": "Sun, Jan 7, 2018",
  "endDate": "Sat, Jan 5, 2019"
  }
]


Anchor
List Local Custom Day Qualifying Periods URI Parameters
List Local Custom Day Qualifying Periods URI Parameters
List Custom Day Qualifying Periods: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

customdayname

Name used within the Controller to identify this Local Custom Day.

Maximum 40 alphanumerics.

Y


calendarid

Unique ID for this Calendarcalendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this Calendarcalendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor

...

Modify a Calendar

...

...

Modify a Calendar

...

...

Modify a Calendar

...

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

...

titleXML Response

...


Description

URI

http://host_name/uc/resources/calendar

HTTP Method

PUT

Description

Modifies the Calendar specified by the sysId.
 
To modify Calendar properties without modifying related records, see the excludeRelated property.

Example URI

http://localhost:8080/uc/resources/calendar

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Calendar: Example Request, below.

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Example Response

  • Status 200 /OK
    Successfully updated the calendar with sysId <sysId> to version <version>.

Anchor
Modify a Calendar Example Request
Modify a Calendar Example Request
Modify a Calendar: Example Request

The excludeRelated property is included in the XML as an attribute.
 

XML Request

JSON Request

{
  "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 }
Expand
titleXML Request


<calendar>
       <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>customDay>
<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
titleJSON Response

...

Description

...

URI

...

http://host_name/uc/resources/calendar/customdays

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Custom Days of a specific Calendar.

...

URI Parameters

...

See Read All Custom Days of a Calendar: URI Parameters, below.

...

Example URI

...

Consumes Content-Type

...

application/xml, application/json

...

Produces Content-Type

...

n/a

...

Example Response

...

...

Response Properties

...

See Read All Custom Days of a Calendar: Response Properties, below.

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

calendarid

...

Unique ID for this Calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this Calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

XML Response

JSON Response

Expand
titleXML Response
<customDays>
      <customDay> exportReleaseLevel="7.2.0.0" exportTable="ops_custome_day" <adjustment>None</adjustment> <adjustmentAmount>1</adjustmentAmount> <adjustmentType>Day</adjustmentType> <category>Holiday</category> <comments>New Year's Day - Jan 1st</comments> <ctype>Absolute Repeating Date</ctype> <date /> <dateList /> <day>1</day> <dayofweek>Sun</dayofweek> <holiday>true</holiday> <month>Jan</month> <name>uc - New Year's Day</name> <period>false</period> <relfreq>1st</relfreq> <sysId>dae77560c0a80165006d8051753b806c</sysId> </customDay> <customDay> exportReleaseLevel="7.2.0.0" exportTable="ops_custome_day" <adjustment>None</adjustment> <adjustmentAmount>1</adjustmentAmount> <adjustmentType>Day</adjustmentType> <category>Holiday</category> <comments>New Year's Day - Jan 1st</comments> <ctype>Absolute Repeating Date</ctype> <date /> <dateList /> <day>1</day> <dayofweek>Sun</dayofweek> <holiday>true</holiday> <month>Jan</month>             <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
titleJSON Request


{
  "businessDays": {
     "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Flag Day",
    "sysId": "daf16d8fc0a801650040c4d54b2432fb"
    }
  ],
  "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": [],
  "sysId": "da24b953c0a8016501fbcb18464d8328"
}

Anchor
Read a Calendar
Read a Calendar
Read a Calendar


Description

URI

http://host_name/uc/resources/calendar

HTTP Method

GET

Description

Retrieves information on a specific Calendar.

URI Parameters

See Read a Calendar: URI Parameters, below.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Anchor
Read a Calendar URI Parameters
Read a Calendar URI Parameters
Read a Calendar: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

calendarid

Unique ID for this Calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this Calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

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

XML Response

JSON Response

Expand
titleXML 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
titleJSON 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
}

Anchor
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar


Description

URI

http://host_name/uc/resources/calendar/customdays

HTTP Method

GET

Description

Retrieves information on all Custom Days of a specific Calendar.

URI Parameters

See Read All Custom Days of a Calendar: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/customdays?calendarname=test

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Response

Response Properties

See Read All Custom Days of a Calendar: Response Properties, below.

Anchor
Read All Custom Days of a Calendar URI Parameters
Read All Custom Days of a Calendar URI Parameters
Read All Custom Days of a Calendar: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

calendarid

Unique ID for this Calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this Calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor
Read All Custom Days of a Calendar Example Response
Read All Custom Days of a Calendar Example Response
Read All Custom Days of a Calendar: Example Response

XML Response

JSON Response

Expand
titleXML Response


<customDays>
      <customDay>
            <adjustment>None</adjustment>
            <adjustmentAmount>1</adjustmentAmount>
            <adjustmentType>Day</adjustmentType>
            <category>Holiday</category>
            <comments>New Year's Day - Jan 1st</comments>
            <ctype>Absolute Repeating Date</ctype>
            <date />
            <dateList />
            <day>1</day>
            <dayofweek>Sun</dayofweek>
            <holiday>true</holiday>
            <month>Jan</month>
            <name>uc - New Year's Day</name>
            <period>false</period>
            <relfreq>1st</relfreq>
            <sysId>dae77560c0a80165006d8051753b806c</sysId>
      </customDay>
      <customDay>
            <adjustment>None</adjustment>
            <adjustmentAmount>1</adjustmentAmount>
            <adjustmentType>Day</adjustmentType>
            <category>Holiday</category>
            <comments>New Year's Day - Jan 1st</comments>
            <ctype>Absolute Repeating Date</ctype>
            <date />
            <dateList />
            <day>1</day>
            <dayofweek>Sun</dayofweek>
            <holiday>true</holiday>
            <month>Jan</month>
            <name>uc - New Year's Day</name>
            <period>false</period>
            <relfreq>1st</relfreq>
            <sysId>dae77560c0a80165006d8051753b806c</sysId>
      </customDay>
</customDays>


Expand
titleJSON Response


[
  {
  "adjustment": "None",
  "adjustmentAmount": 1,
  "adjustmentType": "Day",
  "category": "Holiday",
  "comments": "New Year's Day - Jan 1st",
  "ctype": "Absolute Repeating Date",
  "date: null,
  "dateList: [ ],
  "day": 1,
  "dayofweek": "Sun",
 
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_custome_day", "holiday": true,
  "month": "Jan",
  "name": "uc - New Year's Day",
  "period": false,
  "relfreq": "1st",
  "sysId": "dae77560c0a80165006d8051753b806c"
  },
  {
 { "adjustment": "None",
  "adjustmentAmount": 1,
  "adjustmentType": "Day",
  "category"": Holiday",
  "comments": "New Year's Day - Jan 1st",
  "ctype"": Absolute Repeating Date",
  "date : null,
  "dateList : [],
  "day": 1,
  "dayofweek": "Sun",
"exportReleaseLevel":
"7.2.0.0",
"exportTable": "ops_custome_day", "holiday": true,
  "month": "Jan",
  "name": "uc - New Year's Day",
  "period": false",
  "relfreq": "1st",
  "sysId": "dae77560c0a80165006d8051753b806c
  }
]


Anchor
Read All Custom Days of a Calendar Properties
Read All Custom Days of a Calendar Properties
Read All Custom Days of a Calendar: Properties

exportReleaseLevelexportTable

Property

UI Field Name

Description

Anchor
adjustment - RACD
adjustment - RACD
adjustment

Adjustment

Adjustment for the repeating date.

Anchor
adjustmentAmount - RACD
adjustmentAmount - RACD
adjustmentAmount

Adjustment Amount

Amount (number of days) of the adjustment to be made.

Anchor
adjustmentType - RACD
adjustmentType - RACD
adjustmentType

Adjustment Type

Type of day on which to make the adjustment.

Anchor
category - RACD
category - RACD
category

Category

Category of this Local Custom Day.

Anchor
comments - RACD
comments - RACD
comments

Description

Description of this Custom Day.

Anchor
ctype - RACD
ctype - RACD
ctype

Type

Type of this Custom Day.

Anchor
date - RACD
date - RACD
date

Date

Specific date for this Custom Day

Anchor
dateList - RACD
dateList - RACD
dateList

Dates

Multiple specific dates for this Custom Day.

Anchor
day - RACD
day - RACD
day

Day

Day of the month.

Anchor
dayofweek - RACD
dayofweek - RACD
dayofweek

Day Of Week

Day of the week.

Anchor
exportReleaseLevel - RACDexportReleaseLevel - RACDn/aUniversal Controller release that the record was exported from.
Anchor
exportTable - RACDexportTable - RACDn/aRecord table information

.

Anchor
holiday - RACD
holiday - RACD
holiday

Holiday

Deprecated.   Indication of whether or not this Custom Day is a holiday.

Anchor
month - RACD
month - RACD
month

Month

Month of the year.

Anchor
name - RACD
name - RACD
name

Name

Name of this Custom Day.

Anchor
period - RACD
period - RACD
period

Period

Deprecated.   Indication of whether or not this Custom Day defines a custom period of days.

Anchor
relfreq - RACD
relfreq - RACD
relfreq

When

Occurrence of this day in the month.

Anchor
sysId - RACD
sysId - RACD
sysId

n/a

System ID in the database for this Custom Day.

...