Versions Compared

Key

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

...

XML Response

JSON Response

Expand
titleXML Response
<calendars>
    <calendar exportReleaseLevel="7.2.0<?xml version="1.0" exportTableencoding="ops_calendarUTF-8" versionstandalone="6yes"?>
<calendar retainSysIds="true" version="2">
     <businessDays>Monday<businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>businessDays>
    <customDays/>
   <comments>Default System<comments Calendar</comments>
    <firstDayOfWeek>Monday</firstDayOfWeek>
    <firstQuarterStart>
<customDays>        <day>15</day>
    <customDay>    <month>Jan</month>
    </firstQuarterStart>
    <fourthQuarterStart>
  <name>uc - Memorial Day</name>   <day>15</day>
        <month>Oct</month>
    <sysId>daf16d70c0a801650040c4d58a3feebd</sysId>fourthQuarterStart>
    <localCustomDays/>
    <name>Q15</name>
  </customDay>  <opswiseGroups/>
    <secondQuarterStart>
     <customDay>   <day>15</day>
        <month>Apr</month>
    </secondQuarterStart>
<name>uc - Thanksgiving Day USA<<sysId>8aad692481794d928161539552cb61c1</name>sysId>
    <thirdQuarterStart>
        <day>15</day>
  <sysId>b355ca6ea2c94aaa9a8895d496396e57</sysId>       <month>Jul</month>
     </customDay>
       thirdQuarterStart>
</customDays>calendar>
Expand
titleJSON Response
{
    "businessDays": {
  <firstDayOfWeek>Sunday</firstDayOfWeek>      "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
 <localCustomDays>   },
    "comments": null,
     <localCustomDay>"customDays": [],
    "firstDayOfWeek": "Monday",
    "firstQuarterStart": {
         <adjustment>None</adjustment>
"day": "15",
        "month": "Jan"
    },
     <adjustmentAmount>1</adjustmentAmount>"fourthQuarterStart": {
        "day": "15",
        "month": "Oct"
 <adjustmentType>Day</adjustmentType>   },
    "localCustomDays": [],
    "name": "Q15",
    "opswiseGroups":  <category>Holiday</category>[],
    "retainSysIds": true,
    "secondQuarterStart": {
        "day":  <comments/>"15",
        "month": "Apr"
    },
    "sysId": "8aad692481794d928161539552cb61c1",
 <ctype>Single Date</ctype>  "thirdQuarterStart": {
        "day": "15",
        <date>2017-08-23</date>
"month": "Jul"
    },
    "version":           <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"> 
        <businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
        <comments>American Calendar</comments>
        <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>
    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

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 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>
    <dateList/>    <endDate>Sat, Jan 6, 2018</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
    <day>1</day>    <startDate>Sun, Jan 7, 2018</startDate>
        <endDate>Sat, Jan 5, 2019</endDate>
    <dayofweek>Sun</dayofweek>qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 6, 2019</startDate>
    <month>Jan</month>    <endDate>Sat, Jan 4, 2020</endDate>
    </qualifyingPeriod>
    <qualifyingPeriod>
    <name>local custom day</name>  <startDate>Sun, Jan 5, 2020</startDate>
        <endDate>Sat, Jan 2, 2021</endDate>
    <relfreq>1st</relfreq>qualifyingPeriod>
    <qualifyingPeriod>
        <startDate>Sun, Jan 3, 2021</startDate>
    <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>    <endDate>Sat, Jan 1, 2022</endDate>
    </qualifyingPeriod>
  </localCustomDay>  <qualifyingPeriod>
      </localCustomDays>  <startDate>Sun, Jan 2, 2022</startDate>
   <name>uc - American Calendar</name>  <endDate>Sat, Dec      <opswiseGroups/>
        <sysId>da24b953c0a8016501fbcb18464d8328</sysId>31, 2022</endDate>
    </calendar>qualifyingPeriod>
</calendars>qualifyingPeriods>


Expand
titleJSON Response


[
  {
  "businessDaysstartDate": {
    "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  }"Sun, Jan 1, 2017",
  "commentsendDate": "DefaultSat, SystemJan Calendar"6,   "customDays2018":
[  },
  {
    "namestartDate": "ucSun, -Jan Memorial7, Day2018",
    "sysIdendDate": "daf16d70c0a801650040c4d58a3feebd"Sat, Jan 5, 2019"
  },
    {
    "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 } ]

...

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

...

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.

...

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

...

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

...

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
Modify a Calendar
Modify a Calendar
Modify a Calendar


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

Anchor
Read a Calendar
Read a Calendar
Read a Calendar


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

customdayname

Name

Description

Specifications

Required

Mutually Exclusive With

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

Maximum 40 alphanumerics.

Y

calendarid

Unique ID for this calendarCalendar.


Y
(unless calendarname
is specified)

calendarname

calendarname

Name used within the Controller to identify this calendarCalendar.

Maximum 40 alphanumerics.

Y
(unless calendarid
is specified)

calendarid

Anchor

...

Read a Calendar Example Response

...

Read a Calendar Example Response

...

Read a Calendar

...

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

...

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

...

titleXML Response

...

: 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>
           <dayofweek>Sun</dayofweek><day>15</day>
        <month>Jan</month>
            <month>Jan</month>firstQuarterStart>
    <fourthQuarterStart>
        <day>15</day>
       <name>local custom day</name> <month>Oct</month>
    </fourthQuarterStart>
    <localCustomDays/>
    <name>Q15</name>
      <relfreq>1st<<opswiseGroups/relfreq>
    <secondQuarterStart>
                <sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
 <day>15</day>
        <month>Apr</month>
    </localCustomDay>secondQuarterStart>
    <sysId>8aad692481794d928161539552cb61c1</sysId>
  </localCustomDays>  <thirdQuarterStart>
     <name>uc - American Calendar<<day>15</name>day>
       <opswiseGroups <month>Jul</>
  month>
    <sysId>da24b953c0a8016501fbcb18464d8328</sysId>thirdQuarterStart>
</calendar>
Expand
titleJSON Response
{
    "businessDays": {
        "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
  },
  "comments": "American Calendar",
  "customDays": [
    {
    "name": "uc - Christmas",
    "sysId": "daf16d70c0a801650040c4d58a3feebd,Friday"
    },
     {"comments": null,
    "namecustomDays": "uc - Flag Day [],
    "firstDayOfWeek": "Monday",
    "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

...