Page Comparison

...

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.

...

Note

title	Note

You can create and modify a Custom Day only if the Custom Properties#Custom Day Global Permitted Universal Controller system property is set to true.

...

	Description
URI	http://host_name/uc/resources/customday
HTTP Method	POST
Description	Creates a new Creating Custom DayDays.
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>.

...

XML Request

JSON Request

Expand

title	XML Request

<customDay retainSysIds="true">
            <adjustment - CCD>None</adjustment - CCD>
            <adjustmentAmount - CCD>1</adjustmentAmount>
            <adjustmentType - CCD>Day</adjustmentType - CCD>
            <category - CCD>Day</category - CCD>
            <comments - CCD />
            <ctype - CCD>Relative Repeating Date</ctype - CCD>
            <date - CCD />
            <dateList />
            <day - CCD>1</day - CCD>
            <dayofweek - CCD>Sun</dayofweek - CCD>
            <holiday - CCD>false</holiday - CCD>
            <month - CCD>Sep</month - CCD>
            <name - CCD>special day</name - CCD>
            <nthAmount - CCD>8</nthAmount - CCD>
            <nthType - CCD>Business Day</nthType - CCD>
            <observedRules - CCD />
            <period - CCD>false</period - CCD>
            <relfreq - CCD>Nth</relfreq - CCD>
            <sysId - CCD>dae77560c0a80165006d8051753b806c</sysId - CCD>
</customDay>

Expand

title	JSON Request

{
  "adjustment - CCD": "None",
  "adjustmentAmount - CCD": 1,
  "adjustmentType - CCD": "Day",
  "category - CCD": "Day",
  "comments - CCD": null,
  "ctype - CCD": "Relative Repeating Date",
  "datedate - CCD": null,
  "dateList": [],
  "day - CCD": 1,
  "dayofweek - CCD": "Sun",
  "holiday - CCD": false,
  "month - CCD": "Sep",
  "name - CCD": "special day",
  "nthAmount - CCD": 8,
  "nthType - CCD": "Business Day",
  "observedRules - CCD": [],
  "period - CCD": false,
  "relfreq - CCD": "Nth",
  "retainSysIds": true,
  "sysId - CCD": "dae77560c0a80165006d8051753b806c"
}

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	adjustment - CCD
	adjustment - CCD

adjustment

Adjustment

If ctype is Relative Repeating Date (1); Adjustment Creating Custom Days#Custom Day Adjustments 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

Anchor

	adjustmentAmount - CCD
	adjustmentAmount - CCD

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

Anchor

	adjustmentType - CCD
	adjustmentType - CCD

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

Anchor

	category - CCD
	category - CCD

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

Anchor

	comments - CCD
	comments - CCD

comments

Description

Description of this Custom Day.

N

Anchor

	ctype - CCD
	ctype - CCD

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

Anchor

	date - CCD
	date - CCD

date

Date

Specific date for this Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
Single Date. )

datelist

Anchor

	dateList - CCD
	dateList - CCD

dateList

Dates

Multiple specific dates for this Custom Day.

XML

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

JSON

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

Y
(if ctype
is List of Dates.)

date

Anchor

	day - CCD
	day - CCD

day

Day

Day of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)

Anchor

	dayofweek - CCD
	dayofweek - CCD

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)

Anchor

	exportReleaseLevel - CCD
	exportReleaseLevel - CCD

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

	exportTable - CCD
	exportTable - CCD

exportTable

n/a

Record table information.

read only

N

Anchor

	holiday - CCD
	holiday - CCD

holiday

(none)

Deprecated. Indication of whether or not this Custom Day is a holiday.

Boolean; Valid values: true/false; Default is false.

N

Anchor

	month - CCD
	month - CCD

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)

Anchor

	name - CCD
	name - CCD

name

Name

Name of this Custom Day.

Y

Anchor

	nthAmount - CCD
	nthAmount - CCD

nthAmount

Nth Amount

If relfreq is Nth; Value of N.

Y

Anchor

	nthType - CCD
	nthType - CCD

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

Anchor

	observedRules - CCD
	observedRules - CCD

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

Panel

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

JSON

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

Valid day of week values:

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

N

Anchor

	period - CCD
	period - CCD

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

Anchor

	relfreq - CCD
	relfreq - CCD

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)

Anchor

	retainSysIds - CCD
	retainSysIds - CCD

retainSysIds

n/a

Specification for whether or not the Create a Custom Day web service will persist the sysId - CC 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

title	Note

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

Valid values: true/false (default is true).

N

Anchor

	sysId - CCD
	sysId - CCD

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.)

...

	Description
URI	http://host_name/uc/resources/customday
HTTP Method	DELETE
Description	Deletes a specific Creating Custom DayDays.
URI Parameters	See Delete a Custom Day : URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/customday?customdayname=testCustomDay http://localhost:8080/uc/resources/customday?customdayid=f87848b00a0001037f43e7c81c8ec969
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.

...

	Description
