Holidays

PreviousDestroy NextDestroy

Was this helpful?

List user's holidays

Retrieve a collection of user's holidays.

get

/users/{id}/holidays

Authorizations

Path parameters

idall ofrequired

The unique ID of user.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/users/{id}/holidays' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "count": 100,
  "items": [
    {
      "name": "text",
      "region": "text",
      "consecutive": true,
      "every_year": true,
      "year_start": 1,
      "year_end": 1,
      "month_start": 1,
      "month_end": 1,
      "day_start": 1,
      "day_end": 1,
      "hour_start": 1,
      "hour_end": 1,
      "minute_start": 1,
      "minute_end": 1,
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ]
}

Create a new holiday for user

Create a new holiday for a user.

post

/users/{id}/holidays

Authorizations

Path parameters

idall ofrequired

The unique ID of user.

Body

namestring · min: 1 · max: 64required

The name of the holiday.

regionstringrequired

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanrequired

Whether the holiday consists of consecutive days.

every_yearbooleanrequired

Does the holiday take effect every year.

year_startinteger

The start year of holiday.

year_endinteger

The end year of holiday.

month_startinteger

The start month of holiday.

month_endinteger

The end month of holiday.

day_startinteger

The start day of holiday.

day_endinteger

The end day of holiday.

hour_startinteger

The start hour of holiday.

hour_endinteger

The end hour of holiday.

minute_startinteger

The start minute of holiday.

minute_endinteger

The end minute of holiday.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/users/{id}/holidays' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","region":"text","consecutive":true,"every_year":true}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Created

Retrieve a holiday of a user

get

/users/{id}/holidays/{holiday_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of holiday.

holiday_idall ofrequired

The unique ID of holiday.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/users/{id}/holidays/{holiday_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "region": "text",
  "consecutive": true,
  "every_year": true,
  "year_start": 1,
  "year_end": 1,
  "month_start": 1,
  "month_end": 1,
  "day_start": 1,
  "day_end": 1,
  "hour_start": 1,
  "hour_end": 1,
  "minute_start": 1,
  "minute_end": 1,
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Update a holiday for a user

Update a holiday that already exists.

post

/users/{id}/holidays/{holiday_id}

Authorizations

Path parameters

idall ofrequired

The unique ID of holiday.

holiday_idall ofrequired

The unique ID of holiday.

Body

namestring · min: 1 · max: 64required

The name of the holiday.

regionstring

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

consecutivebooleanrequired

Whether the holiday consists of consecutive days.

every_yearbooleanrequired

Does the holiday take effect every year.

year_startinteger

The start year of holiday.

year_endinteger

The end year of holiday.

month_startinteger

The start month of holiday.

month_endinteger

The end month of holiday.

day_startinteger

The start day of holiday.

day_endinteger

The end day of holiday.

hour_startinteger

The start hour of holiday.

hour_endinteger

The end hour of holiday.

minute_startinteger

The start minute of holiday.

minute_endinteger

The end minute of holiday.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/users/{id}/holidays/{holiday_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text","consecutive":true,"every_year":true}'

200

4XX

No body