...
Panel | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Overview
Universal Controller supports the following RESTful-based web services for Custom Day operations, which are listed alphabetically on this page.
...
Note | ||
---|---|---|
| ||
You can create and modify a Custom Day only if the Custom Day Global Permitted Universal Controller system property is set to true. |
Anchor | ||||
---|---|---|---|---|
|
Create a Custom Day
Description | |
---|---|
URI | http://host_name/uc/resources/customday |
HTTP Method | POST |
Description | Creates a new Custom Day. |
Example URI | http://localhost:8080/uc/resources/customday |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Create a Custom Day: Example Request, below. |
Custom Day Properties | See Custom Day Properties, below. |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Create a Custom Day: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Custom Day: Properties
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 Custom Day. | N | ||||||||||||
ctype | Type | Type of this Custom Day. | Valid values:
Default is Single Date (0). | N | |||||||||||
date | Date | Specific date for this Custom Day | Format: yyyy-mm-dd. | Y |
| ||||||||||
dateList | Dates | Multiple specific dates for this Custom Day.
Â
| 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 | |||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. | read only | N | |||||||||||
exportTable | n/a | Record table information. | read only | N | |||||||||||
holiday | (none) | Deprecated.  Indication of whether or not this Custom Day is a holiday. | Boolean; Valid values: true/false; Default is false. | N | |||||||||||
month | Month | Month of the year. | Valid values:
Default is Jan (0). | Y | |||||||||||
name | Name | Name of this Custom Day. | Y | ||||||||||||
nthAmount | Nth Amount | If | Y | ||||||||||||
nthType | Nth Type | If | Valid values:
Default is Day (1). | N | |||||||||||
observedRules | Observed Rules | If
Â
| Valid day of week values:
| N | |||||||||||
period | (none) | Deprecated.  Indication of whether or not this Custom Day defines a custom period of days. | Boolean; Valid values: true/false; Default is false. | N | |||||||||||
relfreq | When | Occurrence of this day in the month. | Valid values:
Default is 1st (1). | Y | |||||||||||
retainSysIds | n/a | Specification for whether or not the Create a Custom Day web service will persist the sysId property.
| Valid values: true/false (default is true). | N | |||||||||||
sysId | n/a | System ID in the database for this Custom Day. | Persisted only if retainSysIds is set to true. | Y |
...
Description | |
---|---|
URI | |
HTTP Method | DELETE |
Description | Deletes a specific Custom Day. |
URI Parameters | See Delete a Custom Day: URI Parameters, below. |
Example URI | |
Authentication | HTTP Basic |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Delete a Custom Day: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Custom Day. | Y |
| |
| Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Dates
Description | |
---|---|
URI | |
HTTP Method | GET |
Description | Retrieves information on Qualifying Dates for a specific Custom Day. |
URI Parameters | See List 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 Custom Day Qualifying Dates: Example Response, below. |
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Dates: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Custom Day. | Y |
| |
| Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y |
|
| Unique ID for this Calendar. | Y; |
| |
| Name used within the Controller to identify a Calendar. | Maximum 40 alphanumerics. | Y; |
|
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Dates: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Periods
Description | |
---|---|
URI | http://host_name/uc/resources/customday/qualifyingperiods |
HTTP Method | GET |
Description | Retrieves information on Qualifying Periods for a specific Custom Day. |
URI Parameters | See List 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 Custom Day Qualifying Periods: Example Response, below. |
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Periods: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Custom Day. | Y |
| |
| Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y |
|
| Unique ID for this Calendar. | Y |
| |
| Name used within the Controller to identify a Calendar. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
List Custom Day Qualifying Periods: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
List Custom Days
Description | |
---|---|
URI | http://host_name/uc/resources/customday/list |
HTTP Method | GET |
Description | Retrieves information on all Custom Days. |
Example URI | http://localhost:8080/uc/resources/customday/list |
Authentication | HTTP Basic |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example Response | See List Custom Days: Example Response, below. |
Custom Day Properties | See Custom Day Properties. |
Anchor | ||||
---|---|---|---|---|
|
List Custom Days: Example Response
XML Response | JSON Response | |||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Modify a Custom Day
Description | |
---|---|
URI | http://host_name/uc/resources/customday |
HTTP Method | PUT |
Description | Modifies the Custom Day specified by the |
Example URI | http://localhost:8080/uc/resources/customday |
Consumes Content-Type | application/xml, application/json |
Produces Content-Type | n/a |
Example Request | See Modify a Custom Day: Example Request, below. |
Custom Day Properties | See Custom Day Properties. |
Example Response |
|
Anchor | ||||
---|---|---|---|---|
|
Modify a Custom Day: Example Request
XML Request | JSON Request | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Read a Custom Day
Description | |
---|---|
URI | http://host_name/uc/resources/customday |
HTTP Method | GET |
Description | Retrieves information on a specific Custom Day. |
URI Parameters | See Read a Custom Day: URI Parameters, below. |
Consumes Content-Type | n/a |
Produces Content-Type | application/xml, application/json |
Example URI | |
Example Response |
|
Custom Day Properties | See Custom Day Properties. |
Anchor | ||||
---|---|---|---|---|
|
Read a Custom Day: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| Unique ID for this Custom Day. | Y |
| |
| Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y |
|
Anchor | ||||
---|---|---|---|---|
|
Read a Custom Day: Example Response
XML Response | JSON Response | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
...