...
Universal Controller supports the following RESTful-based web services for Calendar operations, which are listed alphabetically on this page.
- Add an Existing Custom Day to a Calendar
- Create a Calendar
- Delete a Calendar
- List Calendars
- List Local Custom Day Qualifying Dates
- List Local Custom Day Qualifying Periods
- Modify a Calendar
- Read a Calendar
- Read All Custom Days of a Calendar
- Remove a Custom Day from a Calendar63543354
- 63543354
- 63543354
- 63543354
- 63543354
- 63543354
- 63543354
- 63543354
- 63543354
- 63543354
Formatting specifications for each web service, including details about parameter requirements, are provided.
...
Description | |
---|---|
URI | http://host_name/uc/resources/calendar/customdays |
HTTP Method | POST |
Description | Adds the specified Custom Day to the specified Calendar. |
URI Parameters | See Add an Existing Custom Day to a Calendar: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/calendar/customdays?calendarname=test&customdayid=sfsdffsf123456dfhkjhk |
Example Response |
|
...
Description | |
---|---|
URI | |
HTTP Method | POST |
Description | Creates a new Calendar. |
Example URI | http://localhost:8080/uc/resources/calendar |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Calendar: Example Request, below. |
Calendar Properties | |
Custom Day Properties | |
Local Custom Day Properties | |
Example Response |
|
...
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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 | List of Business Services:
| N | ||||||||||||
retainSysIds | n/a |
| 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. |
...
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 |
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | ||||
---|---|---|---|---|
|
...
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 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
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 | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
...
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 | ||||
---|---|---|---|---|
|
...
Anchor | ||||
---|---|---|---|---|
|
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | http://host_name/uc/resources/calendar/customdays |
HTTP Method | DELETE |
Description | Removes the specified Custom Day from a specific Calendar. |
URI Parameters | See Remove a Custom Day from a Calendar: URI Parameters, below. |
Example URI | http://localhost:8080/uc/resources/calendar/customdays?calendarname=ExampleCalendar&customdayid=977e7539af6e450d924a92e1ad39a256 |
Authentication | HTTP Basic |
Example Response |
|
...