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

Holiday Calendars

Holiday Calendars define the days in which account members are unavailable to work due to company-wide days off.

Fetching a list of Holiday Calendars

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

Request
query Parameters
matching
string

Limits holiday calendars to names matching the specified query.

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: "default"

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

Valid values: default, name:asc, and name:desc.

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

A list of Holiday Calendars have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/holiday_calendars
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendars": {
    }
}
Creating a new Holiday Calendar
This endpoint returns structured Holiday Calendar 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_calendars top-level JSON key.
Please see our Response Format section for more information.


Request 
Request Body schema: application/json
required
object
 
name
required
string
The name of the holiday calendar.


 
Responses 
200
Holiday Calendar has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/holiday_calendars
Request samples 
application/json
{
  • "holiday_calendar": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendars": {
    }
}
Fetching a single Holiday Calendar
This endpoint returns structured Holiday Calendar 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_calendars top-level JSON key.
Please see our Response Format section for more information.


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


 
Responses 
200
The Holiday Calendar has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/holiday_calendars/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendars": {
    }
}
Updating an existing Holiday Calendar
This endpoint returns structured Holiday Calendar 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_calendars top-level JSON key.
Please see our Response Format section for more information.


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


 
Request Body schema: application/json
required
object
 
name
required
string
The name to which the holiday calendar is being changed.


 
Responses 
200
Holiday Calendar has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/holiday_calendars/{id}
Request samples 
application/json
{
  • "holiday_calendar": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "holiday_calendars": {
    }
}
Deleting an existing Holiday Calendar
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 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_calendars/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Holidays