Tuition_Benefit_Eligibility

Determines if someone is eligible to get the tuition benefit for a specified number of credits in a given term. The service will look up how many credits the person was, is, or will be enrolled in on the specified date, adding the additional credits specified in the web service request, and compares the total credits with the Tuition Eligibility rules.

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

Base URL: /domains/erp/hr/tuition_benefit_eligibility

Version: v1

Schemes:

Summary

Path Operation Description
/* GET

Determine tuition benefit eligibility for employee

Paths

Determine tuition benefit eligibility for employee

GET /*

Gets the eligibility for an employee for the Tuition Benefit

byu_id

A 9 digit employee ID

query string , must match ^[0-9]{9}$ #/parameters/byu_id
program_date

The date to check against in the format defined by RFC 3339, section 5.6, for example: 2017-07-21

query string (date) #/parameters/program_date
credit_hours

The number of credit hours to request, in decimal form. E.g 12.5, 6.0, or 3

query number , must match ^(\d|1\d)(\.[05])?$ #/parameters/credit_hours
year_term

Numerical designation of calendar year and semester/term. Format is yyyyt where t is a single digit of 1 = Winter, 3 = Spring, 4 = Summer, 5 = Fall

query string (up to 5 chars) #/parameters/year_term
200 OK #/responses/200

Success

Example for application/json
{
"tuition_flag": true,
"year_term": "20183"
}
400 Bad Request #/responses/400

Bad Request

Example for application/json
{
"status": {
"byu_id": "555266100",
"credit_hours": null,
"program_date": null,
"reason": "byu_id, credit_hours and either program_date or year_term are required parameters",
"year_term": "20183"
}
}
500 Internal Server Error #/responses/500

Internal Server Error

Parameter definitions

byu_id byu_id

A 9 digit employee ID

query string , must match ^[0-9]{9}$
program_date program_date

The date to check against in the format defined by RFC 3339, section 5.6, for example: 2017-07-21

query string (date)
credit_hours credit_hours

The number of credit hours to request, in decimal form. E.g 12.5, 6.0, or 3

query number , must match ^(\d|1\d)(\.[05])?$
year_term year_term

Numerical designation of calendar year and semester/term. Format is yyyyt where t is a single digit of 1 = Winter, 3 = Spring, 4 = Summer, 5 = Fall

query string (up to 5 chars)

Response definitions

200

Success

Example for application/json
{
"tuition_flag": true,
"year_term": "20183"
}
400

Bad Request

Example for application/json
{
"status": {
"byu_id": "555266100",
"credit_hours": null,
"program_date": null,
"reason": "byu_id, credit_hours and either program_date or year_term are required parameters",
"year_term": "20183"
}
}
500

Internal Server Error

Schema definitions

error_response: object

status: object
reason: string

The reason the request failed.

byu_id: string

The string passed in as the byu_id parameter.

program_date: string

The string passed in as the program_date parameter.

year_term: string

The string passed in as the year_term parameter.

credit_hours: string

The string passed in as the credit_hours parameter.

response: object

tuition_flag: tuition_flag
year_term: year_term

tuition_flag: boolean

Whether or not the person can take the requested number of credits

year_term: string

The year term code that was determined from the parameters passed in

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

Community

 

Don't see your question listed here? Ask!