Page Comparison

...

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

Custom Day Web Services#Create Create a Custom DayCustom Day Web Services#Delete
Delete a Custom Day
Custom Day Web Services#List List Custom Day Qualifying DatesCustom Day Web Services#List
List Custom Day Qualifying Periods
List Custom Day Web Services#List Custom DaysCustom
Day Web Services#Modify Modify a Custom DayCustom Day Web Services#Read
Read a Custom Day

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

...

	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 Web Services#Custom Day Properties, below.
Example Response	Status 200 /OK Successfully created the custom day with sysId <sysId>.

...

As

String

=

Single

Date,

As

Value

=

0

<li>

As

String

=

Relative

Repeating

Date,

As

Value

=

1

<li>

As

String

=

Absolute

Repeating

Date,

As

Value

=

2

<li>

As

String

=

List

of

Dates,

As

Value

=

3

</ul>

Default is Single Date (0).

As

String

=

Sun,

As

Value

=

1

<li>

As

String

=

Mon,

As

Value

=

2

<li>

As

String

=

Tue,

As

Value

=

3

<li>

As

String

=

Wed,

As

Value

=

4

<li>

As

String

=

Thu,

As

Value

=

5

<li>

As

String

=

Fri,

As

Value

=

6

<li>

As

String

=

Sat,

As

Value

=

7

</ul>

Default is Mon (2).

As

String

=

Day,

As

Value

=

1

<li>

As

String

=

Business

Day,

As

Value

=

2

</ul>

Default is Day (1).

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 for the repeating date.

Valid values:

html-bobswift

As

String

=

None,

As

Value

=

0

<li>

As

String

=

Less,

As

Value

=

1

<li>

As

String

=

Plus,

As

Value

=

2

</ul>

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:

html-bobswift

As

String

=

Day,

As

Value

=

1

<li>

As

String

=

Business

Day,

As

Value

=

2

</ul>

Default is Day (1).

N

Anchor

	category - CCD
	category - CCD

category

Category

Category of this Local Custom Day.

Valid values:

html-bobswift

As

String

=

Day,

As

Value

=

1

<li>

As

String

=

Business

Day,

As

Value

=

2

<li>

As

String

=

Holiday,

As

Value

=

3

<li>

As

String

=

Period,

As

Value

=

4

</ul>

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:

Html bobswift

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

Html bobswift
<pre> <dateList> <date>2017-12-13</date> <date>2017-12-14</date> </dateList> </pre>

JSON

Panel

Html bobswift
<pre> "dateList": [ "2017-12-13", "2017-12-14" ], </pre>

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:

Html bobswift

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:

html-bobswift

As

String

=

Jan,

As

Value

=

0

<li>

As

String

=

Feb,

As

Value

=

1

<li>

As

String

=

Mar,

As

Value

=

2

<li>

As

String

=

Apr,

As

Value

=

3

<li>

As

String

=

May,

As

Value

=

4

<li>

As

String

=

Jun,

As

Value

=

5

<li>

As

String

=

Jul,

As

Value

=

6

<li>

As

String

=

Aug,

As

Value

=

7

<li>

As

String

=

Sep,

As

Value

=

8

<li>

As

String

=

Oct,

As

Value

=

9

<li>

As

String

=

Nov,

As

Value

=

10

<li>

As

String

=

Dec,

As

Value

=

11

<li>

As

String

=

ALL,

As

Value

=

12

</ul>

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:

Html bobswift

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

Html bobswift

<pre>
&lt;observedRules&gt; 
      &lt;observedRule&gt;            
            &lt;actualDayOfWeek&gt;Sat&lt;/actualDayOfWeek&gt;           
            &lt;observedDayOfWeek&gt;Fri&lt;/observedDayOfWeek&gt; 
      &lt;/observedRule&gt; 
      &lt;observedRule&gt;                    
            &lt;actualDayOfWeek&gt;Sun&lt;/actualDayOfWeek&gt;               
            &lt;observedDayOfWeek&gt;Mon&lt;/observedDayOfWeek&gt; 
      &lt;/observedRule&gt; 
&lt;/observedRules&gt; 
</pre>

JSON

Panel

Html bobswift
<pre> "observedRules" : [ { "actualDayOfWeek" : "Sat", "observedDayOfWeek" : "Fri" }, { "actualDayOfWeek" : "Sun", "observedDayOfWeek" : "Mon" } ] </pre>

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:

html-bobswift

As

String

=

1st,

As

Value

=

1

<li>

As

String

=

2nd,

As

Value

=

2

<li>

As

String

=

3rd,

As

Value

=

3

<li>

As

String

=

4th,

As

Value

=

4

<li>

As

String

=

Last,

As

Value

=

5

<li>

As

String

=

Every,

As

Value

=

6

<li>

As

String

=

Nth,

As

Value

=

7

<li>

As

String

=

Last

Day,

As

Value

=

8

<li>

As

String

=

Last

Business

Day,

As

Value

=

9

</ul>

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

html-bobswift

<ul> <li> If <b>retainSysIds</b>

If retainSysIds="true"

and

<code>sysId</code>

sysId is

included

in

the

request/response,

<code>sysId</code>

sysId will

be

persisted

to

the

database.

<li> If <b>retainSysIds</b>

If retainSysIds="false"

and <code>sysId</code> is included in the

and sysId is included in the request/response,

<code>sysId</code>

sysId will

be

ignored;

it

will

be

autogenerated

by

the

Controller.

</ul>

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/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 Web Services#Custom Day Properties.

Anchor
List Custom Days Example Response
List Custom Days Example Response
List Custom Days: Example Response

...

	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 Web Services#Custom Day Properties.
Example Response	Status 200 /OK Successfully updated the custom day with sysId <sysId> to version <version>.

...

	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	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 Web Services#Custom Day Properties.

Anchor
Read a Custom Day URI Parameters
Read a Custom Day URI Parameters
Read a Custom Day: URI Parameters

...

Versions Compared

Old Version 2

New Version 3

Key

Anchor
List Custom Days Example Response
List Custom Days Example Response
List Custom Days: Example Response

Anchor
Read a Custom Day URI Parameters
Read a Custom Day URI Parameters
Read a Custom Day: URI Parameters

Page Comparison

Versions Compared

Old Version 2

New Version 3

Key

AnchorList Custom Days Example ResponseList Custom Days Example ResponseList Custom Days: Example Response

AnchorRead a Custom Day URI ParametersRead a Custom Day URI ParametersRead a Custom Day: URI Parameters

Anchor
List Custom Days Example Response
List Custom Days Example Response
List Custom Days: Example Response

Anchor
Read a Custom Day URI Parameters
Read a Custom Day URI Parameters
Read a Custom Day: URI Parameters