Versions Compared

Old Version 10

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

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

...

commentsexcludeRelatedexportReleaseLevelexportTablefirstDayOfWeek

Valid values:

nameopswiseGroups

List of Business Services:
 
XML

 
JSON

retainSysIds

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

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.

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

N

Anchor
comments - CCcomments - CC

Description

User-defined; description for the calendar.

N

Anchor
excludeRelated - CCexcludeRelated - CC

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 - CCexportReleaseLevel - CCn/a

Universal Controller release that the record was exported from.

read onlyN
Anchor
exportTable - CCexportTable - CCn/aRecord table information.read onlyN
Anchor
firstDayOfWeek - CCfirstDayOfWeek - CC

First Day Of Week

Day that is considered the start of the week.

N

Anchor
name - CCname - CC

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor
opswiseGroups - CCopswiseGroups - CC

Member of Business Services

Panel
Panel

N

Anchor
retainSysIds - CCretainSysIds - CC

n/a

Note
titleNote

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

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

N

AnchorsysId - CCsysId - CCsysId

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>
  • 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>14<<day>15</day>
        <month>Apr<<month>01</month>
    </secondQuarterStart>
firstQuarterStart>

 JSON

    "secondQuarterStartfirstQuarterStart": {
        "day": "1415",
        "month": "AprJan"
    }

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.

thirdQuarterStartsecondQuarterStart

3rd 2nd Quarter Start

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

    <thirdQuarterStart><secondQuarterStart>
        <day>16<<day>14</day>
        <month>Jul<<month>Apr</month>
    </thirdQuarterStart>secondQuarterStart>

 JSON

   "thirdQuarterStartsecondQuarterStart": {
        "day": "1614",
        "month": "JulApr"
    }

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.

fourthQuarterStartthirdQuarterStart

4th 3rd Quarter Start

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

    <fourthQuarterStart><thirdQuarterStart>
        <day>13<<day>16</day>
        <month>10<<month>Jul</month>
    </fourthQuarterStart>thirdQuarterStart>

 JSON

    "fourthQuarterStartthirdQuarterStart": {
        "day": "1316",
        "month": "OctJul"
    }

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.

...

namesysIdN

Property

UI Field Name

Description

Specifications

Required

Anchor
name - CCDname - CCD

Name

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y

Anchor
sysId - CCDsysId - CCD

n/a

sysId of the Calendar-to-Custom Day relationship.

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.

Anchor
Create a Calendar

...

Custom Day Properties
Create a Calendar

...

Custom Day Properties
Create a Calendar:

...

Custom Day Properties

Valid values:

Default is None (0).

adjustmentAmountadjustmentType

Property

UI Field Name

Description

Specifications

RequiredMutually Exclusive With

Anchor
adjustment name - LCDCCDadjustment
name - LCDCCD
adjustmentname

Adjustment

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

N

Anchor
adjustmentAmount - LCDadjustmentAmount - LCD

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 - LCDadjustmentType - LCD

Adjustment Type

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

Valid values:

Default is Day (1

Name

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y

Anchor
sysId - CCD
sysId - CCD
sysId

n/a

sysId of the Calendar-to-Custom Day relationship.


N

Anchor
Create a Calendar Local Custom Day Properties
Create a Calendar Local Custom Day Properties
Create a Calendar: Local Custom Day Properties

ctype

 
JSON

day

Valid values:

Default is Mon (2).

monthname

List of Dates.)

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

 
JSON

relfreq

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
adjustment - LCD
adjustment - LCD
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


Anchor
category adjustmentAmount - LCDcategory
adjustmentAmount - LCD
categoryadjustmentAmount

Category

Category of this Local Custom Day.

Valid values:

Default is Day (1)

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
comments adjustmentType - LCDcomments
adjustmentType - LCD
commentsadjustmentType

Description

Description of this Local Custom Day.

N

Anchor
ctype - LCDctype - LCD

Type

Type 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 - LCD
category - LCD
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 Single Date Day (01).

N


Anchor
date comments - LCDdate
comments - LCD
datecomments

Date

Specific date for Description

Description of this Local Custom DayFormat: yyyy-mm-dd.


Y N(if ctype =
Single Date. )

datelist


dateList
Anchor
Anchor
ctype - LCD
dateList ctype - LCD
dateListctype

Dates

Multiple specific dates for Type

Type of this Local Custom Day.

XML

Panel
Panel

Y
(if ctype
is List of Dates.)

date

