Students
Students Resource of the University API
Base URL: /byuapi/students
Version: v2
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 |
PUT | Adds the student in a class waitlist |
Paths
GET /{byu_id}/enrolled_classes
Returns all enrolled_classes for the student
registration | Filter request to current year terms | query | string | |
byu_id | BYU Identifier | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
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 enrolled_classes for the student
Example for application/json{
"links": {
"enrolled_classes__add": {
"href": "https://api.byu.edu/byuapi/students/123456789/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/123456789/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": "system",
"description": "Joseph Smith",
"value": "123456789"
},
"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": false
},
"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": "3.0"
},
"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": ""
},
"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": false
},
"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",
"description": "Joseph Smith",
"value": "123456789"
},
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
},
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"method": "DELETE",
"rel": "enrolled_class__drop"
},
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"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",
"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"
}
}
}
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 , must match ^[0-9]{9}$ | #/parameters/byu_id |
year_term | Year Term of Class | path | string , must match ^[0-9]{5}$ | #/parameters/year_term |
curriculum_id | Curriculum Id of Class | path | string , must match ^[0-9]{5}$ | #/parameters/curriculum_id |
title_code | Title Code of Class | path | string , must match ^[0-9]{3}$ | #/parameters/title_code |
section_number | Section Number of Class | path | string , must match ^[0-9]{3}$ | #/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"
}
}
}
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 , must match ^[0-9]{9}$ | #/parameters/byu_id |
year_term | Year Term of Class | path | string , must match ^[0-9]{5}$ | #/parameters/year_term |
curriculum_id | Curriculum Id of Class | path | string , must match ^[0-9]{5}$ | #/parameters/curriculum_id |
title_code | Title Code of Class | path | string , must match ^[0-9]{3}$ | #/parameters/title_code |
section_number | Section Number of Class | path | string , must match ^[0-9]{3}$ | #/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 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": "system",
"description": "Joseph Smith",
"value": "123456789"
},
"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": false
},
"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": "3.0"
},
"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": ""
},
"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": false
},
"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",
"description": "Joseph Smith",
"value": "123456789"
},
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
},
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"method": "DELETE",
"rel": "enrolled_class__drop"
},
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"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",
"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"
}
}
}
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 , must match ^[0-9]{9}$ | #/parameters/byu_id |
year_term | Year Term of Class | path | string , must match ^[0-9]{5}$ | #/parameters/year_term |
curriculum_id | Curriculum Id of Class | path | string , must match ^[0-9]{5}$ | #/parameters/curriculum_id |
title_code | Title Code of Class | path | string , must match ^[0-9]{3}$ | #/parameters/title_code |
section_number | Section Number of Class | path | string , must match ^[0-9]{3}$ | #/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 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": "system",
"description": "Joseph Smith",
"value": "123456789"
},
"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": false
},
"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": "3.0"
},
"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": ""
},
"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": false
},
"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",
"description": "Joseph Smith",
"value": "123456789"
},
"lab_quiz_section": {
"api_type": "read-only",
"value": ""
},
"links": {
"enrolled_class__drop": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"method": "DELETE",
"rel": "enrolled_class__drop"
},
"enrolled_class__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/enrolled_classes/20175,12345,123,123",
"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",
"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"
}
}
}
GET /{byu_id}/waitlisted_classes
Returns all waitlisted classes for the student
byu_id | BYU Identifier | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
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_classes for the student
Example for application/json{
"links": {
"waitlisted_classes__add": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}",
"method": "PUT",
"rel": "waitlisted_classes__add"
},
"waitlisted_classes__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 0,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"add_error_message": {
"api_type": "system",
"value": ""
},
"added_by_id": {
"api_type": "system",
"description": "Joseph Smith",
"value": "123456789"
},
"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": "3.0"
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "system",
"value": "2017-07-04T11:22:33.445Z"
},
"date_time_requested": {
"api_type": "system",
"value": "2017-07-04T11:22:33.445Z"
},
"links": {
"waitlisted_class__delete": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes/20175,12345,123,123",
"method": "DELETE",
"rel": "waitlisted_class__delete"
},
"waitlisted_class__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes/20175,12345,123,123",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"position_in_queue": {
"api_type": "derived",
"value": "0"
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"sequencer": {
"api_type": "system",
"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",
"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"
}
}
}
DELETE /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}
Remove student from class waitlist
byu_id | BYU Identifier | path | string , must match ^[0-9]{9}$ | #/parameters/byu_id |
year_term | Year Term of Class | path | string , must match ^[0-9]{5}$ | #/parameters/year_term |
curriculum_id | Curriculum Id of Class | path | string , must match ^[0-9]{5}$ | #/parameters/curriculum_id |
title_code | Title Code of Class | path | string , must match ^[0-9]{3}$ | #/parameters/title_code |
section_number | Section Number of Class | path | string , must match ^[0-9]{3}$ | #/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"
}
}
}
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 , must match ^[0-9]{9}$ | #/parameters/byu_id |
year_term | Year Term of Class | path | string , must match ^[0-9]{5}$ | #/parameters/year_term |
curriculum_id | Curriculum Id of Class | path | string , must match ^[0-9]{5}$ | #/parameters/curriculum_id |
title_code | Title Code of Class | path | string , must match ^[0-9]{3}$ | #/parameters/title_code |
section_number | Section Number of Class | path | string , must match ^[0-9]{3}$ | #/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": "system",
"value": ""
},
"added_by_id": {
"api_type": "system",
"description": "Joseph Smith",
"value": "123456789"
},
"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": "3.0"
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "system",
"value": "2017-07-04T11:22:33.445Z"
},
"date_time_requested": {
"api_type": "system",
"value": "2017-07-04T11:22:33.445Z"
},
"links": {
"waitlisted_class__delete": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes/20175,12345,123,123",
"method": "DELETE",
"rel": "waitlisted_class__delete"
},
"waitlisted_class__info": {
"href": "https://api.byu.edu/byuapi/students/123456789/waitlisted_classes/20175,12345,123,123",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"position_in_queue": {
"api_type": "derived",
"value": "0"
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"sequencer": {
"api_type": "system",
"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",
"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
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
- api_type: string , x ∈ { system (default) }
-
- description: 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-]+)$
- value: string , must match ^[0-9]{9}$
-
The person_id of the identity that added the class.
{
"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
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- api_type: string , x ∈ { related (default) }
-
- key: boolean true
-
- related_resource: string , x ∈ { courses (default) }
-
Refer to the courses API documentation.
- value: string
-
The numeric value of the course.
- api_type: string , x ∈ { related (default) }
-
- related_resource: string , x ∈ { courses (default) }
-
Refer to the courses API documentation.
- value: string
-
The value of the course suffix.
- api_type: string , x ∈ { related (default) }
-
- related_resource: string , x ∈ { courses (default) }
-
Refer to the courses API documentation.
- value: string
-
The value of the course title.
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
The value of the credit hours of the class.
- api_type: string , x ∈ { read-only (default) }
-
- key: boolean true
-
- value: string
-
The value of the curriculum id of the class.
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)
-
- add_drop_card: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
Indicates how the class was added.
- add_message: object
-
- api_type: string , x ∈ { system (default) }
-
- value: string
-
A message that was provided when class was added.
- added_by_id: added_by_id
-
- audit_status: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
Indicates whether the class was or is being audited.
- block_code: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
Indicates which block this class was/is offered.
- byu_id: byu_id
-
- class_repeated: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: boolean
-
Indicates whether this class was repeated.
- 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)
-
The date the class was added.
- date_graded: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
The date the class was graded. Will be a date (YYYY-MM-DD) or an empty string if not graded.
- 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: boolean
-
Indicates whether this class is still actively able to be dropped.
- drop_message: object
-
- api_type: string , x ∈ { read-only (default) }
-
- value: string
-
A message to be presented to the user when they are attempting to drop a class.
- 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)
-
The date when the class ends.
- envelope_id: object
-
- api_type: string , x ∈ { read-only (default) }
-
- value: string
-
The value of the envelope identifier.
- envelope_type: object
-
- api_type: string , x ∈ { read-only (default) }
-
- value: string
-
The value of the type of envelope.
- grade: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
The value of the grade according to the grade roll associated with this course, or empty string if not graded.
- graded_by_id: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- description: 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-]+)$
- value: string
-
The byu_id of the identity who set the grade, or empty string if not graded.
- lab_quiz_section: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
Indicates whether this class section is a lab or quiz type section.
- 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}
-
Use this templated URL to drop the student from a class by specifying the year_term, curriculum_id, title_code, and section_number path variables.
- method: string , x ∈ { DELETE (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { enrolled_class__drop (default) }
-
The name of the link property.
- enrolled_class__info: object
-
- href: string https://api.byu.edu/byuapi/students/{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}
-
Use this URL to retrieve the specific class the student has enrolled in or is currently enrolled.
- method: string , x ∈ { GET (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { self (default) }
-
The name of the link property or 'self' if the href value is the same as what is invoked.
- metadata: simple_metadata
-
- permission_code: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
The value of the permission code if needed to add the class.
- section_number: section_number
-
- section_type: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
The value of the section type of this section of the class.
- start_date: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string (date)
-
The date the class starts.
- teaching_area: teaching_area
-
- title_code: title_code
-
- updated_by_id: updated_by_id
-
- year_term: year_term
-
- 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}
-
Use this templated URL to add the student to a class by specifying the year_term, curriculum_id, title_code, and section_number path variables.
- method: string , x ∈ { PUT (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { enrolled_classes__add (default) }
-
The name of the link property.
- enrolled_classes__info: object
-
- href: string https://api.byu.edu/byuapi/students/{byu_id}/enrolled_classes
-
Use this URL to retrieve all the classes the student has enrolled in or is currently enrolled.
- method: string , x ∈ { GET (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { self (default) }
-
The name of the link property or 'self' if the href value is the same as what is invoked.
- metadata: collection_metadata
-
- values: object[]
{
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
- metadata: simple_metadata
-
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 }
-
- api_type: string , x ∈ { read-only (default) }
-
- key: boolean true
-
- value: string
-
The value of the section of this class.
- 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)
-
- api_type: string , x ∈ { related (default) }
-
- related_resource: string , x ∈ { courses (default) }
-
Refer to the courses API documentation.
- value: string
-
The value of the assigned teaching area of this course.
- api_type: string , x ∈ { read-only (default) }
-
- key: boolean true
-
- value: string
-
The value of the title code of this course.
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.
- 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}
-
Use this URL to remove the student from the wait list of the specified class.
- method: string , x ∈ { DELETE (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { waitlisted_class__delete (default) }
-
The name of the link property.
- waitlisted_class__info: object
-
- href: string https://api.byu.edu/byuapi/students/{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}
-
Use this URL to retrieve the representation of the specified student in the wait list of the specified class.
- method: string , x ∈ { GET (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { self (default) }
-
The name of the link property or 'self' if the href value is the same as what is invoked.
- metadata: simple_metadata
-
- add_error_message: object
-
- api_type: string , x ∈ { system (default) }
-
- value: string
-
An error message when adding a class.
- added_by_id: added_by_id
-
- 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 ∈ { system (default) }
-
- value: string
-
The date-time of an error (YYYY-MM-DDTHH:mm:ss.sssZ), or empty string if no error occurred.
- date_time_requested: object
-
- api_type: string , x ∈ { system (default) }
-
- value: string (date-time)
-
The date-time a class was requested to be added to a class wait list.
- position_in_queue: object
-
- api_type: string , x ∈ { derived (default) }
-
- value: string 0
-
The position the student is in the wait list.
- section_number: section_number
-
- sequencer: object
-
- api_type: string , x ∈ { system (default) }
-
- value: string
-
- size_mix_category: object
-
- api_type: string , x ∈ { read-only (default) , modifiable }
-
- value: string
-
- teaching_area: teaching_area
-
- title_code: title_code
-
- year_term: year_term
-
- links: object
-
- waitlisted_classes__add: object
-
- href: string https://api.byu.edu/byuapi/students/{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}
-
Use this templated URL to add the student to a class wait list by specifying the year_term, curriculum_id, title_code, and section_number path variables.
- method: string , x ∈ { PUT (default) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { waitlisted_classes__add (default) }
-
The name of the link property.
- 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) }
-
The HTTP method to use when invoking the URL in the href property.
- rel: string , x ∈ { self (default) }
-
The name of the link property or 'self' if the href value is the same as what is invoked.
- metadata: collection_metadata
-
- values: object[]
- byu_id: byu_id
-
- credit_hours: credit_hours
-
- curriculum_id: curriculum_id
-
- section_number: section_number
-
- title_code: title_code
-
- year_term: year_term
-
- api_type: string , x ∈ { read-only (default) }
-
- description: string
-
The common description of the year term.
"Fall 2017"
- long_description: string
-
The long description of the year term.
"Fall Semester 2017"
- key: boolean true
-
- value: string , must match ^[0-9]{5}$
-
The coded value of the year term.
"20175"