GET_SICK_VACATION

Self-service web service that returns a history of sick and vacation hours for the calling user.

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/erp/hr/get_sick_vacation

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/* GET

Paths

GET /*

Uses default content-types: application/json

200 OK

The default response type is JSON. Add an Accept header with value=application/xml to return an XML response.

Example for application/json
{
"get_sick_vacation": {
"leave_data": {
"byu_id": "999999999",
"leave_plan": [
{
"leave_accrual": [
{
"accrual_process_date": "2017-02-28",
"hours_adjust_unprocessed": "0",
"hours_adjust_ytd": "0",
"hours_carryover": "136",
"hours_earned_ytd": "16",
"hours_taken": "0",
"hours_taken_unprocessed": "0",
"hours_taken_ytd": "24",
"leave_hours_balance": "128"
},
{
"accrual_process_date": "2017-01-31",
"hours_adjust_unprocessed": "0",
"hours_adjust_ytd": "0",
"hours_carryover": "136",
"hours_earned_ytd": "8",
"hours_taken": "0",
"hours_taken_unprocessed": "24",
"hours_taken_ytd": "0",
"leave_hours_balance": "120"
}
]
,
"plan_type": "50",
"plan_type_descr": "Sick"
},
{
"leave_accrual": [
{
"accrual_process_date": "2017-02-28",
"hours_adjust_unprocessed": "0",
"hours_adjust_ytd": "0",
"hours_carryover": "104.00001",
"hours_earned_ytd": "29.333334",
"hours_taken": "0",
"hours_taken_unprocessed": "0",
"hours_taken_ytd": "30",
"leave_hours_balance": "103.333344"
},
{
"accrual_process_date": "2017-01-31",
"hours_adjust_unprocessed": "0",
"hours_adjust_ytd": "0",
"hours_carryover": "104.00001",
"hours_earned_ytd": "14.666667",
"hours_taken": "0",
"hours_taken_unprocessed": "30",
"hours_taken_ytd": "0",
"leave_hours_balance": "88.666677"
}
]
,
"plan_type": "51",
"plan_type_descr": "Vacation"
}
]
,
"name": "Geoffrey Smithson"
}
}
}

Schema definitions

accrual_process_date: string (date)

byu_id: string , must match ^[0-9]{9}$

get_sick_vacation: object

leave_data: leave_data

hours_adjust_unprocessed: number (double)

hours_adjust_ytd: number (double)

hours_carryover: number (double)

hours_earned_ytd: number (double)

hours_taken: number (double)

hours_taken_unprocessed: number (double)

hours_taken_ytd: number (double)

leave_accrual: object

accrual_process_date: accrual_process_date
hours_carryover: hours_carryover
hours_earned_ytd: hours_earned_ytd
hours_taken_ytd: hours_taken_ytd
hours_adjust_ytd: hours_adjust_ytd
hours_taken_unprocessed: hours_taken_unprocessed
hours_adjust_unprocessed: hours_adjust_unprocessed
hours_taken: hours_taken
leave_hours_balance: leave_hours_balance

leave_data: object

byu_id: byu_id
name: name
leave_plan: leave_plan

leave_hours_balance: number (double)

leave_plan: object

plan_type: plan_type
plan_type_descr: plan_type_descr
leave_accrual: leave_accrual

name: string (up to 50 chars)

plan_type: string , x ∈ { 50 , 51 }

plan_type_descr: string , x ∈ { Sick , Vacation }

Service Path: 
/domains/erp/hr/get_sick_vacation
Domain or University API: 
/domains/erp/hr/get_sick_vacation

Community

 

Don't see your question listed here? Ask!