URI	http://host_name/uc/resources/customday/qualifyingdates
HTTP Method	GET
Description	Retrieves information on Qualifying Dates for a specific Creating Custom Days#Creating Global Custom DayDays.
URI Parameters	See List Custom Day Qualifying Dates URI Parameters: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/customday/qualifyingdates?customdayname=testCustomDay http://localhost:8080/uc/resources/customday/qualifyingdates?customdayname=testCustomDay&calendarname=testCalendar
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
	List Custom Day Qualifying Dates URI Parameters

...

	Description
URI	http://host_name/uc/resources/customday/qualifyingperiods
HTTP Method	GET
Description	Retrieves information on Qualifying Periods for a specific Creating Custom DayDays#Creating Global Custom Days.
URI Parameters	See List Custom Day Qualifying Periods URI Parameters: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/customday/qualifyingperiods?customdayname=testCustomDay http://localhost:8080/uc/resources/customday/qualifyingperiods?customdayname=testCustomDay&calendarname=testCalendar
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
	List Custom Day Qualifying Periods URI Parameters

...

	Description
URI	http://host_name/uc/resources/customday/list
HTTP Method	GET
Description	Retrieves information on all Creating 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.

...

XML Response

JSON Response

Expand

title	XML Response

<customDays>
      <customDay exportReleaseLevel - CCD="7.2.0.0" exportTable - CCD="ops_custom_day" version="1">
            <adjustment - CCD>None</adjustmentadjustment - CCD>
            <adjustmentAmount - CCD>1</adjustmentAmount - CCD>
            <adjustmentType - CCD>Day</adjustmentType - CCD>
            <category - CCD>Day</category - CCD>
            <comments - CCD />
            <ctype - CCD>Relative Repeating Date</ctype - CCD>
            <date - CCD />
            <dateList - CCD />
            <day - CCD>1</day - CCD>
            <dayofweek - CCD>Sun</dayofweek - CCD>
            <holiday - CCD>false</holiday - CCD>
            <month - CCD>Sep</month - CCD>
            <name - CCD>special day</name - CCD>
            <nthAmount - CCD>8</nthAmountnthAmount - CCD>
            <nthType - CCD>Business Day</nthType - CCD>
            <period - CCD>false</period - CCD>
            <relfreq - CCD>Nth</relfreq - CCD>
            <sysId - CCD>dae77560c0a80165006d8051753b806c</sysId - CCD>
      </customDay>
      <customDay exportReleaseLevel - CCD="7.2.0.0" exportTable - CCD="ops_custom_day" version="1">
            <adjustment - CCD>None</adjustment - CCD>
            <adjustmentAmount - CCD>1</adjustmentAmount - CCD>
            <adjustmentType - CCD>Day</adjustmentType - CCD>
            <category - CCD>Day</category - CCD>
            <comments - CCD />
            <ctype - CCD>Relative Repeating Date</ctype>
            <date - CCD />
            <dateList - CCD />
            <dayday - CCD>1</day - CCD>
            <dayofweek - CCD>Sun</dayofweek - CCD>
            <holiday - CCD>false</holiday - CCD>
            <month - CCD>Sep</month - CCD>
            <name - CCD>special day</name - CCD>
            <nthAmount - CCD>9</nthAmount - CCD>
            <nthType - CCD>Business Day</nthType - CCD>
            <period - CCD>false</period - CCD>
            <relfreq>Nth</relfreq>
            <sysId - CCD>dae77560c0a80165006d8051753b806c</sysId - CCD>
      </customDay>
</customDays>

Expand

title	JSON Response

[
  { 
  "adjustment - CCD": "None",
  "adjustmentAmount - CCD": 1,
  "adjustmentType - CCD": "Day",
  "category - CCD": "Day",
  "comments - CCD": null,
  "ctypectype - CCD": "Relative Repeating Date",
  "date - CCD": null,
  "dateList - CCD": [],
  "day - CCD": 1,
  "dayofweek - CCD": "Sun",
  "exportReleaseLevel - CCD": "7.2.0.0",
  "exportTable - CCD": "ops_custom_day",
  "holiday - CCD": false,
  "month - CCD": "Sep",
  "name - CCD": "special day",
  "nthAmount - CCD": 8,
  "nthType - CCD": "Business Day",
  "period - CCD": false,
  "relfreq - CCD": "Nth",
  "retainSysIds": true,
  "sysId - CCD": "dae77560c0a80165006d8051753b806c"
  "version": 1
  },
  {
  "adjustment - CCD": "None",
  "adjustmentAmount - CCD": 1,
  "adjustmentType - CCD": "Day",
  "category - CCD": "Day",
  "comments - CCD": null,
  "ctype - CCD": "Relative Repeating Date",
  "date - CCD": null,
  "dateList - CCD": [],
  "dayday - CCD": 1,
  "dayofweek - CCD": "Sun",
  "exportReleaseLevel - CCD": "7.2.0.0",
  "exportTable - CCD": "ops_custom_day",
  "holiday - CCD": false,
  "month - CCD": "Sep",
  "name - CCD": "special day",
  "nthAmount - CCD": 9,
  "nthType - CCD": "Business Day",
  "period - CCD": false,
  "relfreq": "Nth",
  "retainSysIds": true,
  "sysId - CCD": "abc77560c0a80165006d8051753b806c"
  "version": 1
  }
]

