getLeaveAttributes
- Annu
Background
This REST API is meant to provide details of the leave policy/workweek schemes/holiday schemes.
API Details
This API will require valid authentication & will expect the user API token in the request.
Read Create User API token for more details
Request
Below are the endpoints for this API based on which UpRaise app you are using -
App name | Endpoint |
|---|---|
UpRaise People | https://people.upraise.io/rest/upraise/public/1.0/leave/schemes |
UpRaise Employee Garrison | https://garrison.upraise.io/rest/upraise/public/1.0/leave/schemes |
If you are looking for details only for Schemes/Workweek/leave policies. use the below endpoints accordingly -
App name | Endpoint |
|---|---|
UpRaise People | |
UpRaise Employee Garrison |
Sample JSON response
{
"startAt": 0,
"maxResults": 5,
"total": 3,
"results": [
{
"id": 311,
"name": "Default Holiday Scheme",
"description": "This is default holiday scheme created at the time of installation.",
"type": "Holiday policy",
"isDefault": false
},
{
"id": 372,
"name": "Default Leave Policy",
"description": "This is default leave policy created at the time of installation.",
"type": "Leave policy",
"renewsOn": "19 December",
"isDefault": false
},
{
"id": 305,
"name": "Default Workweek",
"description": "This is default workweek scheme created at the time of installation.",
"type": "Work week policy",
"isDefault": false
}
]
}Response parameters
Parent | Parameter | Type | Description | Possible values |
|---|---|---|---|---|
| startAt | numeric | Page number whose results are returned in the response. | 0, 1, 2, 3, etc. |
| maxResults |
| This will show the max number of results on any given page. | 3 |
| total | numeric | This will indicate how many results in total exist for the given search. | Any number |
| results | Object | This object contains all the results of the teams retrieved from this API |
|
| id | number | Policy/Scheme/workweek id in UpRaise | 311, 234, 98, 100 |
| name | string | Name of the Policy/Scheme/workweek in UpRaise | India office leave policy. scheme or workweek |
| description | string | Description of Policy/Scheme/workweek in UpRaise | Any description related to the policy |
| type | string | Type of Policy/Scheme/workweek in UpRaise |
|
| isDefault | string | True or false based on whether the policy/scheme/workweek is default |
|
| renewsOn | string | Renewal date of leave policy. This is applicable only for leave policy. |
|