Students

Students Resource of the University API

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

Base URL: /byuapi/students

Version: v1

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

Summary

Path Operation Description
/{byu_id}/enrolled_classes GET

enrolled_classes

/{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number} DELETE

Drops the student from the class

GET

Retrieve a specific enrollment of the student

PUT

Enrolls the student in a class

/{byu_id}/waitlisted_classes GET

Returns all waitlisted classes for the student

/{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number} DELETE

Remove Waitlisted Class

GET

Retrieve a student's class waitlist

PUT

Adds the student in a class waitlist

Paths

enrolled_classes

GET /{byu_id}/enrolled_classes

Returns all enrolled_classes for the student

byu_id

BYU Identifier

path string #/parameters/byu_id
registration

Filter request to current year terms

query string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

Example for application/json
{
"links": {
"enrolled_classes__add": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}",
"method": "PUT",
"rel": "enrolled_classes__add"
}
,
"enrolled_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"add_drop_card": {
"api_type": "read-only",
"value": ""
}
,
"add_message": {
"api_type": "system",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"audit_status": {
"api_type": "read-only",
"value": ""
}
,
"block_code": {
"api_type": "read-only",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"class_repeated": {
"api_type": "read-only",
"value": "N"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": "12345"
}
,
"date_added": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_graded": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_time_updated": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
}
,
"drop_allowed": {
"api_type": "read-only",
"value": "Y"
}
,
"drop_message": {
"api_type": "read-only",
"value": ""
}
,
"impacted_enrollments": {
"api_type": "read-only",
"value": [
]
}
,
"postrequisite_messages": {
"api_type": "read-only",
"value": [
]
}
}
,
"end_date": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"envelope_id": {
"api_type": "read-only",
"value": ""
}
,
"envelope_type": {
"api_type": "read-only",
"value": ""
}
,
"grade": {
"api_type": "read-only",
"value": ""
}
,
"graded_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"graded_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
}
,
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "enrolled_class__drop"
}
,
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"permission_code": {
"api_type": "read-only",
"value": ""
}
,
"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": "REL"
}
,
"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",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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"
}
}
}
Drops the student from the class

DELETE /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}

Drops the student from the class

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number
event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop } #/parameters/event_source

Uses default content-types: application/json

204 No Content

The enrolled class was deleted

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"
}
}
}
Retrieve a specific enrollment of the student

GET /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}

Retrieve a specific enrollment of the student

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number
event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop } #/parameters/event_source
class_schedule

Filter request to current year terms

query string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

Example for application/json
{
"add_drop_card": {
"api_type": "read-only",
"value": ""
}
,
"add_message": {
"api_type": "system",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"audit_status": {
"api_type": "read-only",
"value": ""
}
,
"block_code": {
"api_type": "read-only",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"class_repeated": {
"api_type": "read-only",
"value": "N"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": "12345"
}
,
"date_added": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_graded": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_time_updated": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
}
,
"drop_allowed": {
"api_type": "read-only",
"value": "Y"
}
,
"drop_message": {
"api_type": "read-only",
"value": ""
}
,
"impacted_enrollments": {
"api_type": "read-only",
"value": [
]
}
,
"postrequisite_messages": {
"api_type": "read-only",
"value": [
]
}
}
,
"end_date": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"envelope_id": {
"api_type": "read-only",
"value": ""
}
,
"envelope_type": {
"api_type": "read-only",
"value": ""
}
,
"grade": {
"api_type": "read-only",
"value": ""
}
,
"graded_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"graded_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
}
,
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "enrolled_class__drop"
}
,
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"permission_code": {
"api_type": "read-only",
"value": ""
}
,
"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": "REL"
}
,
"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",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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"
}
}
}
Enrolls the student in a class

PUT /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}

Enrolls the student in a class

Uses default content-types: application/json

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number
event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop } #/parameters/event_source
class_schedule

Filter request to current year terms

query string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

