Holidays

List user's holidays

Retrieve a collection of user's holidays.

GEThttp://127.0.0.1:8888/api/users/{id}/holidays

Path parameters

id*all of

The unique ID of user.

Response

2004XX

OK

Body

application/json

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/holidays', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "region": "text",
      "consecutive": false,
      "every_year": false
    }
  ]
}

Create a new holiday for user

Create a new holiday for a user.

POSThttp://127.0.0.1:8888/api/users/{id}/holidays

Path parameters

id*all of

The unique ID of user.

Body

application/json

name*string

The name of the holiday.

region*string

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

consecutive*boolean

Whether the holiday consists of consecutive days.

every_year*boolean

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.

Response

2014XX

Created

Body

application/json

idall of

The unique ID of holiday.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/holidays', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "region": "text",
      "consecutive": false,
      "every_year": false
    }),
});
const data = await response.json();

Response

201

{
  "id": {}
}

Retrieve a holiday of a user

GEThttp://127.0.0.1:8888/api/users/{id}/holidays/{holiday_id}

Path parameters

id*all of

The unique ID of holiday.

holiday_id*all of

The unique ID of holiday.

Response

2004XX

OK

Body

application/json

idall of

The unique ID of holiday.

namestring

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

consecutiveboolean

Whether the holiday consists of consecutive days.

every_yearboolean

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.

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/holidays/{holiday_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": {},
  "name": "text",
  "region": "text",
  "consecutive": false,
  "every_year": false
}

Update a holiday for a user

Update a holiday that already exists.

POSThttp://127.0.0.1:8888/api/users/{id}/holidays/{holiday_id}

Path parameters

id*all of

The unique ID of holiday.

holiday_id*all of

The unique ID of holiday.

Body

application/json

name*string

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

consecutive*boolean

Whether the holiday consists of consecutive days.

every_year*boolean

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.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/users/{id}/holidays/{holiday_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "consecutive": false,
      "every_year": false
    }),
});
const data = await response.json();