Get Custom Calendars

This operation returns a list of custom calendars. More Details

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• customCalendar object[]

  defineCustomMonths boolean

  isDefault boolean

  calendarType integer

  numberOfYears integer

  beginYear integer

  beginMonth integer

  customCalendarEntity object

  _type_ integer

  customCalendarId integer

  customCalendarName string

  beginDate integer

  customCalendarMonths object[]

  month integer

  year integer

  numberOfDays integer

{
  "customCalendar": [
    {
      "defineCustomMonths": true,
      "isDefault": true,
      "calendarType": 0,
      "numberOfYears": 0,
      "beginYear": 0,
      "beginMonth": 0,
      "customCalendarEntity": {
        "_type_": 0,
        "customCalendarId": 0,
        "customCalendarName": "string"
      },
      "beginDate": 0,
      "customCalendarMonths": [
        {
          "month": 0,
          "year": 0,
          "numberOfDays": 0
        }
      ]
    }
  ]
}

{
  "customCalendar": [
    {
      "defineCustomMonths": false,
      "isDefault": true,
      "calendarType": 1,
      "numberOfYears": 0,
      "beginYear": 0,
      "beginMonth": 1,
      "customCalendarEntity": {
        "_type_": 171,
        "customCalendarId": 1,
        "customCalendarName": "Standard"
      }
    },
    {
      "beginDate": 1496289600,
      "defineCustomMonths": true,
      "isDefault": false,
      "calendarType": 3,
      "numberOfYears": 1,
      "beginYear": 2017,
      "beginMonth": 6,
      "customCalendarEntity": {
        "_type_": 171,
        "customCalendarId": 2,
        "customCalendarName": "NewCalendar"
      },
      "customCalendarMonths": [
        {
          "month": 6,
          "year": 2017,
          "numberOfDays": 30
        },
        {
          "month": 7,
          "year": 2017,
          "numberOfDays": 31
        },
        {
          "month": 8,
          "year": 2017,
          "numberOfDays": 31
        },
        {
          "month": 9,
          "year": 2017,
          "numberOfDays": 30
        },
        {
          "month": 10,
          "year": 2017,
          "numberOfDays": 31
        },
        {
          "month": 11,
          "year": 2017,
          "numberOfDays": 30
        },
        {
          "month": 12,
          "year": 2017,
          "numberOfDays": 31
        },
        {
          "month": 1,
          "year": 2018,
          "numberOfDays": 31
        },
        {
          "month": 2,
          "year": 2018,
          "numberOfDays": 28
        },
        {
          "month": 3,
          "year": 2018,
          "numberOfDays": 31
        },
        {
          "month": 4,
          "year": 2018,
          "numberOfDays": 30
        },
        {
          "month": 5,
          "year": 2018,
          "numberOfDays": 31
        }
      ]
    }
  ]
}

GET /commserv/customcalendar    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/CommServ/CustomCalendar' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'