AcademicRecordsStudentRecord

This service accesses Academic records using the AIM system.

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

Base URL: /domains/legacy/academic/records/studentrecord

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{net_id_person_id}/{year_term} GET

Returns recMain info for the given year

/{person_id_net_id} GET

Returns recMain info

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Returns recMain info for the given year

GET /{net_id_person_id}/{year_term}

Tags: StudentRecordService

Returns recMain info for the given year

net_id_person_id

string -> String

path string
year_term

string -> String

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Class List": [
{
"H": "",
"LQ": "",
"S": "",
"block": "",
"catNum": "260",
"courseTitle": "Web Programming",
"creditHours": "3.0",
"currId": "13420",
"dateAdded": "29 Mar 2017",
"deptName": "C S",
"grade": "B-",
"gradeDate": "03 Jan 2018",
"gradedByName": "Teacher, Professor",
"is_term_header": "",
"rpt": "",
"secNum": "001",
"secType": "DAY",
"term_header": "",
"titleCode": "000",
"user": "Student, Name"
}
]
,
"Credit List": [
{
"gpa": "2.65",
"hoursEarned": "128.00",
"hoursGraded": "126.50",
"points": "334.80",
"title": "Total thru Fall 2017"
}
]
,
"Display List": [
]
,
"Major": [
{
"department": "Computer Science",
"type": "(BS)"
}
]
,
"Yearterm List": [
{
"yearterm": "20185",
"yeartermLong": "Fall Semester 2018"
}
]
,
"acadStanding": "GOOD",
"address1": "Address",
"address2": "",
"addressType": "Mailing Address",
"buildMode": "",
"calcAddHrs": "",
"calcAddPts": "",
"calcByuEarned": "",
"calcByuGpa": "",
"calcByuGraded": "",
"calcByuPoints": "",
"calcTotalEarned": "",
"calcTotalGpa": "",
"calcTotalGraded": "",
"calcTotalPoints": "",
"classStanding": "Senior",
"currWithdraw": "N",
"currentYearTerm": "20181",
"deStatus": "",
"disYearTerm": "Fall 2017",
"editFlag": "Yes",
"end": "14 Dec 2017",
"firstYrt": "Fall Semester 2011",
"gpaClasses": "",
"gradFullTime": "",
"gradStatusEff": "",
"gradStatusExp": "",
"lastYrt": "Fall Semester 2018",
"mode": "D",
"numClasses": "3",
"numHours": "6.0",
"phone": "123-456-7890",
"phone_unlisted": "Y",
"regEligDesc": "Day Continuing",
"regEligibility": "DC",
"regStatus": "9",
"regStatusDesc": "Continuing Student",
"semesterGpa": "2.20",
"start": "05 Sep 2017",
"studentLevel": "",
"termStanding": "GOOD",
"termStandingEff": "05 Sep 2017",
"termStandingExp": "07 Jan 2018",
"tranBreakdown": "",
"unlisted": "N",
"withdraw": "No",
"yearTerm": "20175"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Returns recMain info

GET /{person_id_net_id}

Tags: StudentRecordService

Returns recMain info

person_id_net_id

string -> 9 digit number.

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Class List": [
{
"H": "",
"LQ": "",
"S": "",
"block": "",
"catNum": "260",
"courseTitle": "Web Programming",
"creditHours": "3.0",
"currId": "13420",
"dateAdded": "29 Mar 2017",
"deptName": "C S",
"grade": "B-",
"gradeDate": "03 Jan 2018",
"gradedByName": "Teacher, Professor",
"is_term_header": "",
"rpt": "",
"secNum": "001",
"secType": "DAY",
"term_header": "",
"titleCode": "000",
"user": "Student, Name"
}
]
,
"Credit List": [
{
"gpa": "2.65",
"hoursEarned": "128.00",
"hoursGraded": "126.50",
"points": "334.80",
"title": "Total thru Fall 2017"
}
]
,
"Display List": [
]
,
"Major": [
{
"department": "Computer Science",
"type": "(BS)"
}
]
,
"Yearterm List": [
{
"yearterm": "20185",
"yeartermLong": "Fall Semester 2018"
}
]
,
"acadStanding": "GOOD",
"address1": "Address",
"address2": "",
"addressType": "Mailing Address",
"buildMode": "",
"calcAddHrs": "",
"calcAddPts": "",
"calcByuEarned": "",
"calcByuGpa": "",
"calcByuGraded": "",
"calcByuPoints": "",
"calcTotalEarned": "",
"calcTotalGpa": "",
"calcTotalGraded": "",
"calcTotalPoints": "",
"classStanding": "Senior",
"currWithdraw": "N",
"currentYearTerm": "20181",
"deStatus": "",
"disYearTerm": "Fall 2017",
"editFlag": "Yes",
"end": "14 Dec 2017",
"firstYrt": "Fall Semester 2011",
"gpaClasses": "",
"gradFullTime": "",
"gradStatusEff": "",
"gradStatusExp": "",
"lastYrt": "Fall Semester 2018",
"mode": "D",
"numClasses": "3",
"numHours": "6.0",
"phone": "123-456-7890",
"phone_unlisted": "Y",
"regEligDesc": "Day Continuing",
"regEligibility": "DC",
"regStatus": "9",
"regStatusDesc": "Continuing Student",
"semesterGpa": "2.20",
"start": "05 Sep 2017",
"studentLevel": "",
"termStanding": "GOOD",
"termStandingEff": "05 Sep 2017",
"termStandingExp": "07 Jan 2018",
"tranBreakdown": "",
"unlisted": "N",
"withdraw": "No",
"yearTerm": "20175"
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failure to authenticate

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