Anchor
day - LCDday - LCD

Day

Day of the month.

Integer; Valid values: 1-31

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 - LCD
date - LCD
date

Date

Specific date for this Local Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
is Absolute Repeating Single Date. )

datelist

Anchor
dayofweek dateList - LCDdayofweek
dateList - LCD
dayofweekdateList

Day Of Week

Day of the week.

Y
(if ctype
is Relative Repeating Date)

Anchor
month - LCDmonth - LCD

Month

Month of the year.

Valid values:

Default is Jan (0).

Dates

Multiple specific dates for this Local 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
Relative Repeating Date
or
Absolute Repeating Date)

Anchor

date

Anchor
day - LCD
name day - LCD
nameday

NameDayName of this Local Custom

DayDay of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)


Anchor
observedRules dayofweek - LCDobservedRules
dayofweek - LCD
observedRules

Observed Rules

Panel
Panel

Valid day of week values:

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

N

Anchor
relfreq - LCDrelfreq - LCD

When

Occurrence of this day in the month.

Valid values:

Default is 1st (1dayofweek

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)


...

XML Response

JSON Response

Anchor
sysId month - LCDsysId
month - LCD
sysIdmonth

n/a

System ID in the database for this Local Custom Day.

Persisted only if retainSysIds is set to true.

Y
(if retainSysIds
is true.)

...

Description

...

URI

...

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.

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

calendarid

...

Unique ID for this Calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this Calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

Description

...

URI

...

HTTP Method

...

GET

...

Description

...

Retrieves information on all Calendar.

...

Example URI

...

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.

<calendars> <calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="6"> <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>

Month

Expand
titleXML Response

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 - LCD
name - LCD
name

Name

Name of this Local Custom Day.


Y


Anchor
observedRules - LCD
observedRules - LCD
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", 
       <comments>Default System Calendar</comments>"observedDayOfWeek" : "Fri" 
    }, { 
 <customDays>     "actualDayOfWeek" : "Sun", 
    <customDay>  "observedDayOfWeek" : "Mon" 
    }       <name>uc - Memorial Day</name>
                <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>
            </customDay>
            <customDay>
                <name>uc - Thanksgiving Day USA</name>
                <sysId>b355ca6ea2c94aaa9a8895d496396e57</sysId>
            </customDay>
        </customDays>
        <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>
        <firstDayOfWeek>Sunday</firstDayOfWeek>
        <name>System Default</name>
        <opswiseGroups />
        <sysId>77171434c0a801c9016d5b2b5d17ddee</sysId>
    </calendar>
    <calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="2"> 
   ]


Valid day of week values:

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

N


Anchor
relfreq - LCD
relfreq - LCD
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

Default is 1st (1).

Y
(if ctype
is Relative Repeating Date)


Anchor
sysId - LCD
sysId - LCD
sysId

n/a

System ID in the database for this Local Custom Day.

Persisted only if retainSysIds is set to true.

Y
(if retainSysIds
is true.)


Anchor
Delete a Calendar
Delete a Calendar
Delete a Calendar


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.

Anchor
Delete a Calendar URI Parameters
Delete a Calendar URI Parameters
Delete a Calendar: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

calendarid

Unique ID for this Calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this Calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor
List Calendars
List Calendars
List Calendars


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>American <comments Calendar</comments>>
    <firstDayOfWeek>Monday</firstDayOfWeek>
   <customDays /><firstQuarterStart>
        <firstDayOfWeek>Sunday</firstDayOfWeek><day>15</day>
        <localCustomDays><month>Jan</month>
    </firstQuarterStart>
    <fourthQuarterStart>
    <localCustomDay>    <day>15</day>
        <month>Oct</month>
    </fourthQuarterStart>
    <adjustment>None<<localCustomDays/adjustment>
    <name>Q15</name>
    <opswiseGroups/>
    <secondQuarterStart>
      <adjustmentAmount>1</adjustmentAmount>  <day>15</day>
        <month>Apr</month>
    </secondQuarterStart>
     <adjustmentType>Day</adjustmentType><sysId>8aad692481794d928161539552cb61c1</sysId>
    <thirdQuarterStart>
        <day>15</day>
        <category>Holiday</category><month>Jul</month>
    </thirdQuarterStart>
</calendar>



