Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

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

...


Description

URI

http://host_name/uc/resources/calendar/customdays

HTTP Method

POST

Description

Adds the specified Custom Day to the specified Calendar.

URI Parameters

See Add an Existing Custom Day to a Calendar: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/customdays?calendarname=test&customdayid=sfsdffsf123456dfhkjhk

Example Response

  • Status 200 /OK
    Custom day <customDay> successfully added to the calendar <calendar>.
  • Status 400 /Bad Request
    Calendar <calendarName> doesn`t exist.
  • Status 400 /Bad Request
    Custom Day <customDay> is already in the Calendar <calendarName>.

...


Description

URI

HTTP Method

POST

Description

Creates a new Calendar.

Example URI

http://localhost:8080/uc/resources/calendar

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Create a Calendar: Example Request, below.

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Example Response

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

...

XML Request

JSON Request


Expand
titleXML Request


<calendar retainSysIds="true">
       <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
       <customDays>
              <customDay>
                     <name>uc - Christmas</name>
                     <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>
              </customDay>
              <customDay>
                     <name>uc - Flag Day</name>
                     <sysId>daf16d8fc0a801650040c4d54b2432fb</sysId>
              </customDay>
       </customDays>
       <comments>American Calendar</comments>
       <firstDayOfWeek>Sunday</firstDayOfWeek>
       <localCustomDays>
              <localCustomDay>
                     <adjustment>None</adjustment>
                     <adjustmentAmount>1</adjustmentAmount>
                     <adjustmentType>Day</adjustmentType>
                     <category>Holiday</category>
                     <comments />
                     <ctype>Single Date</ctype>
                     <date>2017-08-23</date>
                     <dateList />
                     <day>1</day>
                     <dayofweek>Sun</dayofweek>
                     <month>Jan</month>
                     <name>local custom day</name>
                     <observedRules />
                     <relfreq>1st</relfreq>
                     <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
       </localCustomDays>
       <name>uc - American Calendar</name>
       <opswiseGroups />
       <sysId>da24b953c0a8016501fbcb18464d8328</sysId>
</calendar>



Expand
titleJSON Request


{
  "businessDays": {
     "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Flag Day",
    "sysId": "daf16d8fc0a801650040c4d54b2432fb"
    }
  ],
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
    {
    "adjustment": "None",
    "adjustmentAmount": 1,
    "adjustmentType": "Day",
    "category": "Holiday",
    "comments": null,
    "ctype": "Single Date",
    "date": "2017-08-23",
    "dateList": [],
    "day": 1,
    "dayofweek": "Sun",
    "month": "Jan",
    "name": "local custom day",
    "observedRules": [],
    "relfreq": "1st",
    "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
    }
  ],
  "name": "uc - American Calendar",
  "opswiseGroups": [],
  "retainSysIds": true,
  "sysId": "da24b953c0a8016501fbcb18464d8328"
}


...

Property

UI Field Name

Description

Specifications

Required

Anchor
businessDays - CC
businessDays - CC
businessDays

Business Days

Comma-separated list of days.

Valid values:


  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

Optional: useDefaultIfBlank attribute. Boolean; Valid values: true/false.

  • If businessDays is blank or is not specified in the Request, businessDays defaults to Monday,Tuesday,Wednesday,Thursday,Friday. To disable this behavior, set useDefaultIfBlank to false. That is, to set businessDays to blank when a calendar contains "Business Day" Custom Day(s), specify: <businessDays useDefaultIfBlank="false"></businessDays>.
  • If businessDays is blank and the useDefaultIfBlank attribute is not included in the Request (<businessDays />), businessDaysdefaults to Monday,Tuesday,Wednesday,Thursday,Friday.
  • If businessDays is not blank, useDefaultIfBlank is ignored.
  • If useDefaultIfBlank is set to true (<businessDays useDefaultIfBlank="true"></businessDays>), businessDaysdefaults to Monday,Tuesday,Wednesday,Thursday,Friday.
  • If useDefaultIfBlank is set to false (<businessDays useDefaultIfBlank="false"></businessDays>), business days are not set.

The Read a Calendar web service will return useDefaultIfBlank only if businessDays is empty; useDefaultIfBlank will be set to false.

N

Anchor
comments - CC
comments - CC
comments

Description

User-defined; description for the calendar.


N

Anchor
excludeRelated - CC
excludeRelated - CC
excludeRelated

n/a

Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request.

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

N

Anchor
exportReleaseLevel - CC
exportReleaseLevel - CC
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - CC
exportTable - CC
exportTable

n/aRecord table information.read onlyN

Anchor
firstDayOfWeek - CC
firstDayOfWeek - CC
firstDayOfWeek

First Day Of Week

Day that is considered the start of the week.

Valid values:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

N

Anchor
name - CC
name - CC
name

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor
opswiseGroups - CC
opswiseGroups - CC
opswiseGroups

Member of Business Services

List of Business Services:
 
XML


Panel
<opswiseGroups>
	<opswiseGroup>test</opswiseGroup>
</opswiseGroups>


 
JSON


Panel
"opswiseGroups": [
"test"
]



N

Anchor
retainSysIds - CC
retainSysIds - CC
retainSysIds

n/a

Specification for whether or not the Create a Calendar 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
titleNote

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


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

N

Anchor
sysId - CC
sysId - CC
sysId

n/a

System ID field in the database for this Calendar record.

Persisted only if retainSysIds is set to true.

N

firstQuarterStart

1st Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.
 
XML

    <firstQuarterStart>
        <day>15</day>
        <month>01</month>
    </firstQuarterStart>

 JSON

    "firstQuarterStart": {
        "day": "15",
        "month": "Jan"
    }

Valid values:

  • month:

    • integer value between 1-12

    • string value 3 letter month

      • Jan

      • Feb

      • Mar

      • Apr

      • May

      • Jun

      • Jul

      • Aug

      • Sep

      • Oct

      • Nov

      • Dec

  • The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

secondQuarterStart

2nd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.
 
XML

    <secondQuarterStart>
        <day>14</day>
        <month>Apr</month>
    </secondQuarterStart>

 JSON

   "secondQuarterStart": {
        "day": "14",
        "month": "Apr"
    }

Valid values:

  • month:

    • integer value between 1-12

    • string value 3 letter month

      • Jan

      • Feb

      • Mar

      • Apr

      • May

      • Jun

      • Jul

      • Aug

      • Sep

      • Oct

      • Nov

      • Dec

  • The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

thirdQuarterStart

3rd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.
 
XML

    <thirdQuarterStart>
        <day>16</day>
        <month>Jul</month>
    </thirdQuarterStart>

 JSON

   "thirdQuarterStart": {
        "day": "16",
        "month": "Jul"
    }

Valid values:

  • month:

    • integer value between 1-12

    • string value 3 letter month

      • Jan

      • Feb

      • Mar

      • Apr

      • May

      • Jun

      • Jul

      • Aug

      • Sep

      • Oct

      • Nov

      • Dec

  • The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

fourthQuarterStart

4th Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.
 
XML

    <fourthQuarterStart>
        <day>13</day>
        <month>10</month>
    </fourthQuarterStart>

 JSON

    "fourthQuarterStart": {
        "day": "13",
        "month": "Oct"
    }

Valid values:

  • month:

    • integer value between 1-12

    • string value 3 letter month

      • Jan

      • Feb

      • Mar

      • Apr

      • May

      • Jun

      • Jul

      • Aug

      • Sep

      • Oct

      • Nov

      • Dec

  • The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

...


Description

URI

http://host_name/uc/resources/calendar

HTTP Method

DELETE

Description

Deletes the specified Calendar.

URI Parameters

See Delete a Calendar: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Example Response

  • Status 200 /OK
    Calendar deleted successfully.
  • Status 404 /Not Found
    A calendar with id "f87848b00a0001037f43e7c81c8ec969" does not exist.

...


Description

URI

http://host_name/uc/resources/calendar/list

HTTP Method

GET

Description

Retrieves information on all Calendar.

Example URI

http://localhost:8080/uc/resources/calendar/list

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Calendars: Example Response, below.

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Anchor
List Calendars Example Response
List Calendars Example Response
List Calendars: Example Response

XML Response

JSON Response


Expand
titleXML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<calendar retainSysIds="true" version="2">
    <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
    <customDays/>
    <comments />
    <firstDayOfWeek>Monday</firstDayOfWeek>
    <firstQuarterStart>
        <day>15</day>
        <month>Jan</month>
    </firstQuarterStart>
    <fourthQuarterStart>
        <day>15</day>
        <month>Oct</month>
    </fourthQuarterStart>
    <localCustomDays/>
    <name>Q15</name>
    <opswiseGroups/>
    <secondQuarterStart>
        <day>15</day>
        <month>Apr</month>
    </secondQuarterStart>
    <sysId>8aad692481794d928161539552cb61c1</sysId>
    <thirdQuarterStart>
        <day>15</day>
        <month>Jul</month>
    </thirdQuarterStart>
</calendar>



Expand
titleJSON Response
{
    "businessDays": {
        "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
    },
    "comments": null,
    "customDays": [],
    "firstDayOfWeek": "Monday",
    "firstQuarterStart": {
        "day": "15",
        "month": "Jan"
    },
    "fourthQuarterStart": {
        "day": "15",
        "month": "Oct"
    },
    "localCustomDays": [],
    "name": "Q15",
    "opswiseGroups": [],
    "retainSysIds": true,
    "secondQuarterStart": {
        "day": "15",
        "month": "Apr"
    },
    "sysId": "8aad692481794d928161539552cb61c1",
    "thirdQuarterStart": {
        "day": "15",
        "month": "Jul"
    },
    "version": 2
}


Anchor
List Local Custom Day Qualifying Dates
List Local Custom Day Qualifying Dates
List Local Custom Day Qualifying Dates


Description

URI

HTTP Method

GET

Description

Retrieves information on Qualifying Dates for a specific Local Custom Day.

URI Parameters

See List Local Custom Day Qualifying Dates URI Parameters: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingdates?customdayname=testLocalCustomDay&calendarname=testCalendar

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Local Custom Day Qualifying Dates: Example Response, below.

Anchor
List Local Custom Day Qualifying Dates URI Parameters
List Local Custom Day Qualifying Dates URI Parameters
List Local Custom Day Qualifying Dates: URI Parameters

...


Description

URI

HTTP Method

GET

Description

Retrieves information on Qualifying Periods for a specific Local Custom Day.

URI Parameters

See List Local Custom Day Qualifying Periods URI Parameters: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/localcustomdays/qualifyingperiods?customdayname=testLocalCustomDay&calendarname=testCalendar

Authentication

HTTP Basic

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

See List Local Custom Day Qualifying Periods: Example Response, below.

Anchor
List Local Custom Day Qualifying Periods Example Response
List Local Custom Day Qualifying Periods Example Response
List Local Custom Day Qualifying Periods: Example Response

...


Description

URI

HTTP Method

PUT

Description

Modifies the Calendar specified by the sysId.
 
To modify Calendar properties without modifying related records, see the excludeRelated property.

Example URI

http://localhost:8080/uc/resources/calendar

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Modify a Calendar: Example Request, below.

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Example Response

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

Anchor
Modify a Calendar Example Request
Modify a Calendar Example Request
Modify a Calendar: Example Request

The excludeRelated property is included in the XML as an attribute.
 

XML Request

JSON Request


Expand
titleXML Request


<calendar>
       <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
       <customDays>
              <customDay>
                     <name>uc - Christmas</name>
                     <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>
              </customDay>
              <customDay>
                     <name>uc - Flag Day</name>
                     <sysId>daf16d8fc0a801650040c4d54b2432fb</sysId>
              </customDay>
       </customDays>
       <comments>American Calendar</comments>
       <firstDayOfWeek>Sunday</firstDayOfWeek>
       <localCustomDays>
              <localCustomDay>
                     <adjustment>None</adjustment>
                     <adjustmentAmount>1</adjustmentAmount>
                     <adjustmentType>Day</adjustmentType>
                     <category>Holiday</category>
                     <comments/>
                     <ctype>Single Date</ctype>
                     <date>2017-08-23</date>
                     <dateList/>
                     <day>1</day>
                     <dayofweek>Sun</dayofweek>
                     <month>Jan</month>
                     <name>local custom day</name>
                     <relfreq>1st</relfreq>
                     <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
       </localCustomDays>
       <name>uc - American Calendar</name>
       <opswiseGroups />
       <sysId>da24b953c0a8016501fbcb18464d8328</sysId>
</calendar>



Expand
titleJSON Request


{
  "businessDays": {
     "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Flag Day",
    "sysId": "daf16d8fc0a801650040c4d54b2432fb"
    }
  ],
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
    {
    "adjustment": "None",
    "adjustmentAmount": 1,
    "adjustmentType": "Day",
    "category": "Holiday",
    "comments": null,
    "ctype": "Single Date",
    "date": "2017-08-23",
    "dateList": [],
    "day": 1,
    "dayofweek": "Sun",
    "month": "Jan",
    "name": "local custom day",
    "relfreq": "1st",
    "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
    }
  ],
  "name": "uc - American Calendar",
  "opswiseGroups": [],
  "sysId": "da24b953c0a8016501fbcb18464d8328"
}


...


Description

URI

HTTP Method

GET

Description

Retrieves information on a specific Calendar.

URI Parameters

See Read a Calendar: URI Parameters, below.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Example Response

Calendar Properties

See Create a Calendar: Calendar Properties.

Custom Day Properties

See Create a Calendar: Custom Day Properties.

Local Custom Day Properties

See Create a Calendar: Local Custom Day Properties.

Anchor
Read a Calendar URI Parameters
Read a Calendar URI Parameters
Read a Calendar: URI Parameters

...

Anchor
Read a Calendar Example Response
Read a Calendar Example Response
Read a Calendar: Example Response

The retainSysIds and version properties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

...


Description

URI

HTTP Method

GET

Description

Retrieves information on all Custom Days of a specific Calendar.

URI Parameters

See Read All Custom Days of a Calendar: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/customdays?calendarname=test

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Response

Response Properties

See Read All Custom Days of a Calendar: Response Properties, below.

Anchor
Read All Custom Days of a Calendar URI Parameters
Read All Custom Days of a Calendar URI Parameters
Read All Custom Days of a Calendar: URI Parameters

...

Anchor
Read All Custom Days of a Calendar Example Response
Read All Custom Days of a Calendar Example Response
Read All Custom Days of a Calendar: Example Response

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

XML Response

JSON Response


Expand
titleXML Response
<customDays>
      <customDay> exportReleaseLevel="7.2.0.0" exportTable="ops_customdays"
            <adjustment>None</adjustment>
            <adjustmentAmount>1</adjustmentAmount>
            <adjustmentType>Day</adjustmentType>
            <category>Holiday</category>
            <comments>New Year's Day - Jan 1st</comments>
            <ctype>Absolute Repeating Date</ctype>
            <date />
            <dateList />
            <day>1</day>
            <dayofweek>Sun</dayofweek>
            <holiday>true</holiday>
            <month>Jan</month>
            <name>uc - New Year's Day</name>
            <period>false</period>
            <relfreq>1st</relfreq>
            <sysId>dae77560c0a80165006d8051753b806c</sysId>
      </customDay>
      <customDay> exportReleaseLevel="7.2.0.0" exportTable="ops_customdays"
            <adjustment>None</adjustment>
            <adjustmentAmount>1</adjustmentAmount>
            <adjustmentType>Day</adjustmentType>
            <category>Holiday</category>
            <comments>New Year's Day - Jan 1st</comments>
            <ctype>Absolute Repeating Date</ctype>
            <date />
            <dateList />
            <day>1</day>
            <dayofweek>Sun</dayofweek>
            <holiday>true</holiday>
            <month>Jan</month>
            <name>uc - New Year's Day</name>
            <period>false</period>
            <relfreq>1st</relfreq>
            <sysId>dae77560c0a80165006d8051753b806c</sysId>
      </customDay>
</customDays>




Expand
titleJSON Response
[
  {
  "adjustment": "None",
  "adjustmentAmount": 1,
  "adjustmentType": "Day",
  "category": "Holiday",
  "comments": "New Year's Day - Jan 1st",
  "ctype": "Absolute Repeating Date",
  "date: null,
  "dateList: [ ],
  "day": 1,
  "dayofweek": "Sun",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_customdays", "holiday": true, "month": "Jan", "name": "uc - New Year's Day", "period": false, "relfreq": "1st", "sysId": "dae77560c0a80165006d8051753b806c" }, { "adjustment": "None", "adjustmentAmount": 1, "adjustmentType": "Day", "category"": Holiday", "comments": "New Year's Day - Jan 1st", "ctype"": Absolute Repeating Date", "date : null, "dateList : [], "day": 1, "dayofweek": "Sun",
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_customdays", "holiday": true, "month": "Jan", "name": "uc - New Year's Day", "period": false", "relfreq": "1st", "sysId": "dae77560c0a80165006d8051753b806c } ]



...


Description

URI

http://host_name/uc/resources/calendar/customdays

HTTP Method

DELETE

Description

Removes the specified Custom Day from a specific Calendar.

URI Parameters

See Remove a Custom Day from a Calendar: URI Parameters, below.

Example URI

http://localhost:8080/uc/resources/calendar/customdays?calendarname=ExampleCalendar&customdayid=977e7539af6e450d924a92e1ad39a256

Authentication

HTTP Basic

Example Response

  • Status 200 /OK
    Successfully removed custom day <customDay> from calendar <calendar>.
  • Status 400 /Bad Request
    Calendar <calendarName> doesn`t exist.

...