Versions Compared

Key

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

...

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

XML Response

JSON Response

Expand
titleXML Response
<calendars> <calendar exportReleaseLevel="7.2.0
<?xml version="1.0" 
exportTable
encoding="
ops_calendar
UTF-8" 
version
standalone="
6
yes"?>
<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>
    
<customDays>
<firstQuarterStart>
        <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/>
    
</customDay>
<name>Q15</name>
    
<customDay> <name>uc - Thanksgiving Day USA</name>
<opswiseGroups/>
    <secondQuarterStart>
        
<sysId>b355ca6ea2c94aaa9a8895d496396e57</sysId>
<day>15</day>
        
</customDay>
<month>Apr</month>
    </
customDays>
secondQuarterStart>
    
<firstDayOfWeek>Sunday</firstDayOfWeek>
<sysId>8aad692481794d928161539552cb61c1</sysId>
    
<firstQuarterStart>
<thirdQuarterStart>
        
<day>15</day>


        
<month>Jan<
<month>Jul</month>


    
</thirdQuarterStart>
</
firstQuarterStart>
<secondQuarterStart>
<day>15</day>
<month>Apr</month>
</secondQuarterStart>
<thirdQuarterStart>
<day>15</day>
<month>Jul</month>
</thirdQuarterStart>
<fourthQuarterStart>
<day>15</day>
<month>Oct</month>
</fourthQuarterStart>
        <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"> 
        <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>
                     <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>
</calendars>
Expand
titleJSON Response
[ { "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 }, {
calendar>
Expand
titleJSON Response
{
    "businessDays": {
        "value": "Monday,Tuesday,Wednesday,Thursday,Friday"
    },
    "comments": 
"American Calendar",
null,
    "customDays": [],


    "
exportReleaseLevel
firstDayOfWeek": "
7.2.0.0
Monday",


    "
exportTable
firstQuarterStart": 
"ops_calendar",
{
    
"firstDayOfWeek":
 
"Sunday",
   "
localCustomDays
day": 
[
"15",
   
{
     "
adjustment
month": "
None"
Jan"
    },
    "
adjustmentAmount
fourthQuarterStart": {
   
1,
     "
adjustmentType
day": "
Day
15",
        "
category
month": "
Holiday"
Oct"
    },
    "
comments
localCustomDays": 
null
[],
    "
ctype
name": "
Single Date
Q15",
    "
date
opswiseGroups": 
"2017-08-23"
[],
    "
dateList
retainSysIds": 
null
true,
    "
day
secondQuarterStart": 
1,
{
        "
dayofweek
day": "
Sun
15",
        "month": "
Jan
Apr"
,

    
"name": "local custom day"
},
    "
relfreq
sysId": "
1st
8aad692481794d928161539552cb61c1",
    "
sysId
thirdQuarterStart": 
"616ec15e7a5e40dbaae421e3688a25e5"
{
   
}
   
],
  
"
name
day": "15"
uc
,
-
 
American
 
Calendar",
  
"opswiseGroups":
 
[],
   "
sysId
month": "
da24b953c0a8016501fbcb18464d8328"
Jul"
    },
    "version": 2

}
]

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

...

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": 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
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar
Read All Custom Days of a Calendar

...