[
  {
  "businessDays": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "Default System Calendar",
  "customDays": [
    {
    "name": "uc - Memorial Day",
    "sysId": "daf16d70c0a801650040c4d58a3feebd"
    },
    {
    "name": "uc - Thanksgiving Day USA",
    "sysId": "b355ca6ea2c94aaa9a8895d496396e57"
    }
  ],
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_calendar",
  "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": "System Default",
  "opswiseGroups: [],
  "sysId": "77171434c0a801c9016d5b2b5d17ddee",
  "version": 6
  },
  {
  "businessDays": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [],
  "exportReleaseLevel": "7.2.0.0",
  "exportTable": "ops_calendar",
  "firstDayOfWeek": "Sunday",
  "localCustomDays": [
    {
    "adjustment": "None",
    "adjustmentAmount": 1,
    "adjustmentType": "Day",
    "category": "Holiday",
    "comments": null,
    "ctype": "Single Date",
    "date": "2017-08-23",
    "dateList": null,
    "day": 1,
    "dayofweek": "Sun",
    "month": "Jan",
    "name": "local custom day",
    "relfreq": "1st",
    "sysId": "616ec15e7a5e40dbaae421e3688a25e5"
    }
  ],
  "name": "uc - American Calendar",
  "opswiseGroups": [],
  "sysId": "da24b953c0a8016501fbcb18464d8328",
  "version": 2 
  }
]
Expand
titleJSON Response
{
    "businessDays": {
         <comments/>"value": "Monday,Tuesday,Wednesday,Thursday,Friday"
    },
    "comments": null,
    "customDays": [],
    <ctype>Single Date</ctype>"firstDayOfWeek": "Monday",
    "firstQuarterStart": {
        "day": "15",
     <date>2017-08-23</date>   "month": "Jan"
    },
    "fourthQuarterStart": {
      <dateList/>  "day": "15",
        "month": "Oct"
    },
   <day>1</day>
  "localCustomDays": [],
    "name": "Q15",
    "opswiseGroups": [],
    "retainSysIds": true,
 <dayofweek>Sun</dayofweek>   "secondQuarterStart": {
        "day": "15",
        <month>Jan</month>
"month": "Apr"
    },
    "sysId": "8aad692481794d928161539552cb61c1",
    "thirdQuarterStart": {
   <name>local custom day</name>   "day": "15",
        "month": "Jul"
    },
  <relfreq>1st</relfreq>  "version":                    <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
              </localCustomDay>
        </localCustomDays>
        <name>uc - American Calendar</name>
        <opswiseGroups/>
        <sysId>da24b953c0a8016501fbcb18464d8328</sysId>
    </calendar>
</calendars>
Expand
titleJSON Response

...

Description

...

URI

...

http://host_name/uc/resources/calendar/localcustomdays/qualifyingdates

...

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

...

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.

...

2
}


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


Description

URI

http://host_name/uc/resources/calendar/localcustomdays/qualifyingdates

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

Name

Description

Specifications

Required

Mutually Exclusive With

customdayname

Name used within the Controller to identify this Local Custom Day.

Maximum 40 alphanumerics.

Y


calendarid

Unique ID for this calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

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

XML Response

JSON Response


Expand
titleXML 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>




Expand
titleJSON Response


[
    "Mon, Jan 1, 2018",
    "Tue, Jan 2, 2019",
    "Wed, Jan 1, 2020",
    "Fri, Jan 1, 2021"
]



Anchor
List Loca Custom Day Qualifying Periods
List Loca Custom Day Qualifying Periods
List Local Custom Day Qualifying Periods


Description

URI

http://host_name/uc/resources/calendar/localcustomdays/qualifyingperiods

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

XML Response

JSON Response


Expand
titleXML 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>




Expand
titleJSON Response


[
  {
  "startDate": "Sun, Jan 1, 2017",
  "endDate": "Sat, Jan 6, 2018"
  },
  {
  "startDate": "Sun, Jan 7, 2018",
  "endDate": "Sat, Jan 5, 2019"
  }
]



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

Name

Description

Specifications

Required

Mutually Exclusive With

customdayname

Name used within the Controller to identify this Local Custom Day.

Maximum 40 alphanumerics.

Y


calendarid

Unique ID for this calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor

...

XML Response

...

JSON Response

...

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

...

titleJSON Response
[
    "Mon, Jan 1, 2018",
    "Tue, Jan 2, 2019",
    "Wed, Jan 1, 2020",
    "Fri, Jan 1, 2021"
]

...

Description

...

URI

...

http://host_name/uc/resources/calendar/localcustomdays/qualifyingperiods

...

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

...

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.

...

XML Response