...

	Description
URI	http://host_name/uc/resources/customday
HTTP Method	PUT
Description	Modifies the Creating Custom DayDays 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>.

...

XML Request

JSON Request

Expand

title	XML Request

<customDay> 
            <adjustment - CCD>None</adjustment - CCD>
            <adjustmentAmount - CCD>1</adjustmentAmount - CCD>
            <adjustmentType - CCD>Day</adjustmentType - CCD>
            <category - CCD>Day</category - CCD>
            <comments - CCD />
            <ctype - CCD>Relative Repeating Date</ctype - CCD>
            <datedate - CCD />
            <dateList - CCD />
            <day - CCD>1</day - CCD>
            <dayofweek - CCD>Sun</dayofweek - CCD>
            <holiday - CCD>false</holiday - CCD>
            <month - CCD>Sep</month - CCD>
            <name - CCD>special day</name - CCD>
            <nthAmount - CCD>8</nthAmount - CCD>
            <nthType - CCD>Business Day</nthType - CCD>
            <period - CCD>false</period - CCD>
            <relfreq - CCD>Nth</relfreq - CCD>
            <sysId - CCD>dae77560c0a80165006d8051753b806c</sysId - CCD>
</customDay>

Expand

title	JSON Request

 {
  "adjustment - CCD": "None",
  "adjustmentAmountadjustmentAmount - CCD": 1,
  "adjustmentType - CCD": "Day",
  "category - CCD": "Day",
  "comments - CCD": null,
  "ctype - CCD": "Relative Repeating Date",
  "date - CCD": null,
  "dateList - CCD": [],
  "day - CCD": 1,
  "dayofweek - CCD": "Sun",
  "holiday - CCD": false,
  "month - CCD": "Sep",
  "name - CCD": "special day",
  "nthAmount - CCD": 8,
  "nthType - CCD": "Business Day",
  "period - CCD": false,
  "relfreq - CCD": "Nth",
  "sysId - CCD": "dae77560c0a80165006d8051753b806c"
}

...

	Description
URI	http://host_name/uc/resources/customday
HTTP Method	GET
Description	Retrieves information on a specific Creating Custom DayDays.
URI Parameters	See Read a Custom Day : URI Parameters, below.
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example URI	http://localhost:8080/uc/resources/customday?customdayname=testCustomDay http://localhost:8080/uc/resources/customday?customdayid=f87848b00a0001037f43e7c81c8ec969
Example Response	Status 200 /OK (See Read a Custom Day : Example Response, below.) Status 404 /Not Found A custom day with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
Custom Day Properties	See Custom Day Properties.

...

XML Response

JSON Response

Expand

title	XML Response

<customDay exportReleaseLevel - CCD="7.2.0.0" exportTable - CCD="ops_custom_day" retainSysIds="true" version="1">
            <adjustment - CCD>None</adjustment - CCD>
            <adjustmentAmount - CCD>1</adjustmentAmountadjustmentAmount - CCD>
            <adjustmentType - CCD>Day</adjustmentType - CCD>
            <category - CCD>Day</category - CCD>
            <comments - CCD />
            <ctype - CCD>Relative Repeating Date</ctype - CCD>
            <date - CCD />
            <dateList - CCD />
            <day>1</day>
            <dayofweek - CCD>Sun</dayofweek - CCD>
            <holiday - CCD>false</holiday - CCD>
            <month - CCD>Sep</month - CCD>
            <name - CCD>special day</name - CCD>
            <nthAmount - CCD>8</nthAmount - CCD>
            <nthType - CCD>Business Day</nthType - CCD>
            <period - CCD>false</periodperiod - CCD>
            <relfreq - CCD>Nth</relfreq - CCD>
            <sysId - CCD>dae77560c0a80165006d8051753b806c</sysId - CCD>
</customDay>

Expand

title	JSON Response

{
  "adjustment - CCD": "None",
  "adjustmentAmount - CCD": 1,
  "adjustmentType - CCD": "Day",
  "category - CCD": "Day",
  "comments - CCD": null,
  "ctype - CCD": "Relative Repeating Date",
  "date - CCD": null,
  "dateList - CCD": [],
  "day": 1,
  "dayofweek - CCD": "Sun",
  "exportReleaseLevel - CCD": "7.2.0.0",
  "exportTable - CCD": "ops_custom_day",
  "holiday - CCD": false,
  "month - CCD": "Sep",
  "name - CCD": "special day",
  "nthAmount - CCD": 8,
  "nthType - CCD": "Business Day",
  "period - CCD": false,
  "relfreq - CCD": "Nth",
  "retainSysIds": true,
  "sysId - CCD": "dae77560c0a80165006d8051753b806c"
  "version": 1
}

...

Versions Compared

Old Version 4

New Version 5

Key