Skip to content

Holiday Calendar Associations

A Holiday Calendar Association represents the relationship between holiday objects and calendar objects. A Holiday can be associated with several different calendars. To associate a holiday with a calendar, create a Holiday Calendar Assocation.

Operations

Fetching a list of Holiday Calendar Associations

Request

This endpoint returns structured Holiday Calendar Association objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the holiday_calendar_associations top-level JSON key. Please see our Response Format section for more information.

Query
by_holiday_calendar_idinteger, (int32)

Show only Holiday Calendar Associations that are associated with a specific Holiday Calendar.

by_holiday_namestring

Show only Holiday Calendar Associations associated with Holidays that have a name which matches the search parameter.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • holiday (Holiday) - The Holiday associated with this HolidayCalendarAssociation.
  • holiday_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarAssociation.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/holiday_calendar_associations?by_holiday_calendar_id=0&by_holiday_name=string&include=string&only=string&page=1&per_page=20'

Responses

A list of Holiday Calendar Associations have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
holiday_calendar_associationsobject
holidaysobject
holiday_calendarsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "holiday_calendar_associations": {
    "property1": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    },
    "property2": {
      "holiday_calendar_id": "string",
      "holiday_calendar_name": "string",
      "holiday_id": "string",
      "holiday_name": "string"
    }
  },
  "holidays": {
    "property1": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    },
    "property2": {
      "calendar_names_list": "string",
      "end_date": "2019-08-24",
      "holiday_calendar_association_ids": [
        "string"
      ],
      "name": "string",
      "paid": true,
      "start_date": "2019-08-24",
      "total_hours": 0
    }
  },
  "holiday_calendars": {
    "property1": {
      "default": true,
      "name": "string"
    },
    "property2": {
      "default": true,
      "name": "string"
    }
  }
}