Example for application/json
{
"add_drop_card": {
"api_type": "read-only",
"value": ""
}
,
"add_message": {
"api_type": "system",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"audit_status": {
"api_type": "read-only",
"value": ""
}
,
"block_code": {
"api_type": "read-only",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"class_repeated": {
"api_type": "read-only",
"value": "N"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": "12345"
}
,
"date_added": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_graded": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"date_time_updated": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
}
,
"drop_allowed": {
"api_type": "read-only",
"value": "Y"
}
,
"drop_message": {
"api_type": "read-only",
"value": ""
}
,
"impacted_enrollments": {
"api_type": "read-only",
"value": [
]
}
,
"postrequisite_messages": {
"api_type": "read-only",
"value": [
]
}
}
,
"end_date": {
"api_type": "read-only",
"value": "2017-07-04"
}
,
"envelope_id": {
"api_type": "read-only",
"value": ""
}
,
"envelope_type": {
"api_type": "read-only",
"value": ""
}
,
"grade": {
"api_type": "read-only",
"value": ""
}
,
"graded_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"graded_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
}
,
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "enrolled_class__drop"
}
,
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"permission_code": {
"api_type": "read-only",
"value": ""
}
,
"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": "REL"
}
,
"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",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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"
}
}
}
Returns all waitlisted classes for the student

GET /{byu_id}/waitlisted_classes

Returns all waitlisted classes for the student

byu_id

BYU Identifier

path string #/parameters/byu_id

Uses default content-types: application/json

200 OK

The waitlisted_classes for the student

Example for application/json
{
"links": {
"waitlisted_classes__add": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes",
"method": "PUT",
"rel": "waitlisted_classes__add"
}
,
"waitlisted_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"add_error_message": {
"api_type": "read-only",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"date_time_of_error": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"date_time_requested": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"links": {
"waitlisted_class__delete": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "waitlisted_class__delete"
}
,
"waitlisted_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
,
"waitlisted_class__modify": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "PUT",
"rel": "waitlisted_class__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"position_in_queue": {
"api_type": "read-only",
"value": "0"
}
,
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"sequencer": {
"api_type": "read-only",
"value": ""
}
,
"size_mix_category": {
"api_type": "read-only",
"value": ""
}
,
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": "REL"
}
,
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"year_term": {
"api_type": "read-only",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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"
}
}
}
Remove Waitlisted Class

DELETE /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}

Remove student from class waitlist

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number
event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop } #/parameters/event_source

Uses default content-types: application/json

204 No Content

The waitlisted class was deleted

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"
}
}
}
Retrieve a student's class waitlist

GET /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}

Retrieve a student's class waitlist

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number

Uses default content-types: application/json

200 OK

The waitlisted class for the student

Example for application/json
{
"add_error_message": {
"api_type": "read-only",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"date_time_of_error": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"date_time_requested": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"links": {
"waitlisted_class__delete": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "waitlisted_class__delete"
}
,
"waitlisted_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
,
"waitlisted_class__modify": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "PUT",
"rel": "waitlisted_class__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"position_in_queue": {
"api_type": "read-only",
"value": "0"
}
,
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"sequencer": {
"api_type": "read-only",
"value": ""
}
,
"size_mix_category": {
"api_type": "read-only",
"value": ""
}
,
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": "REL"
}
,
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"year_term": {
"api_type": "read-only",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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"
}
}
}
Adds the student in a class waitlist

PUT /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}

Adds the student in a class waitlist

Uses default content-types: application/json

byu_id

BYU Identifier

path string #/parameters/byu_id
year_term

Year Term of Class

path string #/parameters/year_term
curriculum_id

Curriculum Id of Class

path string #/parameters/curriculum_id
title_code

Title Code of Class

path string #/parameters/title_code
section_number

Section Number of Class

path string #/parameters/section_number
event_source

What platform did this call come from?

query string , x ∈ { Android , iOS , Desktop } #/parameters/event_source

Uses default content-types: application/json

200 OK

The waitlisted class for the student

