...
Note | ||
---|---|---|
| ||
You can create and modify a Calendar that contains one or more global Creating Custom Days only if the Properties#Custom Custom Day Global Permitted Universal Controller system property is set to true. |
...
Description | |
---|---|
URI | http://host_name/uc/resources/calendar/customdays |
HTTP Method | POST |
Description | Adds the specified Creating Custom DaysDay to the specified Creating Calendars 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 Creating Calendars 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 | Specification for whether or not the Create a Calendar web service will persist the sysId - CC 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. |
...
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 |
...
Description | |
---|---|
URI | http://host_name/uc/resources/calendar |
HTTP Method | DELETE |
Description | Deletes the specified Creating Calendars 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 Creating Calendars 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 |
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on Qualifying Dates for a specific Creating Custom Days#Creating Local Custom DaysDay. |
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 Creating Custom Days#Creating Local Custom DaysDay. |
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 Creating Calendars 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 |
|
...
Modify a Calendar: Example Request
The excludeRelated - CC property is included in the XML as an attribute.
Â
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on a specific Creating Calendars 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 |
...
Read a Calendar: Example Response
The retainSysIds - CC
and version - CC
properties are specified as attributes in XML.
The exportReleaseLevel - CC
and exportTable
- CC properties are specified as attributes in XML.
...
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on all Creating Custom Days of a specific Creating Calendars 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. |
...
Read All Custom Days of a Calendar: Example Response
The exportReleaseLevel - RACD
and exportTable
- RACD 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 Creating Custom DaysDay from a specific Creating Calendars 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 |
|
...