Skip to content

Updating an existing Holiday

Request

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

Path
idintegerrequired

The ID of the Model.

Query
includestring

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

  • holiday_calendar_associations (HolidayCalendarAssociation) - The Holiday Calendar Associations for this Holiday.
optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Value:"calendar_names_list"
Bodyapplication/jsonrequired
holidayobject
{
  "holiday": {
    "name": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "paid": true,
    "holiday_calendar_ids": [
      0
    ]
  }
}

Responses

Holiday has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
holidaysobject
holiday_calendar_associationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "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_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"
    }
  }
}