AcademicRecordsStdCoursework

This service generates a Record Summary for a selected student using the AIM system.

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

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

Version: v1

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

Summary

Path Operation Description
/ GET

Gets the course work for the logged in user

/documentation GET

service definition

/{person_id} GET

Gets the course work for the given student

Paths

Gets the course work for the logged in user

GET /

Tags: StdCourseWorkService

Gets the course work for the logged in user

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/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"ap_credit": "0.00",
"byu_gpa": "2.65",
"byu_id": "12-345-6789",
"data": [
{
"classes": [
{
"catalog_number": "225",
"credit_hours": "2.00",
"curriculum_id": "12578",
"dept_name": "REL C",
"grade": "C-",
"section_number": "003",
"title_code": "000",
"transcript_title": "Foundations of the Restoration"
},
{
"catalog_number": "261",
"credit_hours": "2.00",
"curriculum_id": "05043",
"dept_name": "REL C",
"grade": "A",
"section_number": "001",
"title_code": "008",
"transcript_title": "Family History-Genealogy"
}
]
,
"credits": "4.00",
"gpa": "2.85",
"year_term": "20174"
}
]
,
"dataAP": [
{
"APClasses": [
]
,
"earned_hours": "0.00",
"gpa": "0.00",
"grade_points": "0.00",
"graded_hours": "0.00",
"has_repeat": "0",
"orig_earned_hours": "0.00",
"orig_gpa": "0.00",
"orig_grade_points": "0.00",
"orig_graded_hours": "0.00",
"test_type": ""
}
]
,
"dataTransfer": [
]
,
"date_of_birth": "Month Day Year",
"gender": "Male",
"message": "",
"name": "Student, Name",
"total_gpa": "2.65",
"transfer_credit": "0.00"
}
}
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.

service definition

GET /documentation

service definition

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

200 OK

Success

Gets the course work for the given student

GET /{person_id}

Tags: StdCourseWorkService

Gets the course work for the given student

person_id

string -> nine digit number

path string
modal

Any value

query 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/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"ap_credit": "0.00",
"byu_gpa": "2.65",
"byu_id": "12-345-6789",
"data": [
{
"classes": [
{
"catalog_number": "225",
"credit_hours": "2.00",
"curriculum_id": "12578",
"dept_name": "REL C",
"grade": "C-",
"section_number": "003",
"title_code": "000",
"transcript_title": "Foundations of the Restoration"
},
{
"catalog_number": "261",
"credit_hours": "2.00",
"curriculum_id": "05043",
"dept_name": "REL C",
"grade": "A",
"section_number": "001",
"title_code": "008",
"transcript_title": "Family History-Genealogy"
}
]
,
"credits": "4.00",
"gpa": "2.85",
"year_term": "20174"
}
]
,
"dataAP": [
{
"APClasses": [
]
,
"earned_hours": "0.00",
"gpa": "0.00",
"grade_points": "0.00",
"graded_hours": "0.00",
"has_repeat": "0",
"orig_earned_hours": "0.00",
"orig_gpa": "0.00",
"orig_grade_points": "0.00",
"orig_graded_hours": "0.00",
"test_type": ""
}
]
,
"dataTransfer": [
]
,
"date_of_birth": "Month Day Year",
"gender": "Male",
"message": "",
"name": "Student, Name",
"total_gpa": "2.65",
"transfer_credit": "0.00"
}
}
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

APClass: object

test_type: string
test_version: string
year_term: string

YYYYT

course_name: string
transcript_title: string
credit_hours: string
grade: string
honors_flag: string
service_learning: string
repeat: string
hours_use: string
test_date: string
test_description: string
score_type: string
test_score: string

class_info: object

curriculum_id: string
title_code: string
dept_name: string
catalog_number: string
section_number: string
transcript_title: string
credit_hours: string
grade: string

dataAP: object

test_type: string
earned_hours: string
graded_hours: string
grade_points: string
gpa: string
has_repeat: string
orig_earned_hours: string
orig_graded_hours: string
orig_grade_points: string
orig_gpa: string
APClasses: object[]

dataTransfer: object

college_name: string
college_code: string
state: string
start: string
end: string
degree: string
degree_date: string
degree_major: string
earned_hours: string
graded_hours: string
gpa: string
has_repeat: string
orig_earned_hours: string
orig_graded_hours: string
orig_gpa: string
tranClasses: object[]

error_data: object

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

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

record_summary: object

year_term: string

YYYYT

credits: string
gpa: string
classes: object[]

request: object

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

response: object

message: string
name: string

lastName, firstName, middleName

byu_id: string

9 digit number

date_of_birth: string

Mon dd yyyy

gender: string
byu_gpa: string
total_gpa: string
ap_credit: string
transfer_credit: string
data: object[]
dataTransfer: object[]
dataAP: object[]

StdCourseWorkService: object

request: request
response: response

tranClass: object

college_code: string
year_term: string

YYYYT

course_name: string
course_description: string
credit_hours: string
grade: string
credit_accepted: string
byu_course_name: string
repeat: string

'Y' or 'N'

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

Community

 

Don't see your question listed here? Ask!