leave-type

Get Many LeaveTypes

Get Many LeaveTypes

Securitybearer
Request
query Parameters
select
Array of strings

Select LeaveType fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "name" "kind" "minimumDuration" "deductible" "paid" "disabled" "archived"
relations
Array of strings

Select related LeaveType resources, comma-separated. (e.g. relations=office,department)

Items Value: "leaveTypeCode"
object

Filters conditions per field. (e.g. filters[id][$eq]=507f1f77bcf86cd799439011)

limit
integer

Limit amount of received LeaveTypes. (e.g. limit=20)

offset
integer

Offset amount of received LeaveTypes. (e.g. offset=20)

object

Sort received LeaveTypes by field. (e.g. sort[id]=asc)

Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

get/leave-type
Response samples
application/json
{
  • "status": "ok",
  • "data": [
    ],
  • "total": 500,
  • "count": 50,
  • "offset": 50,
  • "relations": {
    }
}

Create One LeaveType

Create One LeaveType

Securitybearer
Request
Request Body schema: application/json
required
name
required
string
kind
string
minimumDuration
string
deductible
boolean
paid
boolean
disabled
boolean
archived
boolean
Responses
201
400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/leave-type
Request samples
application/json
{
  • "name": "string",
  • "kind": "sick_leave",
  • "minimumDuration": "day",
  • "deductible": true,
  • "paid": true,
  • "disabled": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Get One LeaveType

Get One LeaveType

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
query Parameters
select
Array of strings

Select LeaveType fields, comma-separated. (e.g. select=id,firstName,lastName,workEmail)

Items Enum: "id" "name" "kind" "minimumDuration" "deductible" "paid" "disabled" "archived"
relations
Array of strings

Select related LeaveType resources, comma-separated. (e.g. relations=office,department)

Items Value: "leaveTypeCode"
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

get/leave-type/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    },
  • "relations": {
    }
}

Update One LeaveType

Update One LeaveType

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
kind
string
minimumDuration
string
deductible
boolean
paid
boolean
disabled
boolean
archived
boolean
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

patch/leave-type/{id}
Request samples
application/json
{
  • "name": "string",
  • "kind": "sick_leave",
  • "minimumDuration": "day",
  • "deductible": true,
  • "paid": true,
  • "disabled": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Replace One LeaveType

Replace One LeaveType

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Request Body schema: application/json
required
name
string
kind
string
minimumDuration
string
deductible
boolean
paid
boolean
disabled
boolean
archived
boolean
Responses
200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

put/leave-type/{id}
Request samples
application/json
{
  • "name": "string",
  • "kind": "sick_leave",
  • "minimumDuration": "day",
  • "deductible": true,
  • "paid": true,
  • "disabled": true,
  • "archived": true
}
Response samples
application/json
{
  • "status": "ok",
  • "data": {
    }
}

Delete One LeaveType

Delete One LeaveType

Securitybearer
Request
path Parameters
id
required
string

Resource Id

Example: 507f1f77bcf86cd799439011
Responses
204
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal server error

delete/leave-type/{id}
Response samples
application/json
{
  • "status": "ok",
  • "data": { }
}
➔ Next to leave-transaction