Student Records

Student Records Resource of the University API

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

Base URL: /byuapi/student_records

Version: v1

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

Summary

Path Operation Description
/{byu_id}/enrolled_courses GET

enrolled_courses

/{byu_id}/exam_credits GET

BYU Challenge Exams

Paths

enrolled_courses

GET /{byu_id}/enrolled_courses

Returns all enrolled_courses for the student

byu_id

BYU Identifier

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

The enrolled_courses for the student

Example for application/json
{
"links": {
"enrolled_courses__info": {
"href": "https://api.byu.edu/byuapi/student_records/123456789/enrolled_courses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"block_code": {
"api_type": "read-only",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Jospeh Smith",
"key": true,
"value": "123456789"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": "110"
}
,
"course_repeated": {
"api_type": "read-only",
"value": false
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": "College Algebra"
}
,
"credit_hours": {
"api_type": "read-only",
"value": 2
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": "12345"
}
,
"date_time_updated": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"end_date": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"grade": {
"api_type": "read-only",
"value": "A"
}
,
"honors": {
"api_type": "read-only",
"value": false
}
,
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"section_number": {
"api_type": "read-only",
"key": true,
"value": "123"
}
,
"section_type": {
"api_type": "read-only",
"value": ""
}
,
"start_date": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": "MATH"
}
,
"title_code": {
"api_type": "read-only",
"key": true,
"value": "123"
}
,
"updated_by_id": {
"api_type": "read-only",
"description": "Joseph Smith",
"value": "123456789"
}
,
"year_term": {
"api_type": "read-only",
"description": "Fall 2017",
"key": true,
"long_description": "Fall Semester 2017",
"value": "20175"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

Example for application/json
{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
}
401 Unauthorized #/responses/401

Authentication required to access data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
}
403 Forbidden #/responses/403

Access denied to protected data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
}
404 Not Found #/responses/404

The resource does not exist

Example for application/json
{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
}
409 Conflict #/responses/409

Query parameters conflict or are malformed

Example for application/json
{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
default #/responses/default

Unexpected error

Example for application/json
{
"metadata": {
"validation_response": {
"code": 500,
"message": "Internal Server Error"
}
}
}
BYU Challenge Exams

GET /{byu_id}/exam_credits

Returns BYU Challenge Exams for the student

byu_id

BYU Identifier

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

The byu challenge exams for the student

Example for application/json
{
"links": {
"exam_credits__info": {
"href": "https://api.byu.edu/byuapi/student_records/123456789/exam_credits",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Jospeh Smith",
"key": true,
"value": "123456789"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": "110"
}
,
"course_repeated": {
"api_type": "read-only",
"value": false
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": "MATH"
}
,
"credit_hours": {
"api_type": "read-only",
"value": 2
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": "12345"
}
,
"date_time_updated": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"grade": {
"api_type": "read-only",
"value": "A"
}
,
"honors": {
"api_type": "read-only",
"value": false
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": "MATH"
}
,
"title_code": {
"api_type": "read-only",
"key": true,
"value": "123"
}
,
"updated_by_id": {
"api_type": "read-only",
"description": "Joseph Smith",
"value": "123456789"
}
,
"year_term": {
"api_type": "read-only",
"description": "Fall 2017",
"key": true,
"long_description": "Fall Semester 2017",
"value": "20175"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

Example for application/json
{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
}
401 Unauthorized #/responses/401

Authentication required to access data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
}
403 Forbidden #/responses/403

Access denied to protected data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
}
404 Not Found #/responses/404

The resource does not exist

Example for application/json
{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
}
409 Conflict #/responses/409

Query parameters conflict or are malformed

Example for application/json
{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
default #/responses/default

Unexpected error

Example for application/json
{
"metadata": {
"validation_response": {
"code": 500,
"message": "Internal Server Error"
}
}
}

Parameter definitions

byu_id byu_id

BYU Identifier

path string
year_term year_term

Year Term of Class

path string
curriculum_id curriculum_id

Curriculum Id of Class

path string
title_code title_code

Title Code of Class

path string
section_number section_number

Section Number of Class

path string
event_source event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop }
context context

Indicates a set of subresources

query string
field_sets field_sets

List which subresources are to be returned

query string
page_start page_start

Skip into a large collection to this item

query string
page_size page_size

Return this many items of a large collection

query string

Response definitions

400

Invalid Request - unable to interpret request

Example for application/json
{
"metadata": {
"validation_response": {
"code": 400,
"message": "Invalid Request - unable to interpret request"
}
}
}
401

Authentication required to access data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 401,
"message": "Authentication required to access data"
}
}
}
403

Access denied to protected data

Example for application/json
{
"metadata": {
"validation_response": {
"code": 403,
"message": "Access denied to protected data"
}
}
}
404

The resource does not exist

Example for application/json
{
"metadata": {
"validation_response": {
"code": 404,
"message": "The resource does not exist"
}
}
}
409

Query parameters conflict or are malformed

Example for application/json
{
"metadata": {
"validation_response": {
"code": 409,
"message": "Query parameters conflict or are malformed"
}
}
}
default

Unexpected error

Example for application/json
{
"metadata": {
"validation_response": {
"code": 500,
"message": "Internal Server Error"
}
}
}

Schema definitions

byu_id: object

{
"api_type": "system",
"description": "Jospeh Smith",
"key": true,
"value": "123456789"
}
value: string , must match ^[0-9]{9}$
description: string (up to 50 chars)
api_type: string , x ∈ { system (default) }
key: boolean true

