...
Property | UI Field Name | Description | Specifications | Required | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | N | |||||||||||
comments | Description | User-defined; description for the calendar. | N | ||||||||||||
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 | |||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
firstDayOfWeek | First Day Of Week | Day that is considered the start of the week. | Valid values: | N | |||||||||||
name | Name | Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y | |||||||||||
opswiseGroups | Member of Business Services | N | |||||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Calendar web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||
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 | ||||||||
---|---|---|---|---|---|---|---|---|---|
|
...
Description
...
URI
...
...
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
...
title | XML 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>
...
title | JSON Response |
---|
[
"Mon, Jan 1, 2018",
"Tue, Jan 2, 2019",
"Wed, Jan 1, 2020",
"Fri, Jan 1, 2021"
]
...
Description
...
URI
...
...
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
...
title | XML 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>
...
title | JSON Response |
---|
[
{
"startDate": "Sun, Jan 1, 2017",
"endDate": "Sat, Jan 6, 2018"
},
{
"startDate": "Sun, Jan 7, 2018",
"endDate": "Sat, Jan 5, 2019"
}
]
...
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
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 | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name used within the Controller to identify this Local Custom Day. | Maximum 40 alphanumerics. | Y | |
| Unique ID for this calendar. | Y |
| |
| Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
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 | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Name used within the Controller to identify this Local Custom Day. | Maximum 40 alphanumerics. | Y | |
| Unique ID for this calendar. | Y |
| |
| Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
HTTP Method | PUT |
Description | Modifies the Calendar specified by the |
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 | |
Custom Day Properties | |
Local Custom Day Properties | |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
The excludeRelated property is included in the XML as an attribute.
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
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 | |
Custom Day Properties | |
Local Custom Day Properties |
Anchor | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With | |||
---|---|---|---|---|---|---|---|
Name used within the Controller to identify this Local Custom Day. | Maximum 40 alphanumerics. | Y |
| Unique ID for this calendarCalendar. | Y |
| |
| Name used within the Controller to identify this calendarCalendar. | Maximum 40 alphanumerics. | Y |
|
Anchor |
---|
...
|
...
|
...
Read a Calendar
...
Description
...
URI
...
...
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
...
title | XML 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>
...
title | JSON 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 Method
...
GET
...
Description
...
Retrieves information on a specific Calendar.
...
URI Parameters
...
See Read a Calendar: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/calendar?calendarname=testCalendar
- http://localhost:8080/uc/resources/calendar?calendarid=d26265a2c4f345359d9b356f18a462c1
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
- Status 200 /OK
(See Read a Calendar: Example Response, below.) - Status 404 /Not Found
A calendar with id "d26265a2c4f345359d9b356f18a462c1" does not exist.
...
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.
...
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
...
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>
...
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 }
...
Description
...
URI
...
...
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
...
- Status 200 /OK
(See Red All Custom Days of a Calendar: Example Response, below.) - Status 404 /Not Found
A calendar with id "d26265a2c4f345359d9b356f18a462c1" does not exist.
...
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
...
title | XML Response |
---|
...
: 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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | |
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 | ||||
---|---|---|---|---|
|
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Calendar. | Y |
| |
| Name used within the Controller to identify this Calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | ||||||
---|---|---|---|---|---|---|---|---|
adjustment | Adjustment | Adjustment for the repeating date. | ||||||
adjustmentAmount | Adjustment Amount | Amount (number of days) of the adjustment to be made. | ||||||
adjustmentType | Adjustment Type | Type of day on which to make the adjustment. | ||||||
category | Category | Category of this Local Custom Day. | ||||||
comments | Description | Description of this Custom Day. | ||||||
ctype | Type | Type of this Custom Day. | ||||||
date | Date | Specific date for this Custom Day | ||||||
dateList | Dates | Multiple specific dates for this Custom Day. | ||||||
day | Day | Day of the month. | ||||||
dayofweek | Day Of Week | Day of the week. | ||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | ||||||
exportTable | n/a | Record table information. | ||||||
holiday | Holiday | Deprecated. Indication of whether or not this Custom Day is a holiday. | ||||||
month | Month | Month of the year. | ||||||
name | Name | Name of this Custom Day. | ||||||
period | Period | Deprecated. Indication of whether or not this Custom Day defines a custom period of days. | ||||||
relfreq | When | Occurrence of this day in the month. | ||||||
sysId | n/a | System ID in the database for this Custom Day. |
...