Custom Day Web Services
Universal Controller supports the following RESTful-based web services for Custom Day operations, which are listed alphabetically on this page.
- Create a Custom Day
- Delete a Custom Day
- List Custom Day Qualifying Dates
- List Custom Day Qualifying Periods
- List Custom Days
- Modify a Custom Day
- Read a Custom Day
Formatting specifications for each web service, including details about parameter requirements, are provided.
For Local Custom Day operations, see Calendar Web Services.
You can create and modify a Custom Day only if the Custom Day Global Permitted Universal Controller system property is set to true.
Create a Custom Day
Description | |
|---|---|
URI | http://host_name/uc/resources/customday |
HTTP Method | POST |
Description | Creates a new Custom Day. |
Example URI | |
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 |
|
Create a Custom Day: Example Request
- JSON
- XML
JSON Request
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Day",
"comments": null,
"ctype": "Relative Repeating Date",
"date": null,
"dateList": [],
"day": 1,
"dayofweek": "Sun",
"holiday": false,
"month": "Sep",
"name": "special day",
"nthAmount": 8,
"nthType": "Business Day",
"observedRules": [],
"period": false,
"relfreq": "Nth",
"retainSysIds": true,
"sysId": "dae77560c0a80165006d8051753b806c"
}
XML Request
<customDay retainSysIds="true">
<adjustment>None</adjustment>
<adjustmentAmount>1</adjustmentAmount>
<adjustmentType>Day</adjustmentType>
<category>Day</category>
<comments />
<ctype>Relative Repeating Date</ctype>
<date />
<dateList />
<day>1</day>
<dayofweek>Sun</dayofweek>
<holiday>false</holiday>
<month>Sep</month>
<name>special day</name>
<nthAmount>8</nthAmount>
<nthType>Business Day</nthType>
<observedRules />
<period>false</period>
<relfreq>Nth</relfreq>
<sysId>dae77560c0a80165006d8051753b806c</sysId>
</customDay>
Custom Day: Properties
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
| Adjustment | If | Valid values:
Default is None (0). | N | |
| Adjustment Amount | If | Default is 1. | N | |
| Adjustment Type | If | 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 Custom Day. | N | ||
| Type | Type of this Custom Day. | Valid values:
Default is Single Date (0). | N | |
| Date | Specific date for this Custom Day | Format: yyyy-mm-dd. | Y |
|
| Dates | Multiple specific dates for this Custom Day. XML JSON | Y |
| |
| Day | Day of the month. | Integer; Valid values: 1-31. | Y | |
| Day Of Week | Day of the week. | Valid values:
Default is Mon (2). | Y N | |
| n/a | Universal Controller release that the record was exported from. | read only | N | |
| n/a | Record table information. | read only | N | |
| (none) | Deprecated. Indication of whether or not this Custom Day is a holiday. | Boolean; Valid values: true/false; Default is false. | N | |
| Month | Month of the year. | Valid values:
Default is Jan (0). | Y | |
| Name | Name of this Custom Day. | Y | ||
| Nth Amount | If | Y | ||
| Nth Type | If | Valid values:
Default is Day (1). | N | |
| Observed Rules | If XML JSON | Valid day of week values:
| N | |
| (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 | |
| When | Occurrence of this day in the month. | Valid values:
Default is 1st (1). | Y | |
| n/a | Specification for whether or not the Create a Custom Day web service will persist the sysId property.
info In XML web services, | Valid values: true/false (default is true). | N | |
| n/a | System ID in the database for this Custom Day. | Persisted only if | Y |
Delete a Custom Day
Description | |
|---|---|
URI | http://host_name/uc/resources/customday |
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 |
|
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 |
|
List Custom Day Qualifying Dates
Description | |
|---|---|
URI | http://host_name/uc/resources/customday/qualifyingdates |
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. |
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; |
|
List Custom Day Qualifying Dates: Example Response
- JSON
- XML
JSON Response
[
"Mon, Jan 1, 2018",
"Tue, Jan 1, 2019",
"Wed, Jan 1, 2020",
"Fri, Jan 1, 2021",
"Sat, Jan 1, 2022",
"Sun, Jan 1, 2023",
"Mon, Jan 1, 2024",
"Wed, Jan 1, 2025",
"Thu, Jan 1, 2026",
"Fri, Jan 1, 2027",
"Sat, Jan 1, 2028",
"Mon, Jan 1, 2029",
"Tue, Jan 1, 2030",
"Wed, Jan 1, 2031",
"Thu, Jan 1, 2032",
"Sat, Jan 1, 2033",
"Sun, Jan 1, 2034",
"Mon, Jan 1, 2035",
"Tue, Jan 1, 2036",
"Thu, Jan 1, 2037",
"Fri, Jan 1, 2038",
"Sat, Jan 1, 2039",
"Sun, Jan 1, 2040",
"Tue, Jan 1, 2041",
"Wed, Jan 1, 2042",
"Thu, Jan 1, 2043",
"Fri, Jan 1, 2044",
"Sun, Jan 1, 2045",
"Mon, Jan 1, 2046",
"Tue, Jan 1, 2047"
]
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>
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. |
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 |
|
List Custom Day Qualifying Periods: Example Response
- JSON
- XML
JSON Response
[
{
"startDate": "Sun, Jan 1, 2017",
"endDate": "Sat, Jan 6, 2018"
},
{
"startDate": "Sun, Jan 7, 2018",
"endDate": "Sat, Jan 5, 2019"
},
{
"startDate": "Sun, Jan 6, 2019",
"endDate": "Sat, Jan 4, 2020"
},
{
"startDate": "Sun, Jan 5, 2020",
"endDate": "Sat, Jan 2, 2021"
},
{
"startDate": "Sun, Jan 3, 2021",
"endDate": "Sat, Jan 1, 2022"
},
{
"startDate": "Sun, Jan 2, 2022",
"endDate": "Sat, Dec 31, 2022"
}
]
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>
List Custom Days
Description | |
|---|---|
URI | http://host_name/uc/resources/customday/list |
HTTP Method | GET |
Description | Retrieves information on all Custom Days. |
Example URI | |
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 |
List Custom Days: Example Response
- JSON
- XML
JSON Response
[
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Day",
"comments": null,
"ctype": "Relative Repeating Date",
"date": null,
"dateList": [],
"day": 1,
"dayofweek": "Sun",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_custom_day",
"holiday": false,
"month": "Sep",
"name": "special day",
"nthAmount": 8,
"nthType": "Business Day",
"period": false,
"relfreq": "Nth",
"retainSysIds": true,
"sysId": "dae77560c0a80165006d8051753b806c"
"version": 1
},
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Day",
"comments": null,
"ctype": "Relative Repeating Date",
"date": null,
"dateList": [],
"day": 1,
"dayofweek": "Sun",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_custom_day",
"holiday": false,
"month": "Sep",
"name": "special day",
"nthAmount": 9,
"nthType": "Business Day",
"period": false,
"relfreq": "Nth",
"retainSysIds": true,
"sysId": "abc77560c0a80165006d8051753b806c"
"version": 1
}
]
XML Response
<customDays>
<customDay exportReleaseLevel="7.2.0.0" exportTable="ops_custom_day" version="1">
<adjustment>None</adjustment>
<adjustmentAmount>1</adjustmentAmount>
<adjustmentType>Day</adjustmentType>
<category>Day</category>
<comments />
<ctype>Relative Repeating Date</ctype>
<date />
<dateList />
<day>1</day>
<dayofweek>Sun</dayofweek>
<holiday>false</holiday>
<month>Sep</month>
<name>special day</name>
<nthAmount>8</nthAmount>
<nthType>Business Day</nthType>
<period>false</period>
<relfreq>Nth</relfreq>
<sysId>dae77560c0a80165006d8051753b806c</sysId>
</customDay>
<customDay exportReleaseLevel="7.2.0.0" exportTable="ops_custom_day" version="1">
<adjustment>None</adjustment>
<adjustmentAmount>1</adjustmentAmount>
<adjustmentType>Day</adjustmentType>
<category>Day</category>
<comments />
<ctype>Relative Repeating Date</ctype>
<date />
<dateList />
<day>1</day>
<dayofweek>Sun</dayofweek>
<holiday>false</holiday>
<month>Sep</month>
<name>special day</name>
<nthAmount>9</nthAmount>
<nthType>Business Day</nthType>
<period>false</period>
<relfreq>Nth</relfreq>
<sysId>dae77560c0a80165006d8051753b806c</sysId>
</customDay>
</customDays>
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 | |
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 | |
Example Response |
|
Modify a Custom Day: Example Request
- JSON
- XML
JSON Request
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Day",
"comments": null,
"ctype": "Relative Repeating Date",
"date": null,
"dateList": [],
"day": 1,
"dayofweek": "Sun",
"holiday": false,
"month": "Sep",
"name": "special day",
"nthAmount": 8,
"nthType": "Business Day",
"period": false,
"relfreq": "Nth",
"sysId": "dae77560c0a80165006d8051753b806c"
}
XML Request
<customDay>
<adjustment>None</adjustment>
<adjustmentAmount>1</adjustmentAmount>
<adjustmentType>Day</adjustmentType>
<category>Day</category>
<comments />
<ctype>Relative Repeating Date</ctype>
<date />
<dateList />
<day>1</day>
<dayofweek>Sun</dayofweek>
<holiday>false</holiday>
<month>Sep</month>
<name>special day</name>
<nthAmount>8</nthAmount>
<nthType>Business Day</nthType>
<period>false</period>
<relfreq>Nth</relfreq>
<sysId>dae77560c0a80165006d8051753b806c</sysId>
</customDay>
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 |
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 |
|
Read a Custom Day: Example Response
- JSON
- XML
JSON Response
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Day",
"comments": null,
"ctype": "Relative Repeating Date",
"date": null,
"dateList": [],
"day": 1,
"dayofweek": "Sun",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_custom_day",
"holiday": false,
"month": "Sep",
"name": "special day",
"nthAmount": 8,
"nthType": "Business Day",
"period": false,
"relfreq": "Nth",
"retainSysIds": true,
"sysId": "dae77560c0a80165006d8051753b806c"
"version": 1
}
XML Response
<customDay exportReleaseLevel="7.2.0.0" exportTable="ops_custom_day" retainSysIds="true" version="1">
<adjustment>None</adjustment>
<adjustmentAmount>1</adjustmentAmount>
<adjustmentType>Day</adjustmentType>
<category>Day</category>
<comments />
<ctype>Relative Repeating Date</ctype>
<date />
<dateList />
<day>1</day>
<dayofweek>Sun</dayofweek>
<holiday>false</holiday>
<month>Sep</month>
<name>special day</name>
<nthAmount>8</nthAmount>
<nthType>Business Day</nthType>
<period>false</period>
<relfreq>Nth</relfreq>
<sysId>dae77560c0a80165006d8051753b806c</sysId>
</customDay>