Example for application/json
{
"add_error_message": {
"api_type": "read-only",
"value": ""
}
,
"added_by_id": {
"api_type": "read-only",
"value": "123456789"
}
,
"added_by_name": {
"api_type": "read-only",
"value": "Joseph Smith"
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"course_number": {
"api_type": "related",
"key": true,
"related_resource": "courses",
"value": ""
}
,
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
}
,
"credit_hours": {
"api_type": "read-only",
"value": "2"
}
,
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"date_time_of_error": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"date_time_requested": {
"api_type": "read-only",
"value": "2017-07-04T11:22:33.445Z"
}
,
"links": {
"waitlisted_class__delete": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "DELETE",
"rel": "waitlisted_class__delete"
}
,
"waitlisted_class__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self"
}
,
"waitlisted_class__modify": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "PUT",
"rel": "waitlisted_class__modify"
}
}
,
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"position_in_queue": {
"api_type": "read-only",
"value": "0"
}
,
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"sequencer": {
"api_type": "read-only",
"value": ""
}
,
"size_mix_category": {
"api_type": "read-only",
"value": ""
}
,
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": "REL"
}
,
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"year_term": {
"api_type": "read-only",
"desc": "Fall 2017",
"ext_desc": "Fall Semester 2017",
"key": true,
"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 }

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

added_by_id: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string , must match ^(|[0-9]{9})$

The byu_id of the identity that added the class.

added_by_name: object

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

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

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) , must match ^(?=.{2,}?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
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) }

An explanation about the purpose of this instance.

value: string

An explanation about the purpose of this instance.

course_suffix: 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.

course_title: 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.

credit_hours: object

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

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_class: object

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

An explanation about the purpose of this instance.

add_message: object
api_type: string , x ∈ { system (default) }
value: string

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

byu_id: byu_id
class_repeated: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string , x ∈ { N (default) , Y }

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

date_time_updated: date_time_updated
drop_implications: object
discontinuance_messages: object
api_type: string , x ∈ { read-only (default) }
value: string[]
string
drop_allowed: object
api_type: string , x ∈ { read-only (default) }
value: string , x ∈ { Y , N , V }

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

impacted_enrollments: object
api_type: string , x ∈ { read-only (default) }
value: string[]
string
postrequisite_messages: object
api_type: string , x ∈ { read-only (default) }
value: string[]
string
end_date: object
api_type: string , x ∈ { read-only (default) }
value: string (date)

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

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.

graded_by_id: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string , must match ^(|[0-9]{9})$

The byu_id of the identity who set the grade.

graded_by_name: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string (up to 50 chars)

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

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

An explanation about the purpose of this instance.

links: object
enrolled_class__drop: object
href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

enrolled_class__info: object
href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

metadata: simple_metadata
permission_code: permission_code
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_classes: object

links: object
enrolled_classes__add: object
href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

enrolled_classes__info: object
href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

metadata: sub_level_metadata
values: object[]

error_response: object

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

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 }

permission_code: object

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

An explanation about the purpose of this instance.

position_in_queue: object

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

An explanation about the purpose of this instance.

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.

waitlisted_class: object

links: object
waitlisted_class__delete: object
href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

waitlisted_class__info: object
href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

waitlisted_class__modify: object
href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

added_by_id: added_by_id
added_by_name: added_by_name
byu_id: byu_id
course_number: course_number
course_suffix: course_suffix
course_title: course_title
credit_hours: credit_hours
curriculum_id: curriculum_id
date_time_of_error: object
api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date-time)

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

teaching_area: teaching_area
title_code: title_code
year_term: year_term

waitlisted_class_add: object

byu_id: byu_id
credit_hours: credit_hours
curriculum_id: curriculum_id
permission_code: permission_code
position_in_queue: position_in_queue
section_number: section_number
title_code: title_code
year_term: year_term

waitlisted_classes: object

links: object
waitlisted_classes__add: object
href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

waitlisted_classes__info: object
href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

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

An explanation about the purpose of this instance.

metadata: sub_level_metadata
values: object[]

year_term: object

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

An explanation about the purpose of this instance.

"Fall 2017"                                                        
ext_desc: 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/students
Domain or University API: 
/U/students

Community

 

Don't see your question listed here? Ask!