Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

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.

Fetching a list of Holiday Calendar Associations

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.

Request
query Parameters
by_holiday_calendar_id
integer <int32>

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

by_holiday_name
string

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

include
string

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.
only
string

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.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
Responses
200

A list of Holiday Calendar Associations have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/holiday_calendar_associations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_associations": {
    },
  • "holidays": {
    },
  • "holiday_calendars": {
    }
}
Creating a new Holiday Calendar Association
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.


Request 
query Parameters
include
string
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.
    • 



 
Request Body schema: application/json
required
object
 
holiday_id
required
integer <int32> 
The ID of the holiday to be associated with a calendar.


 
holiday_calendar_id
required
integer <int32> 
The ID of the calendar to be associated with a holiday.


 
Responses 
200
Holiday Calendar Association has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/holiday_calendar_associations
Request samples 
application/json
{
  • "holiday_calendar_association": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_associations": {
    },
  • "holidays": {
    },
  • "holiday_calendars": {
    }
}
Fetching a single Holiday Calendar Association
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.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
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.
    • 



 
Responses 
200
The Holiday Calendar Association has been retrieved.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/holiday_calendar_associations/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_associations": {
    },
  • "holidays": {
    },
  • "holiday_calendars": {
    }
}
Deleting an existing Holiday Calendar Association
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Holiday Calendar Association has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/holiday_calendar_associations/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Holiday Calendar Memberships