Custom Day Web Services

Overview

Universal Controller supports the following RESTful-based web services for Custom Day operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.

For Local Custom Day operations, see Calendar Web Services.


Note

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

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

  • Status 200 /OK
    Successfully created the custom day with sysId <sysId>.

Create a Custom Day: Example Request

XML Request

JSON Request

 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>
 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"
}

Custom Day: Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

adjustment

Adjustment

If ctype is Relative Repeating Date (1); Adjustment for the repeating date.

Valid values:

  • As String = None, As Value = 0
  • As String = Less, As Value = 1
  • As String = Plus, As Value = 2

Default is None (0).

N


adjustmentAmount

Adjustment Amount

If adjustment is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made.

Default is 1.

N


adjustmentType

Adjustment Type

If adjustment is Less (1) or Plus (2); Type of day on which to make the adjustment.

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2

Default is Day (1).

N


category

Category

Category of this Local Custom Day.

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2
  • As String = Holiday, As Value = 3
  • As String = Period, As Value = 4

Default is Day (1).

N


comments

Description

Description of this Custom Day.


N


ctype

Type

Type of this Custom Day.

Valid values:

  • As String = Single Date, As Value = 0
  • As String = Relative Repeating Date, As Value = 1
  • As String = Absolute Repeating Date, As Value = 2
  • As String = List of Dates, As Value = 3

Default is Single Date (0).

N


date

Date

Specific date for this Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
Single Date. )

datelist

dateList

Dates

Multiple specific dates for this Custom Day.
 
XML


<dateList>
        <date>2017-12-13</date>
        <date>2017-12-14</date>
</dateList>

 
JSON


"dateList": [
        "2017-12-13",
        "2017-12-14"
    ],


Y
(if ctype
is List of Dates.)

date

day

Day

Day of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)


dayofweek

Day Of Week

Day of the week.

Valid values:

  • As String = Sun, As Value = 1
  • As String = Mon, As Value = 2
  • As String = Tue, As Value = 3
  • As String = Wed, As Value = 4
  • As String = Thu, As Value = 5
  • As String = Fri, As Value = 6
  • As String = Sat, As Value = 7

Default is Mon (2).

Y
(if ctype
is Relative Repeating Date)
 
N
(if relfreq
is Nth)


exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

exportTable

n/aRecord table information.read onlyN

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:

  • As String = Jan, As Value = 0
  • As String = Feb, As Value = 1
  • As String = Mar, As Value = 2
  • As String = Apr, As Value = 3
  • As String = May, As Value = 4
  • As String = Jun, As Value = 5
  • As String = Jul, As Value = 6
  • As String = Aug, As Value = 7
  • As String = Sep, As Value = 8
  • As String = Oct, As Value = 9
  • As String = Nov, As Value = 10
  • As String = Dec, As Value = 11
  • As String = ALL, As Value = 12

Default is Jan (0).

Y
(if ctype is
Relative Repeating Date
or
Absolute Repeating Date)


name

Name

Name of this Custom Day.


Y


nthAmount

Nth Amount

If relfreq is Nth; Value of N.


Y


nthType

Nth Type

If relfreq is Nth; Type of Nth day.

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2

Default is Day (1).

N


observedRules

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


<observedRules> 
      <observedRule>            
            <actualDayOfWeek>Sat</actualDayOfWeek>           
            <observedDayOfWeek>Fri</observedDayOfWeek> 
      </observedRule> 
      <observedRule>                    
            <actualDayOfWeek>Sun</actualDayOfWeek>               
            <observedDayOfWeek>Mon</observedDayOfWeek> 
      </observedRule> 
</observedRules> 

 
JSON


"observedRules" : [ { 
      "actualDayOfWeek" : "Sat", 
      "observedDayOfWeek" : "Fri" 
    }, { 
      "actualDayOfWeek" : "Sun", 
      "observedDayOfWeek" : "Mon" 
    } ] 

Valid day of week values:

  • Sun, Mon, Tue, Wed, Thu, Fri, Sat

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:


  • As String = 1st, As Value = 1


  • As String = 2nd, As Value = 2


  • As String = 3rd, As Value = 3


  • As String = 4th, As Value = 4


  • As String = Last, As Value = 5


  • As String = Every, As Value = 6


  • As String = Nth, As Value = 7


  • As String = Last Day, As Value = 8


  • As String = Last Business Day, As Value = 9


Default is 1st (1).

Y
(if ctype
is Relative Repeating Date)


retainSysIds

n/a

Specification for whether or not the Create a Custom Day web service will persist the sysId property.


  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.


  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.



Note

In XML web services, retainSysIds is specified as an attribute in the <customDay> element.

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
(if retainSysIds
is true.)


Delete a Custom Day


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

  • Status 200 /OK
    Custom day deleted successfully.
  • Status 404 /Not Found
    A custom day with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

Delete a Custom Day: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

customdayid

Unique ID for this Custom Day.


Y
(unless customdayname
is specified)

customdayname

customdayname

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y
(unless customdayid
is specified)

customdayid

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.

List Custom Day Qualifying Dates: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

customdayid

Unique ID for this Custom Day.


Y
(unless customdayname
is specified)

customdayname

customdayname

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y
(unless customdayid
is specified)

customdayid

calendarid

Unique ID for this Calendar.


Y;
If Custom Day adjustmentType
is Business Day or
When is Last Business Day.
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify a Calendar.

Maximum 40 alphanumerics.

Y;
If Custom Day adjustmentType
is Business Day or
When is Last Business Day.
(unless calendarid
is specified)

calendarid

List Custom Day Qualifying Dates: Example Response

XML Response

JSON Response

 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>
 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"
]

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

customdayid

Unique ID for this Custom Day.


Y
(unless customdayname
is specified)

customdayname

customdayname

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y
(unless customdayid
is specified)

customdayid

calendarid

Unique ID for this Calendar.


Y
If Custom Day When
is Last Business Day.
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify a Calendar.

Maximum 40 alphanumerics.

Y
If Custom Day When
is Last Business Day.
(unless calendarid
is specified)

calendarid

List Custom Day Qualifying Periods: Example Response

XML Response

JSON Response

 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>
 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"
  }
]

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.

List Custom Days: Example Response

XML Response

JSON Response

 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>
 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 } ]

Modify a Custom Day


Description

URI

http://host_name/uc/resources/customday

HTTP Method

PUT

Description

Modifies the Custom Day specified by the sysId.

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

  • Status 200 /OK
    Successfully updated the custom day with sysId <sysId> to version <version>.

Modify a Custom Day: Example Request

XML Request

JSON Request

 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>
 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"
}

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.

Read a Custom Day: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

customdayid

Unique ID for this Custom Day.


Y
(unless customdayname
is specified)

customdayname

customdayname

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y
(unless customdayid
is specified)

customdayid

Read a Custom Day: Example Response

XML Response

JSON Response

 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>
 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 }