UserAbsenceType

The kinds of absence a company defines, such as vacation, sick leave or further training. Every UserAbsence has one, by its typeUuid; it decides whether the absence is by the hour or by the day and whether it needs approval.

Operations

GET/v2/user-absence-types/specGET/v2/user-absence-typesPOST/v2/user-absence-typesGET/v2/user-absence-types/{userAbsenceTypeUuid}PATCH/v2/user-absence-types/{userAbsenceTypeUuid}

---

OpenAPI Spec

GET

/v2/user-absence-types/spec

Get OpenAPI 3.1.0 spec for UserAbsenceType API

Responses

Returns OpenAPI 3.1.0 spec for UserAbsenceType API

Content-Type

application/json

{

}

GET

/v2/user-absence-types/spec

Playground

Samples

---

List UserAbsenceTypes

GET

/v2/user-absence-types

List UserAbsenceTypes

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

uuid

name

deactivatedAt

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"color": "string",

  

  

  

"needApproval": true,

  

  

  

"needCompensation": true,

  

  

  

"countAsWorkingTime": true,

  

  

  

"order": 0,

  

  

  

"deactivatedAt": "string",

  

  

  

"isAbsenceHourly": true,

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/user-absence-types

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

name

deactivatedAt

createdAt

updatedAt

Samples

---

Create a new UserAbsenceType

POST

/v2/user-absence-types

Create a new UserAbsenceType

Authorizations

apiKey

Type

HTTP (bearer)

Request Body

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"color": "string",

  

"needApproval": true,

  

"needCompensation": false,

  

"countAsWorkingTime": false,

  

"order": 1,

  

"isAbsenceHourly": false

}

Responses

UserAbsenceType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"color": "string",

  

"needApproval": true,

  

"needCompensation": true,

  

"countAsWorkingTime": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"isAbsenceHourly": true,

  

"createdAt": "string",

  

"updatedAt": "string"

}

POST

/v2/user-absence-types

Playground

Server

Authorization

apiKey

Body

Samples

---

Get a UserAbsenceType

GET

/v2/user-absence-types/{userAbsenceTypeUuid}

Get a UserAbsenceType by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

userAbsenceTypeUuid*

Type

string

Required

Format

"uuid"

Responses

UserAbsenceType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"color": "string",

  

"needApproval": true,

  

"needCompensation": true,

  

"countAsWorkingTime": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"isAbsenceHourly": true,

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/user-absence-types/{userAbsenceTypeUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userAbsenceTypeUuid*

Samples

---

Update a UserAbsenceType

PATCH

/v2/user-absence-types/{userAbsenceTypeUuid}

Update a UserAbsenceType by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

userAbsenceTypeUuid*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

  

"name": "string",

  

"color": "string",

  

"needApproval": true,

  

"needCompensation": true,

  

"order": 0,

  

"deactivatedAt": "string"

}

Responses

UserAbsenceType found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"color": "string",

  

"needApproval": true,

  

"needCompensation": true,

  

"countAsWorkingTime": true,

  

"order": 0,

  

"deactivatedAt": "string",

  

"isAbsenceHourly": true,

  

"createdAt": "string",

  

"updatedAt": "string"

}

PATCH

/v2/user-absence-types/{userAbsenceTypeUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userAbsenceTypeUuid*

Body

Samples

---