ScholarshipAwardsByStudent

Returns a list of awards for a list of comma-separated BYU-IDs, for the specified Year-Term.

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

Base URL: /domains/erp/sa/scholarshipAwardsByStudent/

Version: v1

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

Summary

Path Operation Description
/{year_term}?* GET

Paths

GET /{year_term}?*

byu_id_list

Comma-separated list of BYU-IDs

query string
year_term

Year-Term

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
[
{
"awards": [
{
"datetime_updated": "2018-02-20T16:55:03.000000-07:00",
"department_name": "College of Engineering-Mechanical",
"scholarship_academic_career": "GRAD",
"scholarship_award_amount": 0,
"scholarship_award_percent": 0,
"scholarship_award_status": "Accept",
"scholarship_code": "21733",
"scholarship_description": "NSTR Fellowship - Tuition"
},
{
"datetime_updated": "2018-02-20T16:53:26.000000-07:00",
"department_name": "Off-Campus Scholarships",
"scholarship_academic_career": "BUSN",
"scholarship_award_amount": 0,
"scholarship_award_percent": 0,
"scholarship_award_status": "Accept",
"scholarship_code": "21667",
"scholarship_description": "Corp Scholarship--BUSN"
}
]
,
"byu_id": "555555555",
"name": "John Q Student",
"num-awards": 2,
"year_term": "20171"
}
]
400 Bad Request

This service requires a Year-Term that must be 5 characters, followed by a comma-separated list of BYU-IDs.

Example for application/json
{
"error_message": "EMPLID 999999999 does not exist."
}

Schema definitions

awards: object

awards: object[]
object
scholarship_award_percent: integer
scholarship_code: string
scholarship_academic_career: string
scholarship_award_amount: integer
department_name: string
scholarship_description: string
scholarship_award_status: string
datetime_updated: string
name: string
num-awards: integer
byu_id: string
year_term: string

exception_info: object

error_message: string

response: object[]

Service Path: 
/domains/erp/sa/scholarshipAwardsByStudent/
Domain or University API: 
/domains/erp/sa/scholarshipAwardsByStudent/

Community

 

Don't see your question listed here? Ask!