REST API - GET Custom Calendar

This operation returns a list of custom calendars.

Request

Syntax

GET <webservice>/CommServ/CustomCalendar HTTP/1.1
Host: <host name>
Accept: {application/xml | application/json}
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Name	Description	Elements
customCalendarId	The system-generated ID assigned to the custom calendar.	customCalendarEntity
customCalendarName	The name of the customer calendar.	customCalendarEntity
_type_	Valid value is CUSTOM_CALENDAR_ENTITY.	customCalendarEntity
isDefault	The option to use this calendar for all subsequent scheduled operations, selective copy rules, and extended retention rules.	customCalendar
calendarType	The type of calendar. Valid values are: Advanced, for a custom calendar that defines custom months Basic, for a custom calendar that only defines the beginning month Standard, for the calendar that comes with the software	customCalendar
defineCustomMonths	The option to enable or disable the definition of custom months. Valid values are True or False.	customCalendar
beginYear	The year the calendar begins.	customCalendar
beginMonth	The month the calendar begins.	customCalendar
beginDate	The year, month, and day the calendar begins.
numberOfYears	The number of years that are defined for the calendar.	customCalendar
year	If you defined custom months for the calendar, the year, the name of the month, and the number of days in the month are listed for every month in the calendar.	customCalendarMonths
month		customCalendarMonths
numberOfDays		customCalendarMonths

Examples

Sample Request

GET <webservice>/CommServ/CustomCalendar HTTP/1.1
 Host: client.mydomain.com
 Accept: application/xml
 Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
 0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
 8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
 40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
 68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
 3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetCustomCalendarInfoResponse>
   <customCalendar>
     <customCalendarEntity>
       <customCalendarId>1</customCalendarId>
       <customCalendarName>Standard</customCalendarName>
       <_type_>CUSTOM_CALENDAR_ENTITY</_type_>
     </customCalendarEntity>
     <isDefault>true</isDefault>
     <calendarType>Standard</calendarType>
     <defineCustomMonths>false</defineCustomMonths>
     <beginYear>0</beginYear>
     <beginMonth>January</beginMonth>
     <numberOfYears>0</numberOfYears>
   </customCalendar>
   <customCalendar>
     <customCalendarEntity>
       <customCalendarId>2</customCalendarId>
       <customCalendarName>Fiscal Calendar</customCalendarName>
       <_type_>CUSTOM_CALENDAR_ENTITY</_type_>
     </customCalendarEntity>
     <isDefault>false</isDefault>
     <calendarType>Advanced</calendarType>
     <defineCustomMonths>true</defineCustomMonths>
     <beginYear>2018</beginYear>
     <beginMonth>April</beginMonth>
     <beginDate>2018-04-01 00:00:00</beginDate>
     <numberOfYears>1</numberOfYears>
     <customCalendarMonths>
       <year>2018</year>
       <month>April</month>
       <numberOfDays>28</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>May</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>June</month>
       <numberOfDays>30</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>July</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>August</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>September</month>
       <numberOfDays>30</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>October</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>November</month>
       <numberOfDays>30</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2018</year>
       <month>December</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2019</year>
       <month>January</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2019</year>
       <month>February</month>
       <numberOfDays>28</numberOfDays>
     </customCalendarMonths>
     <customCalendarMonths>
       <year>2019</year>
       <month>March</month>
       <numberOfDays>31</numberOfDays>
     </customCalendarMonths>
   </customCalendar>
 </App_GetCustomCalendarInfoResponse>