Overview

Vacation Manager's REST API provides holiday API which allows you to:

Add holiday
Update holiday
Delete holiday from scheme
Get holidays list from scheme

Methods:

GET

...

Table of Contents

minLevel	1
maxLevel	2

GET

Get holidays list from scheme

Returns list of holidays assigned to given holiday scheme

...

Path

...

.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Path params

Response

Name	Type	Description
schemeId	int	scheme ID
Code Block
GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday

Response:

Status

colour	Green
title	200

Status

colour	Yellow
title	404

Status

colour	Red
title	500

...

Path params

Name	Type	Description
schemeId	int	scheme ID

Expand

title	Example

Path

title

GET {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday

Code Block

	Path

Response

[
    {
        "id": 1,
        "date": "1970-12-25",
        "yearly": true,
        "description": "Christmas",
        "holidaySchemeId": 1
    },
    {
        "id": 2,
        "date": "1970-01-01",
        "yearly": true,
        "description": "New year",
        "holidaySchemeId": 1
    }
]

Code Block

title	Response

...

POST

...

Add holiday

Returns and creates new holiday in holiday scheme.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

500

Path params

Name	Type	Description
schemeId	int	scheme ID

JSON body fields

Name

Type

Description

date

String

Holiday date. ISO 8601 format.

yearly

Boolean

true - holiday is repeated yearly,

false - holiday occurs one time, on selected date

description

String

Holiday description

Responses

Green200

Status

colour

Expand

title

Status

colour	Yellow
title	400

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

Example

Path

Code Block
POST {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday

Body

title

{
   "date": "2018-12-25",
    "yearly": true,
    "description": "Christmas"
}

Code Block

	Body

Response

title

{
	"id": 1,
    "date": "2018-12-25",
    "yearly": true,
    "description": "Christmas",
	"holidaySchemeId": 1	
}

Code Block

	Response

...

PATCH

...

Update holiday

Returns and Update existing holiday.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Code Block
PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday/{holidayId} Permissions

Responses:

Status

title
colour	Green

...

200

Status

colour

...

title
Yellow

...

400

Status

colour

...

title
Yellow

...

404

Status

colour

...

title
Red

...

500

Path params

Name	Type	Description
schemeId	int	scheme ID
holidayId	int	holiday ID

JSON body fields

Name

Type

Description

date

String

Holiday date. ISO 8601 format.

yearly

Boolean

true - holiday is repeated yearly,

false - holiday occurs one time, on selected date

description

String

Holiday description

Responses

Status

colour	Green
title	200

Status

colour	Yellow
title	400

Status

colour	Yellow
title	404

Status

colour	Red
title	500

Example

Expand

title	Example

Code Block

title	Path

Expand

title	Example

Path

Code Block
PATCH {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday/1

Body

  {
    "date": "2019-01-01",
    "yearly": true,
    "description": "New year"
  }

Code Block

title	Body

Response

title

  {
	"id": 1,
    "date": "2019-01-01",
    "yearly": true,
    "description": "New year",
	"holidaySchemeId": 1
  }

Code Block

	Response

...

DELETE

...

Delete holiday from scheme

Deletes existing holiday.

...

Permissions:

Status

colour	Green
title	ADMIN

Status

colour	Red
title	USER

Status

colour	Red
title	SUPERVISOR

Status

colour	Green
title	HR

Code Block
DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/{schemeId}/holiday/{holidayId} Permissions

Responses:

Status

title
colour	Green

...

204

Status

colour

...

title
Yellow

...

404

Status

title
colour	Red

...

Status

colour	Green
title	HR

500

Path params

Name	Type	Description
schemeId	int	scheme ID
holidayId	int	holiday ID

Responses

Green status

Status

colour

Expand

title

204

Status

colour	Red
title	500

colour	Yellow
title	404

Example

expand

Path

title	Example

Code Block

title

DELETE {jira_baseurl}/rest/vacation-manager/1.0/holiday-scheme/1/holiday/1

Versions Compared

Old Version 4

New Version Current

Key

Overview

Methods:

GET

GET

Get holidays list from scheme

Path

Path params

Path params

Response

POST

Add holiday

Path params

JSON body fields

Responses

Example

Path

Body

Response

PATCH

Update holiday

Path params

JSON body fields

Responses

Example

Path

Body

Response

DELETE

...

Delete holiday from scheme

Path params

Responses

Path

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

<span class="diff-html-removed" data-a11y-before="Start of deleted content" data-a11y-after="End of deleted content" id="removed-diff-0">[data-colorid=n3zsflf61r]{color:#091e42} html[data-color-mode=dark] [data-colorid=n3zsflf61r]{color:#bdd2f6}</span>Overview

Methods:

GET

GET

Get holidays list from scheme

Path

Path params

Path params

Response

POST

Add holiday

Path params

JSON body fields

Responses

Example

Path

Body

Response

PATCH

Update holiday

Path params

JSON body fields

Responses

Example

Path

Body

Response

DELETE

...

Delete holiday from scheme

Path params

Responses

Path

Overview