course_number: object

api_type: string , x ∈ { related (default) }
key: boolean true
related_resource: string , x ∈ { courses (default) }

The course number is managed by the courses top-level resource of the University API.

value: string

The number ascribed to the course by the curriculum committee.

course_suffix: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }

The course suffix is managed by the courses top-level resource of the University API.

value: string

An explanation about the purpose of this instance.

course_title: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }

The course title is managed by the courses top-level resource of the University API.

value: string

An explanation about the purpose of this instance.

credit_hours: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: integer

An explanation about the purpose of this instance.

curriculum_id: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string

An explanation about the purpose of this instance.

date_time_updated: object

The most recent date/time updated, given in GMT (Greenwich Mean Time)

{
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date-time)

enrolled_course: object

block_code: object
api_type: string , x ∈ { read-only (default) }
value: string

Term one, term two, semester

byu_id: byu_id
course_repeated: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: boolean

This course has been repeated by a future instance.

course_number: course_number
course_suffix: course_suffix
course_title: course_title
credit_hours: credit_hours
curriculum_id: curriculum_id
date_time_updated: date_time_updated
end_date: object
api_type: string , x ∈ { read-only (default) }
value: string (date)

An explanation about the purpose of this instance.

grade: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

An explanation about the purpose of this instance.

honors: object
api_type: string , x ∈ { read-only (default) }
value: boolean

This course was an honors level offering.

instruction_mode: instruction_mode
lab_quiz_section: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

An explanation about the purpose of this instance.

metadata: simple_metadata
section_number: section_number
section_type: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

An explanation about the purpose of this instance.

start_date: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date)

An explanation about the purpose of this instance.

teaching_area: teaching_area
title_code: title_code
updated_by_id: updated_by_id
year_term: year_term

enrolled_courses: object

links: object
enrolled_courses__info: object
href: string https://api.byu.edu/byuapi/student_records/:byu_id/enrolled_courses

The URL that represents the request just executed.

method: string , x ∈ { GET (default) }

Standard use of the GET HTTP method.

rel: string , x ∈ { self (default) }

Self is used here to identify that this link represents the request just executed.

metadata: sub_level_metadata
values: object[]

error_response: object

{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
metadata: simple_metadata

exam_credit: object

byu_id: byu_id
course_repeated: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: boolean

This course has been repeated by a future instance.

course_number: course_number
course_suffix: course_suffix
course_title: course_title
credit_hours: credit_hours
curriculum_id: curriculum_id
date_time_updated: date_time_updated
grade: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

An explanation about the purpose of this instance.

honors: object
api_type: string , x ∈ { read-only (default) }
value: boolean

This course was an honors level offering.

metadata: simple_metadata
teaching_area: teaching_area
title_code: title_code
updated_by_id: updated_by_id
year_term: year_term
exam_credit_id: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Identifier for exam credit record.

exam_type: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Type of exam used for credit.

exam_version: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Version of exam used for credit.

exam_date: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date)

Date of exam used for credit.

course_name: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Name of course given credit for the exam.

credit_institution: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Institution identifier.

credit_hours_use: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string

Indicator for how credit hours may be used.

exam_credits: object

links: object
exam_credits__info: object
href: string https://api.byu.edu/byuapi/student_records/:byu_id/exam_credits

The URL that represents the request just executed.

method: string , x ∈ { GET (default) }

Standard use of the GET HTTP method.

rel: string , x ∈ { self (default) }

Self is used here to identify that this link represents the request just executed.

metadata: sub_level_metadata
values: object[]

instruction_mode: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { classes (default) }

The instruction mode is managed by the classes top-level resource of the University API.

value: string Classroom

This identifies whether the course was taught in the classroom, online, or as a hybrid.

net_id: object

The user name to used for authentication to BYU web applications

{
"api_type": "read-only",
"value": "js279"
}
value: string
api_type: string , x ∈ { read-only (default) , modifiable }

section_number: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string

An explanation about the purpose of this instance.

simple_metadata: object

validation_response: object
code: integer 200 (3 to 3 chars)
message: string Success
validation_information: string[]
string Success
cache: object

If data is from live source, value will be null, otherwise it will be date-time of cache

date_time: string (date-time)

sub_level_metadata:

collection_size: integer , { x ∈ ℤ | x ≥ 0 }

teaching_area: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }

An explanation about the purpose of this instance.

value: string

An explanation about the purpose of this instance.

title_code: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string

An explanation about the purpose of this instance.

updated_by_id: object

The BYU ID of the last student who performed the last update

{
"api_type": "system",
"description": "INIT",
"value": "123456798"
}
api_type: string , x ∈ { read-only (default) , modifiable }
description: string (up to 50 chars)

The display name of the identity that made the update. pattern: ^(|(?=.{2,}?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+)$

value: string

The byu_id of the identity that made the update.

year_term: object

api_type: string , x ∈ { read-only (default) }
description: string

An explanation about the purpose of this instance.

"Fall 2017"                                                        
long_description: string

The long name.

"Fall Semester 2017"                                                        
key: boolean true
value: string , must match ^[0-9]{5}$

The code value of the year term.

"20175"                                                        
Service Path: 
/byuapi/student_records
Domain or University API: 
/U/student_records

Community

 

Don't see your question listed here? Ask!