This operation creates a custom calendar.
Request
Syntax
POST <webservice>/CommServ/CustomCalendar HTTP/1.1 Host: <host name> Accept: {application/xml | application/json} Authtoken: <authentication token> Content-type: application/xml <create_custom_calendar_template.xml>
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. |
|
Content-type |
The media type contained in the request body. |
Request Body
Download the XML file required for this request: create_custom_calendar_template.xml. The following table displays the parameters for the request body.
|
Parameter |
Description |
Element |
|---|---|---|
|
customCalendarName |
The name of the customer calendar. |
customCalendarEntity |
|
isDefault |
The option to use this calendar for all subsequent scheduled operations, selective copy rules, and extended retention rules. |
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. For example: <beginDate>2017-01-01 00:00:00</beginDate> |
|
|
numberOfYears |
The number of years that are defined for the calendar. |
customCalendar |
|
year |
If the defineCustomMonths parameter is set to true, the year, the name of the month, and the number of days in the month for each month that requires a custom number of days. Add a customCalendarMonths block for each month you need to define. For example: <customCalendarMonths> |
customCalendarMonths |
|
month |
customCalendarMonths |
|
|
numberOfDays |
customCalendarMonths |
Response
Response Parameters
|
Parameter |
Description |
Element |
|
value |
The possible codes. Valid values are:
|
attributes |
|
name |
The description of the code. Not all codes have a description. |
attributes |
Examples
Sample Request
This request creates a basic calendar that does not include custom months.
POST <webservice>/CommServ/CustomCalendar HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Content-type: application/xml
<App_SetCustomCalendarInfoRequest customCalendarOperationType="1">
<customCalendar>
<customCalendarEntity>
<customCalendarName>fiscal</customCalendarName>
</customCalendarEntity>
<isDefault>false</isDefault>
<defineCustomMonths>false</defineCustomMonths>
<beginMonth>April</beginMonth>
</customCalendar>
</App_SetCustomCalendarInfoRequest>
This request creates an advanced calendar that includes a custom month.
<App_SetCustomCalendarInfoRequest customCalendarOperationType="1">
<customCalendar>
<customCalendarEntity>
<customCalendarName>fiscal</customCalendarName>
</customCalendarEntity>
<isDefault>false</isDefault>
<defineCustomMonths>true</defineCustomMonths>
<beginYear>2017</beginYear>
<beginMonth>January</beginMonth>
<beginDate>2017-01-01 00:00:00</beginDate>
<numberOfYears>1</numberOfYears>
<customCalendarMonths>
<year>2017</year>
<month>January</month>
<numberOfDays>15</numberOfDays>
</customCalendarMonths>
</customCalendar>
</App_SetCustomCalendarInfoRequest>
Sample Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_SetCustomCalendarInfoResponse>
<processinginstructioninfo>
<attributes name="exitval" value="0"/>
</processinginstructioninfo>
</App_SetCustomCalendarInfoResponse>