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

Holiday Calendar Memberships

A list of all calendars associated to an individual user.

Fetching a list of Holiday Calendar Memberships

This endpoint returns structured Holiday Calendar Membership 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_memberships top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_holiday_calendar_id
integer <int32>

Include holiday calendar memberships for the specified holiday calendar ID.

by_user_id
integer <int32>

Include holiday calendar memberships for the specified user ID.

created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

include
string

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

  • holiday_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.
  • user (User) - The User participating in the Holiday Calendar.
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.

order
string
Default: "start_date:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: start_date:asc and start_date:desc.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

Responses
200

A list of Holiday Calendar Memberships 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_memberships
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_memberships": {
    },
  • "holiday_calendars": {
    },
  • "users": {
    }
}
Creating a new Holiday Calendar Membership
This endpoint returns structured Holiday Calendar Membership 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_memberships 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_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.
    • 

  • user (User) - The User participating in the Holiday Calendar.
    • 



 
Request Body schema: application/json
required
object
 
start_date
required
string <date> 
When the calendar begins to apply to the user. The date must be in ISO 8601 format.


 
holiday_calendar_id
required
integer <int32> 
The ID of the calendar that is associated to the user.


 
user_id
required
integer <int32> 
The ID of the user assigned to the calendar.


 
Responses 
200
Holiday Calendar Membership 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_memberships
Request samples 
application/json
{
  • "holiday_calendar_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_memberships": {
    },
  • "holiday_calendars": {
    },
  • "users": {
    }
}
Fetching a single Holiday Calendar Membership
This endpoint returns structured Holiday Calendar Membership 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_memberships 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_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.
    • 

  • user (User) - The User participating in the Holiday Calendar.
    • 



 
Responses 
200
The Holiday Calendar Membership 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_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_memberships": {
    },
  • "holiday_calendars": {
    },
  • "users": {
    }
}
Updating an existing Holiday Calendar Membership
This endpoint returns structured Holiday Calendar Membership 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_memberships 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_calendar (HolidayCalendar) - The Holiday Calendar associated with this HolidayCalendarMembership.
    • 

  • user (User) - The User participating in the Holiday Calendar.
    • 



 
Request Body schema: application/json
required
object
 
start_date
string <date> 
The new date that the calendar begins to apply to the user. The date must be in ISO 8601 format.


 
holiday_calendar_id
integer <int32> 
The ID of the calendar that is associated to the user.


 
Responses 
200
Holiday Calendar Membership has been updated.


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


put/holiday_calendar_memberships/{id}
Request samples 
application/json
{
  • "holiday_calendar_membership": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendar_memberships": {
    },
  • "holiday_calendars": {
    },
  • "users": {
    }
}
Deleting an existing Holiday Calendar Membership
Unlink the calendar from the user.


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 Membership 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_memberships/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Holiday Calendars