Students
Students Resource of the University API
Base URL: /byuapi/students
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET |
Students |
| OPTIONS |
Students |
|
| PUT |
Students |
|
| /{byu_id} | GET |
Student |
| OPTIONS |
Students |
|
| PUT |
Student |
|
| /{byu_id}/academic_plans | DELETE |
academic_plans |
| GET |
academic_plans |
|
| OPTIONS |
Students |
|
| PUT |
academic_plans |
|
| /{byu_id}/addresses | DELETE |
Students |
| GET |
Students |
|
| OPTIONS |
Students |
|
| PUT |
Students |
|
| /{byu_id}/addresses/{address_type} | DELETE |
Students |
| GET |
Students |
|
| OPTIONS |
Students |
|
| PUT |
Students |
|
| /{byu_id}/confidential_information | DELETE |
Students |
| GET |
confidential_information |
|
| OPTIONS |
Students |
|
| PUT |
confidential_information |
|
| /{byu_id}/enrolled_classes | DELETE |
enrolled_class |
| GET |
enrolled_classes |
|
| OPTIONS |
Students |
|
| PUT |
enrolled_classes |
|
| /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number} | DELETE |
enrolled_class |
| PUT |
Add Enrolled Class |
|
| /{byu_id}/exam_credits | DELETE |
Students |
| GET |
exam_credits |
|
| OPTIONS |
Students |
|
| PUT |
exam_credits |
|
| /{byu_id}/flags_and_holds | DELETE |
Students |
| GET |
flags_and_holds |
|
| OPTIONS |
Students |
|
| PUT |
flags_and_holds |
|
| /{byu_id}/id_card | DELETE |
Students |
| GET |
id_card |
|
| OPTIONS |
Students |
|
| PUT |
id_card |
|
| /{byu_id}/relationships | DELETE |
Students |
| GET |
relationships |
|
| OPTIONS |
Students |
|
| PUT |
relationships |
|
| /{byu_id}/student_programs | DELETE |
Students |
| GET |
student_programs |
|
| OPTIONS |
Students |
|
| PUT |
student_programs |
|
| /{byu_id}/suggested_classes | DELETE |
Students |
| GET |
suggested_classes |
|
| OPTIONS |
Students |
|
| PUT |
suggested_classes |
|
| /{byu_id}/term_status | GET |
term_status |
| OPTIONS |
Students |
|
| PUT |
term_status |
|
| /{byu_id}/transfer_credits | DELETE |
Students |
| GET |
transfer_credits |
|
| OPTIONS |
Students |
|
| PUT |
transfer_credits |
|
| /{byu_id}/waitlisted_classes | GET |
waitlisted_classes |
| /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number} | DELETE |
Remove Waitlisted Class |
| PUT |
Add Class to Waitlist |
|
| /{byu_id}/waivers | DELETE |
Students |
| GET |
waivers |
|
| OPTIONS |
Students |
|
| PUT |
waivers |
Paths
Returns a collection of BYU-IAM Students - all of them, or searching by net id or person id.
| net_id |
Search by net id |
query | string | |
| byu_id |
Search by person id |
query | string |
Uses default content-types: application/json
- 200 OK
-
A collection of Students
- 400 Bad Request
-
Invalid request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 404 Not Found
-
No matching student found
- 409 Conflict
-
Query parameters failure
- default
-
Unexpected error
Update a student not by ID
| net_id |
Update by net id |
query | string | |
| person_id |
Update by person id |
query | string |
Uses default content-types: application/json
- 200 OK
-
The student that was updated
- 400 Bad Request
-
Invalid request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 404 Not Found
-
No matching student found
- 409 Conflict
-
Query parameters failure
- default
-
Unexpected error
Returns a BYU-IAM Student
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
A Student
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No matching student - Maybe should be a 204 instead?
- default
-
Unexpected error
PUT /{byu_id}
Update a Student
Uses default content-types: application/json
| byu_id |
External BYU identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The student that was updated
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No matching student - maybe should be a 204 instead?
- default
-
Unexpected error
DELETE /{byu_id}/academic_plans
delete all academic plans with certain criteria
| byu_id | path | string |
Uses default content-types: application/json
- 200 OK
-
The academic plans were deleleted
- default
-
Error
GET /{byu_id}/academic_plans
Returns the academic plans for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The Academic Plans for the student
- default
-
Unexpected error
PUT /{byu_id}/academic_plans
Creates or modifies an academic plan
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The academic plan that was updated
- default
-
Unexpected error
Deletes an address
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Identity successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
Receives the the selected address
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The address associated with the person id
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
There is no address with the associated data
- 409 Conflict
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Creates a new address
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
Address successfully created
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
There is no matching Identity
- 409 Conflict
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Deletes an address
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string | |
| address_type |
3 character identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Identity successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
Receives the the selected address
| byu_id |
External BYU-IAM identifier |
path | string | |
| address_type |
3 character identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The address associated with the person id
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
There is no address with the associated data
- 409 Conflict
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Updates a specific address
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string | |
| address_type |
3 character identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
Address successfully updated
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
There is no matching Identity
- 409 Conflict
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Deletes confidential information
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Confidential information successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/confidential_information
Returns the confidential information for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The confidential information for the student
- default
-
Unexpected error
PUT /{byu_id}/confidential_information
Creates or modifies some confidential information
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The confidential_information that was updated
- default
-
Unexpected error
DELETE /{byu_id}/enrolled_classes
delete all enrolled classes with certain criteria
| byu_id | path | string |
Uses default content-types: application/json
- 204 No Content
-
The enrolled classes were deleleted
- default
-
Error
GET /{byu_id}/enrolled_classes
Returns all enrolled_classes for the student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The enrolled_classes for the student
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No classes - maybe should be a 204 instead?
- default
-
Unexpected error
PUT /{byu_id}/enrolled_classes
Update of a single class
Uses default content-types: application/json
| byu_id | path | string |
Uses default content-types: application/json
- 200 OK
-
The enrolled_class that was updated
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No classes - maybe should be a 204 instead?
- default
-
Unexpected error
DELETE /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}
Tags: Studentdelete all enrolled classes with certain criteria
| byu_id |
External BYU Identifier |
path | string | |
| year_term |
Year Term of Class to Add |
path | string | |
| curriculum_id |
Curriculum Id of Class to Add |
path | string | |
| title_code |
Title Code of Class to Add |
path | string | |
| section_number |
Section Number of Class to Add |
path | string |
Uses default content-types: application/json
- 204 No Content
-
The enrolled classes were deleleted
- default
-
Error
PUT /{byu_id}/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}
Tags: StudentEnrolles the student in a class
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string | |
| year_term |
Year Term of Class to Add |
path | string | |
| curriculum_id |
Curriculum Id of Class to Add |
path | string | |
| title_code |
Title Code of Class to Add |
path | string | |
| section_number |
Section Number of Class to Add |
path | string |
Uses default content-types: application/json
- 200 OK
-
The enrolled_classes for the student
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No classes found
- default
-
Unexpected error
Deletes an exam credit
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Exam Credits successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/exam_credits
Returns the exam credits for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The exam credits for the student
- default
-
Unexpected error
PUT /{byu_id}/exam_credits
Creates or modifies exam_credits
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The exam credits that were updated
- default
-
Unexpected error
Deletes flags and holds
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Flags and holds successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/flags_and_holds
Returns the flags_and_holds for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The flags_and_holds for the student
- default
-
Unexpected error
PUT /{byu_id}/flags_and_holds
Creates or modifies an flags_and_holds
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The flags_and_holds that was updated
- default
-
Unexpected error
Deletes id card
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Id card successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/id_card
Returns the id_card for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The id_card for the student
- default
-
Unexpected error
PUT /{byu_id}/id_card
Creates or modifies an id_card
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The id_card that was updated
- default
-
Unexpected error
Deletes relationships
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Relationships successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/relationships
Returns the relationships for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The relationships for the student
- default
-
Unexpected error
PUT /{byu_id}/relationships
Creates or modifies an relationships
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The relationships that were updated
- default
-
Unexpected error
Deletes student programs
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Student programs successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/student_programs
Returns the student_programs for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The student_programs for the student
- default
-
Unexpected error
PUT /{byu_id}/student_programs
Creates or modifies an student_programs
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The student_programs that was updated
- default
-
Unexpected error
Deletes suggested classes
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Suggested classes successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/suggested_classes
Returns the suggested_classes for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The suggested_classes for the student
- default
-
Unexpected error
PUT /{byu_id}/suggested_classes
Creates or modifies an suggested_classes
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The suggested_classes that was updated
- default
-
Unexpected error
GET /{byu_id}/term_status
Returns the term_status for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The term_status for the student
- default
-
Unexpected error
PUT /{byu_id}/term_status
Creates or modifies an term_status
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The term_status that was updated
- default
-
Unexpected error
Deletes transfer credits
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Transfer credits successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/transfer_credits
Returns the transfer_credits for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The transfer_credits for the student
- default
-
Unexpected error
PUT /{byu_id}/transfer_credits
Creates or modifies an transfer_credits
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The transfer_credits that was updated
- default
-
Unexpected error
Returns all waitlisted_classes for the student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The waitlisted_classes for the student
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No classes
- default
-
Unexpected error
DELETE /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}
Tags: Studentdelete waitlisted class
| byu_id |
External BYU Identifier |
path | string | |
| year_term |
Year Term of Class to Add |
path | string | |
| curriculum_id |
Curriculum Id of Class to Add |
path | string | |
| title_code |
Title Code of Class to Add |
path | string | |
| section_number |
Section Number of Class to Add |
path | string |
Uses default content-types: application/json
- 204 No Content
-
The waitlisted class was deleted
- default
-
Error
PUT /{byu_id}/waitlisted_classes/{year_term},{curriculum_id},{title_code},{section_number}
Tags: StudentEnrolls the student in a class waitlist
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string | |
| year_term |
Year Term of Class to Add |
path | string | |
| curriculum_id |
Curriculum Id of Class to Add |
path | string | |
| title_code |
Title Code of Class to Add |
path | string | |
| section_number |
Section Number of Class to Add |
path | string |
Uses default content-types: application/json
- 200 OK
-
The waitlisted class for the student
- 400 Bad Request
-
Invalid Request - Failure somehow.
- 401 Unauthorized
-
Authentication required
- 403 Forbidden
-
Protected Data
- 404 Not Found
-
No classes found
- default
-
Unexpected error
Deletes waivers
Uses default content-types: application/json
| byu_id |
External BYU-IAM identifier |
path | string |
Uses default content-types: application/json
- 204 No Content
-
Waivers successfully removed
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- default
-
Unexpected error
GET /{byu_id}/waivers
Returns the waivers for a given student
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The waivers for the student
- default
-
Unexpected error
PUT /{byu_id}/waivers
Creates or modifies an waivers
Uses default content-types: application/json
| byu_id |
External BYU Identifier |
path | string |
Uses default content-types: application/json
- 200 OK
-
The waivers that was updated
- default
-
Unexpected error
Schema definitions
academic_plan: api-string
Several academic_plans?
The account id for the specific credential_type and user_name
{
"api_type": "read-only",
"value": "123456789"
}
- value: string (up to 100 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
{
"audit_flag": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"course_name": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_number": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"created_by_id": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"created_by_name": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_created": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"date_time_redeemed": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"links": {
"add_approved_class.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self",
"title": "add_approved_class.getAddApprovedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
- links: object
-
Hypermedia Links for a specific enrolled class
- metadata: metadata
-
- byu_id: api-string
-
- year_term: api-string
-
- curriculum_id: api-string
-
- title_code: api-string
-
- section_number: api-string
-
- teaching_area: api-string
-
- course_name: api-string
-
- course_title: api-string
-
- course_number: api-string
-
- course_suffix: api-string
-
- audit_flag: api-string
-
- date_time_created: api-string
-
- created_by_id: api-string
-
- created_by_name: api-string
-
- date_time_redeemed: api-string
-
A collection of classes in which a student is enrolled
{
"links": {
"add_approved_classes.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.next",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.prev",
"title": "students.getAddApprovedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"audit_flag": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"course_name": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_number": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"created_by_id": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"created_by_name": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_created": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"date_time_redeemed": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"links": {
"add_approved_class.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self",
"title": "add_approved_class.getAddApprovedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
}
- links: object
-
Hypermedia Links for the add_approved_classes collection
- metadata: object
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- validation_response: validation_response
-
- values: object[]
- links: object
-
Hypermedia links for an address
- byu_id: byu_id
-
- address_type: address_type
-
- date_time_updated: date_time_updated
-
- updated_by_id: updated_by_id
-
- date_time_created: date_time_created
-
- created_by_id: created_by_id
-
- address_line_1: address_line_1
-
- address_line_2: address_line_2
-
- address_line_3: address_line_3
-
- address_line_4: address_line_4
-
- building: building
-
- room: room
-
- country_code: country_code
-
- city: city
-
- state_code: state_code
-
- postal_code: postal_code
-
- unlisted: unlisted
-
Line 1 of the address
{
"api_type": "read-only",
"value": "3217 ITB"
}
- value: string (up to 40 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Line 2 of the address
{
"api_type": "read-only",
"value": "Provo, UT 84602"
}
- value: string (up to 40 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Line 3 of the address
{
"api_type": "read-only",
"value": "Wei Street"
}
- value: string (up to 40 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Line 4 of the address
{
"api_type": "read-only",
"value": "The People's Republic of China"
}
- value: string (up to 40 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Indicates the type of address
{
"api_type": "read-only",
"key": true,
"value": "MAL"
}
- value: string , x ∈ { PRM , RES , MAL , WRK } (up to 3 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Assigned instructors for a class
- links: link
-
- credit_institution: credit_institution
-
- year_term: year_term
-
- curriculum_id: curriculum_id
-
- title_code: title_code
-
- section_number: section_number
-
- instructor_type: instructor_type
-
- instructor_name: instructor_name
-
- person_id: person_id
-
- byu_id: byu_id
-
- net_id: net_id
-
- email_address: email_address
-
- updated_by_id: updated_by_id
-
- updated_by_name: updated_by_name
-
- date_time_updated: date_time_updated
-
Schedule for a class
- links: object
-
- assigned_schedules.info: link
-
- schedule_type: string (up to 15 chars)
-
Type of schedule
- schedule_id: string (up to 50 chars)
-
- sequence_number: integer (up to 9 chars)
-
- year_term: year_term
-
- curriculum_id: curriculum_id
-
- title_code: title_code
-
- section_number: section_number
-
- institution: credit_institution
-
- building: string (up to 15 chars)
-
Building the class is located in
- room: string (up to 10 chars)
-
scheduled room number
- days_taught: string
-
Days of the week the class is taught
- mon: string
-
- tue: string
-
- wed: string
-
- thu: string
-
- fri: string
-
- sat: string
-
- sun: string
-
- use_start_date: string
-
- use_end_date: string
-
- time_taught: string
-
- begin_time: string
-
- end_time: string
-
- status: string
-
- set_up_id: string
-
- set_up_name: string
-
- set_up_description: string
-
- schedule_reason: string
-
- date_time_updated: date_time_updated
-
- updated_by_id: updated_by_id
-
- updated_by_name: updated_by_name
-
- allow_conflict: allow_conflict
-
The type of device, such as a card reader, associated with the credential. Validated through the meta/credential_device service
{
"api_type": "read-only",
"value": " "
}
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
{
"byu_id": {
"api_type": "read-only",
"value": ""
},
"deceased": {
"api_type": "read-only",
"value": ""
},
"email_address": {
"api_type": "read-only",
"value": ""
},
"gender": {
"api_type": "read-only",
"value": ""
},
"links": {
"students.delete": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "DELETE",
"rel": "self",
"title": "students.deleteStudent"
},
"students.info": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "GET",
"rel": "self",
"title": "students.getStudent"
},
"students.modify": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "PUT",
"rel": "self",
"title": "students.modifyStudent"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"name": {
"api_type": "read-only",
"value": ""
},
"net_id": {
"api_type": "read-only",
"value": ""
},
"phone": {
"api_type": "modifiable",
"value": ""
},
"restricted": {
"api_type": "read-only",
"value": ""
}
}
- links: object
-
Hypermedia Links for the basic properties of a student
- metadata: metadata
-
- byu_id: byu_id
-
- net_id: api-string
-
- person_id: api-string
-
- classification_status_standing: api-string
-
create new object with fields: employment_classification, employment_status, employment_standing
- credits: object[]
- deceased: deceased
-
- email_address: email_address
-
- gender: gender
-
- home_town: home_town
-
- merge_in_process: merge_in_process
-
- deferments: deferments
-
- phone: phone_number
-
- registrar_hold: registrar_hold
-
- restricted: restricted
-
- student_name: student_name
-
- student_status: student_status
-
The building code, validated through the meta/building service, set only for a BYU office
{
"api_type": "read-only",
"description": "Information Tec",
"long_description": "Information Technology Bldg",
"value": "ITB"
}
- value: string (up to 4 chars)
-
- description: string (up to 15 chars)
-
- long_description: string (up to 30 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
byu_id: api-string
The city
{
"api_type": "read-only",
"value": "Provo"
}
- value: string (up to 30 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
I don't think this is very valuble.
- links: link
-
- birth_date: api-string
-
- current_academic_standing: api-string
-
Isn't this in student status?
- endorsement_status: api-string
-
hmm
- marital_status: api-string
-
- picture: api-string
-
Why not just look at id card?
Contexts Available
- registration: object[]
-
object - languages: object[]
-
object - email_addresses: object[]
-
object
The country code, validated through the meta/country service
{
"api_type": "read-only",
"description": "United States of America",
"value": "USA"
}
- value: string (up to 3 chars)
-
- description: string (up to 35 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- value: string (up to 9 chars)
-
- api_type: string , x ∈ { read-only , modifiable , operational }
-
- links: object
-
Hypermedia links for a credential
- byu_id: byu_id
-
- user_name: user_name
-
- credential_id: credential_id
-
- credential_type: credential_type
-
- account_id: account_id
-
- lost_or_stolen: lost_or_stolen
-
- status: status
-
- expiration_date: expiration_date
-
- issuing_location: issuing_location
-
- physical_form: physical_form
-
- associated_device: associated_device
-
- date_time_updated: date_time_updated
-
- updated_by_id: updated_by_id
-
- date_time_created: date_time_created
-
- created_by_id: created_by_id
-
The user name or login name
{
"api_type": "read-only",
"value": "js279"
}
- value: string (up to 100 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
The credential type, validated through the meta/credential_type service
{
"api_type": "read-only",
"value": "NET_ID"
}
- value: string (up to 50 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
The credentials sub-resource data
- links: object
-
Hypermedia links for a collection of credentials
- metadata: sub_level_metadata
-
- values: object[]
- value: string (up to 15 chars)
-
BYU Provo Campus
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
- current: api-boolean
-
- enrollment_status: api-string
-
Make this an enumeration: options- full-time, part-time, not-enrolled.
- financial_aid_status: api-string
-
Make this an enumeration: options- full-time, half-time, less than half-time?.
- credit_hours: api-string
-
How many credit hours for the specified year term
- year_term: api-string
-
Which term we are currently
current_student: api-boolean
- value: string (up to 5 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
The date/time when the entity was created, given in GMT (Greenwich Mean Time)
{
"api_type": "system",
"value": "2014-05-11T13:45:53.20Z"
}
- value: string (date-time)
-
- api_type: string , x ∈ { system }
-
- value: string (up to 23 chars)
-
- api_type: string , x ∈ { read-only , modifiable , operational }
-
The most recent date/time updated, given in GMT (Greenwich Mean Time)
{
"api_type": "system",
"value": "2014-05-11T13:45:53.20Z"
}
- value: string (date_time)
-
- api_type: string , x ∈ { system }
-
- is_deceased: api-boolean
-
- date_of_death: api-date
-
- deferment_type: api-string
-
- year_term_returning: api-string
-
- when_granted: api-date
-
- granted_by: api-string
-
eligible_to_register: api-boolean
email_address: api-string
employment_status: api-string
{
"add_drop_card": {
"value": ""
},
"added_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"added_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"audit_status": {
"api_type": "read-only",
"value": ""
},
"block_code": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"class_repeated": {
"api_type": "read-only",
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_added": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_graded": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_time_updated": {
"api_type": "operational",
"desc": "",
"value": ""
},
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
},
"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": ""
},
"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": "operational",
"desc": "",
"value": ""
},
"graded_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"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",
"title": "enrolled_classes.dropEnrolledClass"
},
"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",
"title": "enrolled_class.getEnrolledClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"permission_code": {
"api_type": "read-only",
"value": ""
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"section_type": {
"api_type": "read-only",
"value": ""
},
"start_date": {
"api_type": "read-only",
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"updated_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
- links: object
-
Hypermedia Links for a specific enrolled class
- metadata: metadata
-
- byu_id: api-string
-
- year_term: api-string
-
- curriculum_id: api-string
-
- title_code: api-string
-
- section_number: api-string
-
- add_drop_card: api-string
-
This should be a nice enum with useful items in it
- added_by_id: api-string
-
- added_by_name: api-string
-
- audit_status: api-string
-
- block_code: api-string
-
- class_repeated: api-string
-
- course_number: api-string
-
- course_suffix: api-string
-
- course_title: api-string
-
- credit_hours: api-string
-
- date_added: api-string
-
- date_graded: api-string
-
- date_time_updated: api-string
-
- end_date: api-string
-
- envelope_id: api-string
-
- envelope_type: api-string
-
- grade: api-string
-
- graded_by_id: api-string
-
- graded_by_name: api-string
-
- lab_quiz_section: api-string
-
The lab quiz section description
- section_type: api-string
-
- start_date: api-string
-
- teaching_area: api-string
-
- updated_by_id: api-string
-
updated_by_name
- fee: api-string
-
whether the class has a fee
- honors: api-string
-
whether the class is an honors class
- fixed_or_variable: api-string
-
- reg_end_date: api-string
-
whether the class is an honors class
- withdraw_deadline_date: api-string
-
the deadline date
- assigned_instructors: assigned_instructors
-
- assigned_schedules: assigned_schedules
-
A collection of classes in which a student is enrolled
{
"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",
"title": "students.addEnrolledClass"
},
"enrolled_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__next",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__prev",
"title": "students.getEnrolledClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_drop_card": {
"value": ""
},
"added_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"added_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"audit_status": {
"api_type": "read-only",
"value": ""
},
"block_code": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"class_repeated": {
"api_type": "read-only",
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_added": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_graded": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_time_updated": {
"api_type": "operational",
"desc": "",
"value": ""
},
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
},
"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": ""
},
"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": "operational",
"desc": "",
"value": ""
},
"graded_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"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",
"title": "enrolled_classes.dropEnrolledClass"
},
"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",
"title": "enrolled_class.getEnrolledClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"permission_code": {
"api_type": "read-only",
"value": ""
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"section_type": {
"api_type": "read-only",
"value": ""
},
"start_date": {
"api_type": "read-only",
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"updated_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
}
- links: object
-
Hypermedia Links for the enrolled_classes collection
- metadata: object
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- validation_response: validation_response
-
- values: object[]
- enrollment_action_type: api-string , x ∈ { class_added , class_dropped , waitlisted_classes , remove_waitlisted_classes }
-
- add_drop_card: api-string
-
This should be a nice enum with useful items in it
- added_by_id: api-string
-
- added_by_name: api-string
-
- audit_status: api-string
-
- byu_id: byu_id
-
- catalog_suffix: api-string
-
- class_repeated: api-string
-
- course_number: api-string
-
- course_suffix: api-string
-
- course_title: api-string
-
- credit_hours: api-string
-
- credit_institution: api-string
-
- block_code: api-string
-
- curriculum_id: api-string
-
- date_added: api-string
-
- date_graded: api-string
-
- date_time_updated: api-string
-
- end_date: api-string
-
- envelope_id: api-string
-
- envelope_type: api-string
-
- grade: api-string
-
- graded_by_id: api-string
-
- graded_by_name: api-string
-
- instructors: instructors
-
- lab_quiz_section: api-string
-
The lab quiz section description
- schedules: object[]
- section_number: api-string
-
- section_type: api-string
-
- start_date: api-string
-
- teaching_area: api-string
-
- title_code: api-string
-
- updated_by_id: api-string
-
updated_by_name
- year_term: api-string
-
- enrolled_classes: enrolled_classes
-
- enrollment_logs: enrollment_logs
-
exam_credits: api-string
The date the permissions will expire
{
"api_type": "system",
"value": "2014-05-11"
}
- value: string (date)
-
- api_type: string , x ∈ { system }
-
field_set_strings: string , x ∈ { basic , addresses , add_approved_classes , confidential_information , credentials , employment_status , enrolled_classes , exam_credits , flags_and_holds , id_card , relationships , student_programs , suggested_classes , term_status , transfer_credits , waitlisted_classes , waivers }
List of available field sets
Whatever pops out of the flags and holds table
- links: link
-
- values: object
-
- credit_institution: string
-
- flag_name: string
-
- flag_value: string
-
- effective_date: string
-
- expired_date: string
-
- year_term: string
-
- hold_day_reg: string
-
- hold_transcript: string
-
- date_set: string
-
- set_by_id: string
-
- date_removed: string
-
- removed_by_id: string
-
- std_comment: string
-
- date_time_updated: string
-
- updated_by_id: string
-
The Flags and Holds for a particular student
- links: link
-
- values: object[]
- country_code: api-string
-
- state_code: api-string
-
- city: api-string
-
- links: link
-
- beard_flag: api-string , x ∈ { Y , N }
-
- picture: api-string
-
A URL to retrieve the picture
- value: string (up to 50 chars)
-
- api_type: string , x ∈ { read-only , modifiable , related }
-
- key: boolean
-
- related_resource: string
-
- desc: string
-
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
The location where the credential was issued
{
"api_type": "read-only",
"value": " "
}
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Hypermedia links format
- rel: string
-
- href: string (uri)
-
- method: string , x ∈ { DELETE , GET , OPTIONS , POST , PUT }
-
- title: string
-
Indicates that the card has been lost or stolen
{
"api_type": "read-only",
"value": "N"
}
- value: string , x ∈ { N , Y } (up to 1 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
merge_in_process: api-boolean
- validation_response: validation_response
-
- value: string (up to 15 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- related_resource: string
-
- desc: string
-
- value: string (up to 9 chars)
-
- api_type: string , x ∈ { key , read-only , modifiable }
-
- key: boolean
-
- desc: string
-
The formatted phone number
{
"api_type": "read-only",
"key": true,
"value": "801-420-1684"
}
- value: string (up to 30 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
The physical form of the credential
{
"api_type": "read-only",
"value": " "
}
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
The postal code (ZIP code for USA addresses)
{
"api_type": "read-only",
"value": "84604"
}
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
registrar_hold: api-boolean
relationships: api-string
restricted: api-boolean
The room, set only for a BYU office
{
"api_type": "read-only",
"value": "C-144"
}
- value: string (up to 5 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
Time and location of class
- days_taught: api-string
-
- begin_time: api-string
-
- end_time: api-string
-
- room: api-string
-
- building: api-string
-
- value: string (up to 3 chars)
-
- api_type: string , x ∈ { read-only , modifiable , system }
-
- key: boolean
-
The state/province code, validated through the meta/state service
{
"api_type": "read-only",
"description": "Utah",
"value": "UT"
}
- value: string (up to 6 chars)
-
- description: string (up to 30 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
The credential status, validated through the meta/credential_status service
{
"api_type": "read-only",
"value": "ACTIVE"
}
- value: string (up to 20 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
{
"add_approved_classes": {
"links": {
"add_approved_classes.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.next",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.prev",
"title": "students.getAddApprovedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"audit_flag": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"course_name": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_number": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"created_by_id": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"created_by_name": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_created": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"date_time_redeemed": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"links": {
"add_approved_class.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self",
"title": "add_approved_class.getAddApprovedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
},
"basic": {
"byu_id": {
"api_type": "read-only",
"value": ""
},
"deceased": {
"api_type": "read-only",
"value": ""
},
"email_address": {
"api_type": "read-only",
"value": ""
},
"gender": {
"api_type": "read-only",
"value": ""
},
"links": {
"students.delete": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "DELETE",
"rel": "self",
"title": "students.deleteStudent"
},
"students.info": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "GET",
"rel": "self",
"title": "students.getStudent"
},
"students.modify": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "PUT",
"rel": "self",
"title": "students.modifyStudent"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"name": {
"api_type": "read-only",
"value": ""
},
"net_id": {
"api_type": "read-only",
"value": ""
},
"phone": {
"api_type": "modifiable",
"value": ""
},
"restricted": {
"api_type": "read-only",
"value": ""
}
},
"enrolled_classes": {
"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",
"title": "students.addEnrolledClass"
},
"enrolled_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__next",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__prev",
"title": "students.getEnrolledClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_drop_card": {
"value": ""
},
"added_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"added_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"audit_status": {
"api_type": "read-only",
"value": ""
},
"block_code": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"class_repeated": {
"api_type": "read-only",
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_added": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_graded": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_time_updated": {
"api_type": "operational",
"desc": "",
"value": ""
},
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
},
"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": ""
},
"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": "operational",
"desc": "",
"value": ""
},
"graded_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"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",
"title": "enrolled_classes.dropEnrolledClass"
},
"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",
"title": "enrolled_class.getEnrolledClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"permission_code": {
"api_type": "read-only",
"value": ""
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"section_type": {
"api_type": "read-only",
"value": ""
},
"start_date": {
"api_type": "read-only",
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"updated_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
},
"waitlisted_classes": {
"links": {
"waitlisted_classes__add": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "PUT",
"rel": "waitlisted_classes__add",
"title": "waitlisted_classes.addWaitlistedClass"
},
"waitlisted_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__next",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__prev",
"title": "waitlisted_classes.getWaitlistedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 100,
"max_page_size": 100,
"page_end": 1,
"page_size": 100,
"page_start": 1,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_error_message": {
"api_type": "read-only",
"value": ""
},
"added_by_id": {
"api_type": "read-only",
"value": ""
},
"added_by_name": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "read-only",
"value": ""
},
"date_time_requested": {
"api_type": "read-only",
"value": ""
},
"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",
"title": "waitlisted_class.deleteWaitlistedClass"
},
"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",
"title": "waitlisted_class.getWaitlistedClass"
},
"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",
"title": "waitlisted_class.modifyWaitlistedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"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": "read-only",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
}
}
- basic: basic
-
- academic_plans: academic_plans
-
- add_approved_classes: add_approved_classes
-
- addresses: addresses
-
Is this in basic?
- confidential_information: confidential_information
-
- credentials: credentials
-
Is this in basic?
- enrolled_classes: enrolled_classes
-
- enrollment_logs: enrollment_logs
-
- exam_credits: exam_credits
-
- flags_and_holds: flags_and_holds
-
Copy data from basic?
- id_card: id_card
-
- relationships: relationships
-
We might not need this
- student_programs: student_programs
-
- suggested_classes: suggested_classes
-
- term_status: term_status
-
- transfer_credits: transfer_credits
-
Maybe we want a deeper resource for credits?
- waitlisted_classes: waitlisted_classes
-
- waivers: waivers
-
- name_fnf: api-string
-
Their name with the First Name First
- name_lnf: api-string
-
Their name with the Last Name First
- preferred_first_name: api-string
-
Whatever they want
- preferred_name: api-string
-
The preferred full name
- rest_of_name: api-string
-
Given names
- surname: api-string
-
Surname only
student_programs: api-string
This describes a lot of stuff. Subject to change
- class_standing_code: api-string
-
Create an enumeration: Freshmen, Sophomore, Junior, Senior, Graduate
- class_standing_description: api-string
-
- matriculated_status: api-string
-
Y or N
{
"links": {
"students.create": {
"href": "https://api.byu.edu/byuapi/students",
"method": "POST",
"rel": "students.create",
"title": "students.createStudent"
},
"students.current": {
"href": "https://api.byu.edu/byuapi/students?page_start=1,page_size=50",
"method": "GET",
"rel": "students.current",
"title": "students.getStudents"
},
"students.info": {
"href": "https://api.byu.edu/byuapi/students?page_start=51,page_size=50",
"method": "GET",
"rel": "self",
"title": "students.getStudents"
},
"students.next": {
"href": "https://api.byu.edu/byuapi/students?page_start_101,page_size=50",
"method": "GET",
"rel": "students.next",
"title": "students.getStudents"
},
"students.prev": {
"href": "https://api.byu.edu/byuapi/students?page_start=1,page_size=50",
"method": "GET",
"rel": "students.prev",
"title": "students.getStudents"
}
},
"metadata": {
"collection_size": 0,
"contexts_available": {
"email_addresses": [
"basic",
"email_address",
"security_email_address"
],
"languages": [
"basic",
"speakers"
]
},
"default_field_sets": [
"basic"
],
"default_page_size": 100,
"field_sets_available": [
"basic",
"add_approved_classes",
"addresses",
"confidential_information",
"credentials",
"employment_status",
"enrolled_classes",
"exam_credits",
"flags_and_holds",
"id_card",
"relationships",
"student_programs",
"suggested_classes",
"term_status",
"transfer_credits",
"waitlisted_classes",
"waivers"
],
"field_sets_returned": [
],
"max_page_size": 100,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_approved_classes": {
"links": {
"add_approved_classes.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.next",
"title": "students.getAddApprovedClasses"
},
"add_approved_classes.prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "add_approved_classes.prev",
"title": "students.getAddApprovedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"audit_flag": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"course_name": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_number": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_suffix": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"course_title": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"created_by_id": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"created_by_name": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_created": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"date_time_redeemed": {
"api_type": "read-only",
"desc": "",
"value": ""
},
"links": {
"add_approved_class.info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/add_approved_classes/:year_term,:curriculum_id,:title_code,:section_number",
"method": "GET",
"rel": "self",
"title": "add_approved_class.getAddApprovedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
},
"basic": {
"byu_id": {
"api_type": "read-only",
"value": ""
},
"deceased": {
"api_type": "read-only",
"value": ""
},
"email_address": {
"api_type": "read-only",
"value": ""
},
"gender": {
"api_type": "read-only",
"value": ""
},
"links": {
"students.delete": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "DELETE",
"rel": "self",
"title": "students.deleteStudent"
},
"students.info": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "GET",
"rel": "self",
"title": "students.getStudent"
},
"students.modify": {
"href": "https://api.byu.edu/byuapi/students/:student_id",
"method": "PUT",
"rel": "self",
"title": "students.modifyStudent"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"name": {
"api_type": "read-only",
"value": ""
},
"net_id": {
"api_type": "read-only",
"value": ""
},
"phone": {
"api_type": "modifiable",
"value": ""
},
"restricted": {
"api_type": "read-only",
"value": ""
}
},
"enrolled_classes": {
"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",
"title": "students.addEnrolledClass"
},
"enrolled_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__next",
"title": "students.getEnrolledClasses"
},
"enrolled_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "enrolled_classes__prev",
"title": "students.getEnrolledClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 0,
"page_size": 0,
"page_start": 0,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_drop_card": {
"value": ""
},
"added_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"added_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"audit_status": {
"api_type": "read-only",
"value": ""
},
"block_code": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"class_repeated": {
"api_type": "read-only",
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_added": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_graded": {
"api_type": "operational",
"desc": "",
"value": ""
},
"date_time_updated": {
"api_type": "operational",
"desc": "",
"value": ""
},
"drop_implications": {
"discontinuance_messages": {
"api_type": "read-only",
"value": [
]
},
"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": ""
},
"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": "operational",
"desc": "",
"value": ""
},
"graded_by_name": {
"api_type": "operational",
"desc": "",
"value": ""
},
"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",
"title": "enrolled_classes.dropEnrolledClass"
},
"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",
"title": "enrolled_class.getEnrolledClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"permission_code": {
"api_type": "read-only",
"value": ""
},
"section_number": {
"api_type": "read-only",
"key": true,
"value": ""
},
"section_type": {
"api_type": "read-only",
"value": ""
},
"start_date": {
"api_type": "read-only",
"value": ""
},
"teaching_area": {
"api_type": "related",
"related_resource": "courses",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"updated_by_id": {
"api_type": "operational",
"desc": "",
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
},
"waitlisted_classes": {
"links": {
"waitlisted_classes__add": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "PUT",
"rel": "waitlisted_classes__add",
"title": "waitlisted_classes.addWaitlistedClass"
},
"waitlisted_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__next",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__prev",
"title": "waitlisted_classes.getWaitlistedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 100,
"max_page_size": 100,
"page_end": 1,
"page_size": 100,
"page_start": 1,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_error_message": {
"api_type": "read-only",
"value": ""
},
"added_by_id": {
"api_type": "read-only",
"value": ""
},
"added_by_name": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "read-only",
"value": ""
},
"date_time_requested": {
"api_type": "read-only",
"value": ""
},
"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",
"title": "waitlisted_class.deleteWaitlistedClass"
},
"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",
"title": "waitlisted_class.getWaitlistedClass"
},
"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",
"title": "waitlisted_class.modifyWaitlistedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"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": "read-only",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
}
}
]
}
- links: object
-
Hypermedia Links that impact the entire Academic Units collection
- metadata: students_metadata
-
- values: object[]
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- field_sets_returned: object[]
- field_sets_available: object[]
- default_field_sets: object[]
- contexts_available: contexts_available
-
- validation_response: validation_response
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer
-
suggested_classes: api-string
term_status: api-string
- value: string (up to 3 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
- key: boolean
-
This is the entire database table for xfereval.std_tran_class
- byu_id: api-string
-
- college_code: api-string
-
- year_term: api-string
-
- sequence_num: api-string
-
- dept_name: api-string
-
- catalog_number: api-string
-
- credit_hours: number
-
- grade: api-string
-
- repeat_status: api-string
-
- up_low_division: api-string
-
- basic_elective: api-string
-
- semester_quarter: api-string
-
- credit_accepted: api-string
-
- course_description: api-string
-
- curriculum_id: api-string
-
- title_code: api-string
-
- equiv_source: api-string
-
- equiv_updated_date: api-string
-
- pgm_curriculum_id: api-string
-
- pgm_title_code: api-string
-
- pgm_equiv_source: api-string
-
- pgm_equiv_updated_date: api-string
-
- date_time_updated: api-string
-
- updated_by_id: api-string
-
- metadata: students_metadata
-
- values: object[]
Indicates whether or not the person chooses to allow the address to be publicly accessible
{
"api_type": "read-only",
"value": "N"
}
- value: string , x ∈ { N , Y , } (up to 1 chars)
-
- api_type: string , x ∈ { read-only , modifiable }
-
The BYU ID of the last person who performed the last update
{
"api_type": "system",
"description": "Joe Faculty",
"value": "584584584"
}
- value: string (up to 9 chars)
-
- api_type: string , x ∈ { system }
-
- description: string (up to 50 chars)
-
- value: string (up to 50 chars)
-
- api_type: string , x ∈ { read-only , modifiable , operational }
-
- desc: string
-
The optional common name or alias of credential_id
- value: string (up to 100 chars)
-
- api_type: string , x ∈ { read-only , modifyalbe }
-
{
"add_error_message": {
"api_type": "read-only",
"value": ""
},
"added_by_id": {
"api_type": "read-only",
"value": ""
},
"added_by_name": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "read-only",
"value": ""
},
"date_time_requested": {
"api_type": "read-only",
"value": ""
},
"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",
"title": "waitlisted_class.deleteWaitlistedClass"
},
"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",
"title": "waitlisted_class.getWaitlistedClass"
},
"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",
"title": "waitlisted_class.modifyWaitlistedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"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": "read-only",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
- links: link
-
- added_by_id: api-string
-
- added_by_name: api-string
-
- byu_id: byu_id
-
- course_number: api-string
-
- course_suffix: api-string
-
- course_title: api-string
-
- credit_hours: api-string
-
- curriculum_id: api-string
-
- date_time_added: api-string
-
- block_code: api-string
-
- lab_quiz_section: api-string
-
- section_number: api-string
-
- section_type: api-string
-
- start_date: api-string
-
- teaching_area: api-string
-
- title_code: api-string
-
- year_term: api-string
-
- assigned_schedules: assigned_schedules
-
A collection of classes in which a student is waitlisted
{
"links": {
"waitlisted_classes__add": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "PUT",
"rel": "waitlisted_classes__add",
"title": "waitlisted_classes.addWaitlistedClass"
},
"waitlisted_classes__info": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "self",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__next": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__next",
"title": "waitlisted_classes.getWaitlistedClasses"
},
"waitlisted_classes__prev": {
"href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "waitlisted_classes__prev",
"title": "waitlisted_classes.getWaitlistedClasses"
}
},
"metadata": {
"collection_size": 0,
"default_page_size": 100,
"max_page_size": 100,
"page_end": 1,
"page_size": 100,
"page_start": 1,
"validation_response": {
"response": "",
"return_code": 200
}
},
"values": [
{
"add_error_message": {
"api_type": "read-only",
"value": ""
},
"added_by_id": {
"api_type": "read-only",
"value": ""
},
"added_by_name": {
"api_type": "read-only",
"value": ""
},
"byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"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": ""
},
"curriculum_id": {
"api_type": "read-only",
"key": true,
"value": ""
},
"date_time_of_error": {
"api_type": "read-only",
"value": ""
},
"date_time_requested": {
"api_type": "read-only",
"value": ""
},
"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",
"title": "waitlisted_class.deleteWaitlistedClass"
},
"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",
"title": "waitlisted_class.getWaitlistedClass"
},
"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",
"title": "waitlisted_class.modifyWaitlistedClass"
}
},
"metadata": {
"validation_response": {
"response": "",
"return_code": 200
}
},
"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": "read-only",
"value": ""
},
"title_code": {
"api_type": "read-only",
"key": true,
"value": ""
},
"year_term": {
"api_type": "read-only",
"desc": "",
"ext_desc": "",
"key": true,
"value": ""
}
}
]
}
- links: object
-
Hypermedia Links for the waitlisted_classes collection
- metadata: object
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- max_page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- validation_response: validation_response
-
- values: object[]
