...
Property | UI Field Name | Description | Specifications | Required |
---|
...
XML Response | JSON Response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | comments - CC | comments - CC | Description | User-defined; description for the calendar. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | excludeRelated - CC | excludeRelated - CC | 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 | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | exportTable - CC | exportTable - CC | n/a | Record table information. | read only | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | firstDayOfWeek - CC | firstDayOfWeek - CC | First Day Of Week | Day that is considered the start of the week. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | name - CC | name - CC | Name | Name used within the Controller to identify this calendar. | Maximum 40 alphanumerics. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | opswiseGroups - CC | opswiseGroups - CC | Member of Business Services | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Panel | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | retainSysIds - CC | retainSysIds - CC | n/a |
Note | ||
---|---|---|
| ||
In XML web services, |
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
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Name
...
Name used within the Controller to identify this Custom Day.
...
Maximum 40 alphanumerics.
...
Y
...
n/a
...
sysId of the Calendar-to-Custom Day relationship.
...
N
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
Adjustment
...
If ctype
is Relative Repeating Date (1); Adjustment for the repeating date.
Valid values:
Default is None (0).
...
N
...
Adjustment Amount
...
If adjustment
is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made.
...
Default is 1.
...
N
...
Adjustment Type
...
If adjustment
is Less (1) or Plus (2); Type of day on which to make the adjustment.
Valid values:
Default is Day (1).
...
N
...
Category
...
Category of this Local Custom Day.
Valid values:
Default is Day (1).
...
N
...
Description
...
Description of this Local Custom Day.
...
N
...
Type
...
Type of this Local Custom Day.
Valid values:
Default is Single Date (0).
...
N
...
Date
...
Specific date for this Local Custom Day
...
Format: yyyy-mm-dd.
...
Y
(if ctype
=
Single Date. )
...
datelist
...
Dates
...
Multiple specific dates for this Local Custom Day.
XML
...
JSON
...
Y
(if ctype
is List of Dates.)
...
date
...
Day
...
Day of the month.
...
Integer; Valid values: 1-31.
...
Y
(if ctype
is Absolute Repeating Date)
...
Day Of Week
...
Day of the week.
Valid values:
Default is Mon (2).
...
Y
(if ctype
is Relative Repeating Date)
...
Month
...
Month of the year.
Valid values:
Default is Jan (0).
...
Y
(if ctype
is
Relative Repeating Date
or
Absolute Repeating Date)
...
Name
...
Name of this Local Custom Day.
...
Y
...
Observed Rules
If category
is Holiday (3) and ctype
is Relative Repeating Date (1) or Absolute Repeating Date (2); Rules for when the holiday will be observed.
XML
...
JSON
...
Valid day of week values:
- Sun, Mon, Tue, Wed, Thu, Fri, Sat
...
N
...
When
...
Occurrence of this day in the month.
Valid values:
Default is 1st (1).
...
Y
(if ctype
is Relative Repeating Date)
...
n/a
...
System ID in the database for this Local Custom Day.
...
Persisted only if retainSysIds is set to true.
...
Y
(if retainSysIds
is true.)
...
Description
...
URI
...
HTTP Method
...
DELETE
...
Description
...
Deletes the specified Calendar.
...
URI Parameters
...
See Delete a Calendar: URI Parameters, below.
...
Example URI
...
- http://localhost:8080/uc/resources/calendar?calendarname=testCalendar
- http://localhost:8080/uc/resources/calendar?calendarid=f87848b00a0001037f43e7c81c8ec969
...
Authentication
...
HTTP Basic
...
Example Response
...
- Status 200 /OK
Calendar deleted successfully. - Status 404 /Not Found
A calendar with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
...
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
...
Description
...
URI
...
HTTP Method
...
GET
...
Description
...
Retrieves information on all Calendar.
...
Example URI
...
Authentication
...
HTTP Basic
...
Consumes Content-Type
...
n/a
...
Produces Content-Type
...
application/xml, application/json
...
Example Response
...
See List Calendars: Example Response, 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.
Expand |
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 | List 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 | |||||||||||
firstQuarterStart | 1st Quarter Start | To specify the start of the 1st Quarter, a day and month must be specified as shown below.
JSON
| Valid values:
| 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.
JSON
| Valid values:
| 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.
JSON
| Valid values:
| 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.
JSON
| Valid values:
| If any other Quarter is specified then this property is also required. |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | ||||||
---|---|---|---|---|---|---|---|---|---|---|
name | Name | Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y | ||||||
sysId | n/a | sysId of the Calendar-to-Custom Day relationship. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adjustment | Adjustment | If | Valid values:
Default is None (0). | N | |||||||||||
adjustmentAmount | Adjustment Amount | If | Default is 1. | N | |||||||||||
adjustmentType | Adjustment Type | If | Valid values:
Default is Day (1). | N | |||||||||||
category | Category | Category of this Local Custom Day. | Valid values:
Default is Day (1). | N | |||||||||||
comments | Description | Description of this Local Custom Day. | N | ||||||||||||
ctype | Type | Type of this Local Custom Day. | Valid values:
Default is Single Date (0). | N | |||||||||||
date | Date | Specific date for this Local Custom Day | Format: yyyy-mm-dd. | Y |
| ||||||||||
dateList | Dates | Multiple specific dates for this Local Custom Day. | XML
| Y |
| ||||||||||
day | Day | Day of the month. | Integer; Valid values: 1-31. | Y | |||||||||||
dayofweek | Day Of Week | Day of the week. | Valid values:
Default is Mon (2). | Y | |||||||||||
month | Month | Month of the year. | Valid values:
Default is Jan (0). | Y | |||||||||||
name | Name | Name of this Local Custom Day. | Y | ||||||||||||
observedRules | Observed Rules | If
| Valid day of week values:
| N | |||||||||||
relfreq | When | Occurrence of this day in the month. | Valid values:
Default is 1st (1). | Y | |||||||||||
sysId | n/a | System ID in the database for this Local Custom Day. | Persisted only if retainSysIds is set to true. | Y |
Anchor | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/calendar |
HTTP Method | DELETE |
Description | Deletes the specified Calendar. |
URI Parameters | See Delete a Calendar: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Example Response |
|
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 | ||||
---|---|---|---|---|
|
Description | |
---|---|
URI | http://host_name/uc/resources/calendar/list |
HTTP Method | GET |
Description | Retrieves information on all Calendar. |
Example URI | http://localhost:8080/uc/resources/calendar/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Calendars: Example Response, below. |
Calendar Properties | |
Custom Day Properties | |
Local Custom Day Properties |
Anchor | ||||
---|---|---|---|---|
|
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
|
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 Dates Periods for a specific Local Custom Day. |
URI Parameters | See List Local Custom Day Qualifying Dates Periods URI Parameters: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingdatesqualifyingperiods?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 DatesPeriods: Example Response, below. |
Anchor | ||
---|---|---|
|
...
|
...
|
...
Periods:
...
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 |
---|
...
Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||
---|---|---|
|
...
|
...
|
...
Custom Day Qualifying Periods: URI Parameters
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 | GETPUT | ||
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, belowModifies the Calendar specified by the |
Example URI | http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingperiods?customdayname=testLocalCustomDay&calendarname=testCalendarAuthentication | ||
HTTP Basic | Consumes Content-Type | n/aapplication/xml, application/json | |
Produces Content-Type | application/xml, application/jsonn/a | ||
Example ResponseRequest | See List Local Custom Day Qualifying PeriodsModify a Calendar: Example ResponseRequest, below. |
...
XML Response | JSON ResponseCalendar 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 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
...
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 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 | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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
...
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 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 |
---|---|---|---|---|
| Unique ID for this Calendar. | Y |
| |
| Name used within the Controller to identify this Calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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. |
...