...

JSON Response

...

titleXML Response

...

Modify a Calendar
Modify a Calendar
Modify a Calendar


Description

URI

http://host_name/uc/resources/calendar

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>
              <endDate>Sat, Jan 6, 2018</endDate>     <category>Holiday</qualifyingPeriod>category>
    <qualifyingPeriod>         <startDate>Sun, Jan 7, 2018</startDate>     <comments/>
   <endDate>Sat, Jan 5, 2019</endDate>     </qualifyingPeriod>     <qualifyingPeriod>     <ctype>Single Date</ctype>
  <startDate>Sun, Jan 6, 2019</startDate>         <endDate>Sat, Jan 4, 2020</endDate>     </qualifyingPeriod>date>2017-08-23</date>
    <qualifyingPeriod>         <startDate>Sun, Jan 5, 2020</startDate>     <dateList/>
   <endDate>Sat, Jan 2, 2021</endDate>     </qualifyingPeriod>     <qualifyingPeriod>     <day>1</day>
   <startDate>Sun, Jan 3, 2021</startDate>         <endDate>Sat, Jan 1, 2022</endDate>    <dayofweek>Sun</dayofweek>
    </qualifyingPeriod>     <qualifyingPeriod>         <startDate>Sun, Jan 2, 2022</startDate><month>Jan</month>
             <endDate>Sat, Dec 31, 2022</endDate>     </qualifyingPeriod>
</qualifyingPeriods>
Expand
titleJSON Response
[name>local custom day</name>
  {   "startDate": "Sun, Jan 1, 2017",   "endDate": "Sat, Jan 6, 2018"   },  <relfreq>1st</relfreq>
{   "startDate": "Sun, Jan 7, 2018",   "endDate": "Sat, Jan 5, 2019"
  }
]

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

customdayname

...

Name used within the Controller to identify this Local Custom Day.

...

Maximum 40 alphanumerics.

...

Y

...

calendarid

...

Unique ID for this calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

Description

...

URI

...

http://host_name/uc/resources/calendar

...

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

...

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

...

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

...

XML Request

...

JSON Request

...

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>

...

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://host_name/uc/resources/calendar

...

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.

...

Name

...

Description

...

Specifications

...

Required

...

Mutually Exclusive With

...

calendarid

...

Unique ID for this Calendar.

...

Y
(unless calendarname
is specified)

...

calendarname

...

calendarname

...

Name used within the Controller to identify this Calendar.

...

Maximum 40 alphanumerics.

...

Y
(unless calendarid
is specified)

...

calendarid

...

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

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

XML Response

JSON Response

Expand
titleXML Response
<calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" retainSysIds="true" version="1">
       <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>          <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"
}


Anchor
Read a Calendar
Read a Calendar
Read a Calendar


Description

URI

http://host_name/uc/resources/calendar

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

Name

Description

Specifications

Required

Mutually Exclusive With

calendarid

Unique ID for this Calendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this Calendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

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.

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": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas"},
    "sysIdcomments": "daf16d70c0a801650040c4d58a3feebd"null,
    },
    {"customDays": [],
    "namefirstDayOfWeek": "uc - Flag DayMonday",
    "sysIdfirstQuarterStart": "daf16d8fc0a801650040c4d54b2432fb"{
    }   ],
  "exportReleaseLevelday": "7.2.0.015",

 "exportTable": "ops_calendar",
  "firstDayOfWeek": "Sunday",   "localCustomDaysmonth": ["Jan"
    {},
    "adjustmentfourthQuarterStart": "None",
{
   "adjustmentAmount": 1,     "adjustmentTypeday": "Day15",
        "categorymonth": "HolidayOct",

   "comments": null},
    "ctypelocalCustomDays": "Single Date"[],
    "datename": "2017-08-23Q15",
    "dateListopswiseGroups": [],
    "dayretainSysIds": 1true,
    "dayofweeksecondQuarterStart": "Sun", {
        "monthday": "Jan15",
        "namemonth": "Apr"local
   custom day"},
    "relfreqsysId": "1st8aad692481794d928161539552cb61c1",
    "sysIdthirdQuarterStart": "616ec15e7a5e40dbaae421e3688a25e5"{
    }   ],
  "nameday": "uc - American Calendar","15",
        "opswiseGroupsmonth": [],
  "retainSysIdsJul":
true,   "sysId": "da24b953c0a8016501fbcb18464d8328" },
    "version": 12
}


Anchor
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar

...