acadStanding: string

address1: string

address2: string

addressType: string

block: string

buildMode: string

calcAddHrs: string

calcAddPts: string

calcByuEarned: string

calcByuGpa: string

calcByuGraded: string

calcByuPoints: string

calcTotalEarned: string

calcTotalGpa: string

calcTotalGraded: string

calcTotalPoints: string

catNum: string

Class List: object[]

classes: object

is_term_header: is_term_header
term_header: term_header
deptName: deptName
catNum: catNum
secNum: secNum
block: block
currId: currId
titleCode: titleCode
LQ: LQ
secType: secType
creditHours: creditHours
H: H
S: S
dateAdded: dateAdded
user: user
grade: grade
rpt: rpt
gradeDate: gradeDate
gradedByName: gradedByName
courseTitle: courseTitle

classStanding: string

courseTitle: string

Credit List: object[]

creditHours: string

credits: object

title: title
hoursEarned: hoursEarned
hoursGraded: hoursGraded
points: points
gpa: gpa

currentYearTerm: string

YYYYT

currId: string

currWithdraw: string

dateAdded: string

department: string

deptName: string

deStatus: string

dd Mon yyyy

Display List: object[]

object

disYearTerm: string

editFlag: string

end: string

dd Mon yyyy

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

firstYrt: string

gpa: string

gpaClasses: string

grade: string

gradeDate: string

gradedByName: string

gradFullTime: string

gradStatusEff: string

gradStatusExp: string

H: string

hoursEarned: string

hoursGraded: string

is_term_header: string

lastYrt: string

LQ: string

Major: object[]

majorInfo: object

department: department
type: type

mode: string

numClasses: string

numHours: string

phone: string

phone_unlisted: string

points: string

RecMainService: object

request: request
response: response

regEligDesc: string

regEligibility: string

regStatus: string

regStatusDesc: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

disYearTerm: disYearTerm
addressType: addressType
unlisted: unlisted
address1: address1
address2: address2
phone_unlisted: phone_unlisted
phone: phone
regStatus: regStatus
regStatusDesc: regStatusDesc
regEligibility: regEligibility
regEligDesc: regEligDesc
withdraw: withdraw
classStanding: classStanding
firstYrt: firstYrt
lastYrt: lastYrt
acadStanding: acadStanding
termStanding: termStanding
numClasses: numClasses
numHours: numHours
semesterGpa: semesterGpa
Major: Major
Credit List: Credit List
Class List: Class List
mode: mode
editFlag: editFlag
buildMode: buildMode
start: start
end: end
yearTerm: yearTerm
currWithdraw: currWithdraw
currentYearTerm: currentYearTerm
studentLevel: studentLevel
gradFullTime: gradFullTime
gradStatusEff: gradStatusEff
gradStatusExp: gradStatusExp
termStandingEff: termStandingEff
termStandingExp: termStandingExp
deStatus: deStatus
tranBreakdown: tranBreakdown
calcByuEarned: calcByuEarned
calcByuGraded: calcByuGraded
calcByuPoints: calcByuPoints
calcByuGpa: calcByuGpa
calcTotalEarned: calcTotalEarned
calcTotalGraded: calcTotalGraded
calcTotalPoints: calcTotalPoints
calcTotalGpa: calcTotalGpa
calcAddHrs: calcAddHrs
calcAddPts: calcAddPts
gpaClasses: gpaClasses
Yearterm List: Yearterm List
Display List: Display List

rpt: string

S: string

secNum: string

secType: string

semesterGpa: string

start: string

dd Mon yyyy

studentLevel: string

term_header: string

termStanding: string

termStandingEff: string

termStandingExp: string

title: string

titleCode: string

tranBreakdown: string

type: string

unlisted: string

user: string

withdraw: string

yearterm: string

YYYYT

yearTerm: string

YYYYT

Yearterm List: object[]

yeartermInfo: object

yearterm: yearterm
yeartermLong: yeartermLong

yeartermLong: string

Service Path: 
/domains/legacy/academic/records/studentrecord
Domain or University API: 
/domains/D/academic/records/studentrecord

Community

 

Don't see your question listed here? Ask!