...
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 - 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 |
---|
firstDayOfWeek - CC | firstDayOfWeek - CC | firstDayOfWeek
First Day Of Week | Day that is considered the start of the week. | Valid values:
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 |
---|
JSON
Panel |
---|
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.
Note |
---|
|
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 |
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Name
...
Name used within the Controller to identify this Custom Day.
...
Maximum 40 alphanumerics.
...
Y
...
n/a
...
sysId of the Calendar-to-Custom Day relationship.
...
N
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
Mutually Exclusive With
...
Adjustment
...
If ctype
is Relative Repeating Date (1); Adjustment for the repeating date.
Valid values:
Default is None (0).
...
N
...
Adjustment Amount
...
If adjustment
is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made.
...
Default is 1.
...
N
...
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).
...
N
...
Category
...
Category of this Local Custom Day.
Valid values:
Default is Day (1).
...
N
...
Description
...
Description of this Local Custom Day.
...
N
...
Type
...
Type of this Local Custom Day.
Valid values:
Default is Single Date (0).
...
N
...
Date
...
Specific date for this Local Custom Day
...
Format: yyyy-mm-dd.
...
Y
(if ctype
=
Single Date. )
...
datelist
...
Dates
...
Multiple specific dates for this Local Custom Day.
XML
...
JSON
...
Y
(if ctype
is List of Dates.)
...
date
...
Day
...
Day of the month.
...
Integer; Valid values: 1-31.
...
Y
(if ctype
is Absolute Repeating Date)
...
Day Of Week
...
Day of the week.
Valid values:
Default is Mon (2).
...
Y
(if ctype
is Relative Repeating Date)
...
Month
...
Month of the year.
Valid values:
Default is Jan (0).
...
Y
(if ctype
is
Relative Repeating Date
or
Absolute Repeating Date)
...
Name
...
Name of this Local Custom Day.
...
Y
...
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
...
JSON
...
Valid day of week values:
- Sun, Mon, Tue, Wed, Thu, Fri, Sat
...
N
...
When
...
Occurrence of this day in the month.
Valid values:
Default is 1st (1).
...
Y
(if ctype
is Relative Repeating Date)
...
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.
...
- 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 /> ), businessDays defaults to Monday,Tuesday,Wednesday,Thursday,Friday. - If
businessDays is not blank, useDefaultIfBlank is ignored. - If useDefaultIfBlank is set to true (
<businessDays useDefaultIfBlank="true"></businessDays> ), businessDays defaults 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 only | N |
Anchor |
---|
| exportTable - CC |
---|
| exportTable - CC |
---|
|
exportTable | n/a | Record table information. | read only | N |
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 |
| 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 |
---|
| In XML web services, retainSysIds is specified as an attribute in the <calendar> element. |
| Valid values: true/false (default is true). | N |
| 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: | 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: | 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: | 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: | 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 PropertiesProperty | UI Field Name | Description | Specifications | Required |
---|
| Name | Name used within the Controller to identify this Custom Day. | Maximum 40 alphanumerics. | Y |
| 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 PropertiesProperty | UI Field 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.
...
XML Response | JSON Response |
---|
Expand |
---|
| <calendars>
<calendar exportReleaseLevel="7.2.0.0" exportTable="ops_calendar" version="6">
<businessDays>Monday,Tuesday,Wednesday,Thursday,Friday</businessDays>
<comments>Default System Calendar</comments>
<customDays>
<customDay>
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 |
---|
| adjustmentAmount - LCD |
---|
| adjustmentAmount - LCD |
---|
|
adjustmentAmount | Adjustment Amount | If adjustment is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made. | Default is 1. | N |
|
Anchor |
---|
| adjustmentType - LCD |
---|
| adjustmentType - LCD |
---|
|
adjustmentType | 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 Day (1). | N |
|
Anchor |
---|
| comments - LCD |
---|
| comments - LCD |
---|
|
comments | Description | Description of this Local Custom Day. |
| N |
|
| Type | Type of this Local Custom Day. | 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 |
|
| Date | Specific date for this Local Custom Day | Format: yyyy-mm-dd. | Y (if ctype = Single Date. ) | datelist
|
Anchor |
---|
| dateList - LCD |
---|
| dateList - LCD |
---|
|
dateList | Dates | Multiple specific dates for this Local Custom Day. | XML
Panel |
---|
<dateList>
<date>2017-12-13</date>
<date>2017-12-14</date>
</dateList> |
JSON
| Y (if ctype is List of Dates.) | date
|
| Day | Day of the month. | Integer; Valid values: 1-31. | Y (if ctype is Absolute Repeating Date) |
|
Anchor |
---|
| dayofweek - LCD |
---|
| dayofweek - LCD |
---|
|
dayofweek | 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) |
|
| Month | 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) |
|
| 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> <dateList />
<actualDayOfWeek>Sat</actualDayOfWeek> <day>1</day>
<dayofweek>Sun</dayofweek><observedDayOfWeek>Fri</observedDayOfWeek>
</observedRule>
<observedRule> <month>Jan</month>
<name>local custom day</name> <actualDayOfWeek>Sun</actualDayOfWeek>
<relfreq>1st</relfreq> <observedDayOfWeek>Mon</observedDayOfWeek>
<sysId>616ec15e7a5e40dbaae421e3688a25e5</sysId>
/observedRule>
</localCustomDay>
observedRules> |
JSON
Panel |
---|
"observedRules" : [ {
</localCustomDays> "actualDayOfWeek" : "Sat",
<firstDayOfWeek>Sunday</firstDayOfWeek> "observedDayOfWeek" : "Fri"
<name>System Default</name> }, {
<opswiseGroups />
"actualDayOfWeek" : "Sun",
<sysId>77171434c0a801c9016d5b2b5d17ddee</sysId>
</calendar> "observedDayOfWeek" : "Mon"
} <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 |
---|
| [
{
"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
}
]] |
| 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) |
|
| 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 Anchor |
---|
| Delete a Calendar URI Parameters |
---|
| Delete a Calendar URI Parameters |
---|
|
Delete a Calendar: URI ParametersName | 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 Anchor |
---|
| List Calendars Example Response |
---|
| List Calendars Example Response |
---|
|
List Calendars: Example ResponseXML Response | JSON Response |
---|
Expand |
---|
| <?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 |
---|
| {
"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
...
Anchor |
---|
| Read a Calendar Example Response |
---|
| Read a Calendar Example Response |
---|
|
Read a Calendar: Example Response
...
XML Response
...
JSON 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 |
---|
| <?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/>
<relfreq>1st</relfreq>
<name>Q15</name>
<opswiseGroups/>
<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 |
---|
| {
"businessDays": {
"value": "Monday,Tuesday,Wednesday,Thursday,Friday"
},
"comments": "American Calendar",
"customDays": [
| {
" namebusinessDays": {
"uc - Christmas", " sysIdvalue": " daf16d70c0a801650040c4d58a3feebdMonday,Tuesday,Wednesday,Thursday,Friday"
},
{ "comments": null,
" namecustomDays": "uc - Flag Day"[],
" sysIdfirstDayOfWeek": " daf16d8fc0a801650040c4d54b2432fbMonday",
}"firstQuarterStart": {
],
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_calendar",
" firstDayOfWeekday": " Sunday15",
"localCustomDays": [ {
"month": "Jan"
"adjustment": "None" },
" adjustmentAmountfourthQuarterStart": {
1, " adjustmentTypeday": " Day15",
" categorymonth": " HolidayOct" ,
"comments": null},
" ctypelocalCustomDays": "Single Date"[],
" datename": " 2017-08-23Q15",
" dateListopswiseGroups": [],
" dayretainSysIds": 1true,
" dayofweeksecondQuarterStart": "Sun",{
" monthday": " Jan15",
" namemonth": " local custom dayApr" ,
"relfreq": "1st"},
"sysId": " 616ec15e7a5e40dbaae421e3688a25e58aad692481794d928161539552cb61c1",
}"thirdQuarterStart": {
], "name": "uc - American Calendar", " opswiseGroupsday": [],"15",
"retainSysIds": true, " sysIdmonth": " da24b953c0a8016501fbcb18464d8328",Jul"
},
"version": 12
}
|
|
Anchor |
---|
| Read All Custom Days of a Calendar |
---|
| Read All Custom Days of a Calendar |
---|
|
Read All Custom Days of a Calendar
...
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 |
---|
| [
{
"adjustment": "None",
"adjustmentAmount": 1,
"adjustmentType": "Day",
"category": "Holiday",
"comments": "New Year's Day - Jan 1st",
"ctype": "Absolute Repeating Date",
"date: null,
"dateList: [ ],
"dateList: [ ],
"day": 1,
"dayofweek": "Sun", "dayexportReleaseLevel": 1"7.2.0.0", "dayofweekexportTable": "Sunops_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
}
]
|
|
...
Property | UI Field Name | Description |
---|
Anchor |
---|
| adjustment - RACD |
---|
| adjustment - RACD |
---|
|
adjustment | Adjustment | Adjustment for the repeating date. |
Anchor |
---|
| adjustmentAmount - RACD |
---|
| adjustmentAmount - RACD |
---|
|
adjustmentAmount | Adjustment Amount | Amount (number of days) of the adjustment to be made. |
Anchor |
---|
| adjustmentType - RACD |
---|
| adjustmentType - RACD |
---|
|
adjustmentType | Adjustment Type | Type of day on which to make the adjustment. |
Anchor |
---|
| category - RACD |
---|
| category - RACD |
---|
|
category | Category | Category of this Local Custom Day. |
Anchor |
---|
| comments - RACD |
---|
| comments - RACD |
---|
|
comments | Description | Description of this Custom Day. |
| Type | Type of this Custom Day. |
| Date | Specific date for this Custom Day |
Anchor |
---|
| dateList - RACD |
---|
| dateList - RACD |
---|
|
dateList | Dates | Multiple specific dates for this Custom Day. |
| Day | Day of the month. |
Anchor |
---|
| dayofweek - RACD |
---|
| dayofweek - RACD |
---|
|
dayofweek | Day Of Week | Day of the week. |
Anchor |
---|
| exportReleaseLevel - CC |
---|
| exportReleaseLevel - CC |
---|
|
exportReleaseLevel | n/a | Universal Controller release that the record was exported from. |
Anchor |
---|
| exportTable - CC |
---|
| exportTable - CC |
---|
|
exportTable | n/a | Record table information. |
Anchor |
---|
| holiday - RACD |
---|
| holiday - RACD |
---|
|
holiday | Holiday | Deprecated. Indication of whether or not this Custom Day is a holiday. |
| Month | Month of the year. |
| Name | Name of this Custom Day. |
Anchor |
---|
| period - RACD |
---|
| period - RACD |
---|
|
period | Period | Deprecated. Indication of whether or not this Custom Day defines a custom period of days. |
Anchor |
---|
| relfreq - RACD |
---|
| relfreq - RACD |
---|
|
relfreq | When | Occurrence of this day in the month. |
| n/a | System ID in the database for this Custom Day. |
...