Students

Students Resource of the University API

More information: https://it.byu.edu

Contact Info: api@byu.edu

Base URL: /byuapi/students

Version: v1

Default request content-types: application/json

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/{byu_id}	GET	Retrieves a specific student
/{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

Retrieves a specific student

GET /{byu_id}

Retrieves a specific student


byu_id	BYU Identifier	path	string	#/parameters/byu_id
context	Indicates a set of subresources	query	string	#/parameters/context
field_sets	List which subresources are to be returned	query	string	#/parameters/field_sets

Uses default content-types: application/json

200 OK

A Student

student

Example for application/json

{
    "basic": {
        "byu_id": {
            "api_type": "system",
            "key": true,
            "value": "123456789"
        },
        "deceased": {
            "api_type": "read-only",
            "value": true
        },
        "email_address": {
            "api_type": "read-only",
            "value": "js@byu.edu"
        },
        "gender": {
            "api_type": "read-only",
            "value": "M"
        },
        "links": {
            "students__delete": {
                "href": "https://api.byu.edu/byuapi/students/:student_id",
                "method": "DELETE",
                "rel": "self"
            },
            "students__info": {
                "href": "https://api.byu.edu/byuapi/students/:student_id",
                "method": "GET",
                "rel": "self"
            },
            "students__modify": {
                "href": "https://api.byu.edu/byuapi/students/:student_id",
                "method": "PUT",
                "rel": "self"
            }
        },
        "metadata": {
            "validation_response": {
                "code": 200,
                "message": "Success"
            }
        },
        "name": {
            "api_type": "read-only",
            "value": "Joseph Smith"
        },
        "net_id": {
            "api_type": "read-only",
            "value": "js"
        },
        "phone": {
            "api_type": "modifiable",
            "value": "555-555-5555"
        },
        "restricted": {
            "api_type": "read-only",
            "value": true
        }
    },
    "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"
            },
            "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"
            },
            "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"
            },
            "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"
            }
        },
        "metadata": {
            "collection_size": 0,
            "default_page_size": 50,
            "maximum_page_size": 1000,
            "page_end": 0,
            "page_size": 0,
            "page_start": 0,
            "validation_response": {
                "code": 200,
                "message": "Success"
            }
        },
        "values": [
            {
                "add_drop_card": {
                    "api_type": "read-only",
                    "value": ""
                },
                "add_message": {
                    "api_type": "system",
                    "value": ""
                },
                "added_by_id": {
                    "api_type": "read-only",
                    "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": 2
                },
                "curriculum_id": {
                    "api_type": "read-only",
                    "key": true,
                    "value": "12345"
                },
                "date_added": {
                    "api_type": "read-only",
                    "value": "2017-07-04"
                },
                "date_graded": {
                    "api_type": "read-only",
                    "value": "2017-07-04"
                },
                "date_time_updated": {
                    "api_type": "read-only",
                    "value": "2017-07-04T11:22:33.445Z"
                },
                "drop_implications": {
                    "discontinuance_messages": {
                        "api_type": "read-only",
                        "value": [
                        ]
                    },
                    "drop_allowed": {
                        "api_type": "read-only",
                        "value": 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/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
                        "method": "DELETE",
                        "rel": "enrolled_class__drop"
                    },
                    "enrolled_class__info": {
                        "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
                        "method": "GET",
                        "rel": "self"
                    }
                },
                "metadata": {
                    "validation_response": {
                        "code": 200,
                        "message": "Success"
                    }
                },
                "permission_code": {
                    "api_type": "read-only",
                    "value": ""
                },
                "section_number": {
                    "api_type": "read-only",
                    "key": true,
                    "value": "123"
                },
                "section_type": {
                    "api_type": "read-only",
                    "value": ""
                },
                "start_date": {
                    "api_type": "read-only",
                    "value": "2017-07-04"
                },
                "teaching_area": {
                    "api_type": "related",
                    "related_resource": "courses",
                    "value": "REL"
                },
                "title_code": {
                    "api_type": "read-only",
                    "key": true,
                    "value": "123"
                },
                "updated_by_id": {
                    "api_type": "read-only",
                    "description": "Joseph Smith",
                    "value": "123456789"
                },
                "year_term": {
                    "api_type": "read-only",
                    "description": "Fall 2017",
                    "key": true,
                    "long_description": "Fall Semester 2017",
                    "value": "20175"
                }
            }
        ]
    },
    "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"
            },
            "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"
            },
            "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"
            },
            "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"
            }
        },
        "metadata": {
            "collection_size": 0,
            "default_page_size": 100,
            "maximum_page_size": 100,
            "page_end": 1,
            "page_size": 100,
            "page_start": 1,
            "validation_response": {
                "code": 200,
                "message": "Success"
            }
        },
        "values": [
            {
                "add_error_message": {
                    "api_type": "read-only",
                    "value": ""
                },
                "added_by_id": {
                    "api_type": "read-only",
                    "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": 2
                },
                "curriculum_id": {
                    "api_type": "read-only",
                    "key": true,
                    "value": ""
                },
                "date_time_of_error": {
                    "api_type": "read-only",
                    "value": "2017-07-04T11:22:33.445Z"
                },
                "date_time_requested": {
                    "api_type": "read-only",
                    "value": "2017-07-04T11:22:33.445Z"
                },
                "links": {
                    "waitlisted_class__delete": {
                        "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                        "method": "DELETE",
                        "rel": "waitlisted_class__delete"
                    },
                    "waitlisted_class__info": {
                        "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                        "method": "GET",
                        "rel": "self"
                    },
                    "waitlisted_class__modify": {
                        "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                        "method": "PUT",
                        "rel": "waitlisted_class__modify"
                    }
                },
                "metadata": {
                    "validation_response": {
                        "code": 200,
                        "message": "Success"
                    }
                },
                "position_in_queue": {
                    "api_type": "read-only",
                    "value": 0
                },
                "section_number": {
                    "api_type": "read-only",
                    "key": true,
                    "value": ""
                },
                "sequencer": {
                    "api_type": "read-only",
                    "value": ""
                },
                "size_mix_category": {
                    "api_type": "read-only",
                    "value": ""
                },
                "teaching_area": {
                    "api_type": "related",
                    "related_resource": "courses",
                    "value": "REL"
                },
                "title_code": {
                    "api_type": "read-only",
                    "key": true,
                    "value": ""
                },
                "year_term": {
                    "api_type": "read-only",
                    "description": "Fall 2017",
                    "key": true,
                    "long_description": "Fall Semester 2017",
                    "value": "20175"
                }
            }
        ]
    }
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

enrolled_classes

GET /{byu_id}/enrolled_classes

Returns all enrolled_classes for the student


byu_id	BYU Identifier	path	string	#/parameters/byu_id
registration	Filter request to current year terms	query	string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

enrolled_classes

Example for application/json

{
    "links": {
        "enrolled_classes__add": {
            "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}",
            "method": "PUT",
            "rel": "enrolled_classes__add"
        },
        "enrolled_classes__info": {
            "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size",
            "method": "GET",
            "rel": "self"
        },
        "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"
        },
        "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"
        }
    },
    "metadata": {
        "collection_size": 0,
        "default_page_size": 50,
        "maximum_page_size": 1000,
        "page_end": 0,
        "page_size": 0,
        "page_start": 0,
        "validation_response": {
            "code": 200,
            "message": "Success"
        }
    },
    "values": [
        {
            "add_drop_card": {
                "api_type": "read-only",
                "value": ""
            },
            "add_message": {
                "api_type": "system",
                "value": ""
            },
            "added_by_id": {
                "api_type": "read-only",
                "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": 2
            },
            "curriculum_id": {
                "api_type": "read-only",
                "key": true,
                "value": "12345"
            },
            "date_added": {
                "api_type": "read-only",
                "value": "2017-07-04"
            },
            "date_graded": {
                "api_type": "read-only",
                "value": "2017-07-04"
            },
            "date_time_updated": {
                "api_type": "read-only",
                "value": "2017-07-04T11:22:33.445Z"
            },
            "drop_implications": {
                "discontinuance_messages": {
                    "api_type": "read-only",
                    "value": [
                    ]
                },
                "drop_allowed": {
                    "api_type": "read-only",
                    "value": 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/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
                    "method": "DELETE",
                    "rel": "enrolled_class__drop"
                },
                "enrolled_class__info": {
                    "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
                    "method": "GET",
                    "rel": "self"
                }
            },
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Success"
                }
            },
            "permission_code": {
                "api_type": "read-only",
                "value": ""
            },
            "section_number": {
                "api_type": "read-only",
                "key": true,
                "value": "123"
            },
            "section_type": {
                "api_type": "read-only",
                "value": ""
            },
            "start_date": {
                "api_type": "read-only",
                "value": "2017-07-04"
            },
            "teaching_area": {
                "api_type": "related",
                "related_resource": "courses",
                "value": "REL"
            },
            "title_code": {
                "api_type": "read-only",
                "key": true,
                "value": "123"
            },
            "updated_by_id": {
                "api_type": "read-only",
                "description": "Joseph Smith",
                "value": "123456789"
            },
            "year_term": {
                "api_type": "read-only",
                "description": "Fall 2017",
                "key": true,
                "long_description": "Fall Semester 2017",
                "value": "20175"
            }
        }
    ]
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Drops the student from the class

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

Drops the student from the class


byu_id	BYU Identifier	path	string	#/parameters/byu_id
year_term	Year Term of Class	path	string	#/parameters/year_term
curriculum_id	Curriculum Id of Class	path	string	#/parameters/curriculum_id
title_code	Title Code of Class	path	string	#/parameters/title_code
section_number	Section Number of Class	path	string	#/parameters/section_number
event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }	#/parameters/event_source

Uses default content-types: application/json

204 No Content

The enrolled class was deleted

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Retrieve a specific enrollment of the student

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

Retrieve a specific enrollment of the student


byu_id	BYU Identifier	path	string	#/parameters/byu_id
year_term	Year Term of Class	path	string	#/parameters/year_term
curriculum_id	Curriculum Id of Class	path	string	#/parameters/curriculum_id
title_code	Title Code of Class	path	string	#/parameters/title_code
section_number	Section Number of Class	path	string	#/parameters/section_number
event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }	#/parameters/event_source
class_schedule	Filter request to current year terms	query	string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

enrolled_class

Example for application/json

{
    "add_drop_card": {
        "api_type": "read-only",
        "value": ""
    },
    "add_message": {
        "api_type": "system",
        "value": ""
    },
    "added_by_id": {
        "api_type": "read-only",
        "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": 2
    },
    "curriculum_id": {
        "api_type": "read-only",
        "key": true,
        "value": "12345"
    },
    "date_added": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "date_graded": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "date_time_updated": {
        "api_type": "read-only",
        "value": "2017-07-04T11:22:33.445Z"
    },
    "drop_implications": {
        "discontinuance_messages": {
            "api_type": "read-only",
            "value": [
            ]
        },
        "drop_allowed": {
            "api_type": "read-only",
            "value": 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/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
            "method": "DELETE",
            "rel": "enrolled_class__drop"
        },
        "enrolled_class__info": {
            "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
            "method": "GET",
            "rel": "self"
        }
    },
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Success"
        }
    },
    "permission_code": {
        "api_type": "read-only",
        "value": ""
    },
    "section_number": {
        "api_type": "read-only",
        "key": true,
        "value": "123"
    },
    "section_type": {
        "api_type": "read-only",
        "value": ""
    },
    "start_date": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "teaching_area": {
        "api_type": "related",
        "related_resource": "courses",
        "value": "REL"
    },
    "title_code": {
        "api_type": "read-only",
        "key": true,
        "value": "123"
    },
    "updated_by_id": {
        "api_type": "read-only",
        "description": "Joseph Smith",
        "value": "123456789"
    },
    "year_term": {
        "api_type": "read-only",
        "description": "Fall 2017",
        "key": true,
        "long_description": "Fall Semester 2017",
        "value": "20175"
    }
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Enrolls the student in a class

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

Enrolls the student in a class

Uses default content-types: application/json

enrolled_class


byu_id	BYU Identifier	path	string	#/parameters/byu_id
year_term	Year Term of Class	path	string	#/parameters/year_term
curriculum_id	Curriculum Id of Class	path	string	#/parameters/curriculum_id
title_code	Title Code of Class	path	string	#/parameters/title_code
section_number	Section Number of Class	path	string	#/parameters/section_number
event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }	#/parameters/event_source
class_schedule	Filter request to current year terms	query	string

Uses default content-types: application/json

200 OK

The enrolled_classes for the student

enrolled_class

Example for application/json

{
    "add_drop_card": {
        "api_type": "read-only",
        "value": ""
    },
    "add_message": {
        "api_type": "system",
        "value": ""
    },
    "added_by_id": {
        "api_type": "read-only",
        "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": 2
    },
    "curriculum_id": {
        "api_type": "read-only",
        "key": true,
        "value": "12345"
    },
    "date_added": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "date_graded": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "date_time_updated": {
        "api_type": "read-only",
        "value": "2017-07-04T11:22:33.445Z"
    },
    "drop_implications": {
        "discontinuance_messages": {
            "api_type": "read-only",
            "value": [
            ]
        },
        "drop_allowed": {
            "api_type": "read-only",
            "value": 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/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
            "method": "DELETE",
            "rel": "enrolled_class__drop"
        },
        "enrolled_class__info": {
            "href": "https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number",
            "method": "GET",
            "rel": "self"
        }
    },
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Success"
        }
    },
    "permission_code": {
        "api_type": "read-only",
        "value": ""
    },
    "section_number": {
        "api_type": "read-only",
        "key": true,
        "value": "123"
    },
    "section_type": {
        "api_type": "read-only",
        "value": ""
    },
    "start_date": {
        "api_type": "read-only",
        "value": "2017-07-04"
    },
    "teaching_area": {
        "api_type": "related",
        "related_resource": "courses",
        "value": "REL"
    },
    "title_code": {
        "api_type": "read-only",
        "key": true,
        "value": "123"
    },
    "updated_by_id": {
        "api_type": "read-only",
        "description": "Joseph Smith",
        "value": "123456789"
    },
    "year_term": {
        "api_type": "read-only",
        "description": "Fall 2017",
        "key": true,
        "long_description": "Fall Semester 2017",
        "value": "20175"
    }
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Returns all waitlisted classes for the student

GET /{byu_id}/waitlisted_classes

Returns all waitlisted classes for the student


byu_id	BYU Identifier	path	string	#/parameters/byu_id

Uses default content-types: application/json

200 OK

The waitlisted_classes for the student

waitlisted_classes

Example for application/json

{
    "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"
        },
        "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"
        },
        "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"
        },
        "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"
        }
    },
    "metadata": {
        "collection_size": 0,
        "default_page_size": 100,
        "maximum_page_size": 100,
        "page_end": 1,
        "page_size": 100,
        "page_start": 1,
        "validation_response": {
            "code": 200,
            "message": "Success"
        }
    },
    "values": [
        {
            "add_error_message": {
                "api_type": "read-only",
                "value": ""
            },
            "added_by_id": {
                "api_type": "read-only",
                "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": 2
            },
            "curriculum_id": {
                "api_type": "read-only",
                "key": true,
                "value": ""
            },
            "date_time_of_error": {
                "api_type": "read-only",
                "value": "2017-07-04T11:22:33.445Z"
            },
            "date_time_requested": {
                "api_type": "read-only",
                "value": "2017-07-04T11:22:33.445Z"
            },
            "links": {
                "waitlisted_class__delete": {
                    "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                    "method": "DELETE",
                    "rel": "waitlisted_class__delete"
                },
                "waitlisted_class__info": {
                    "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                    "method": "GET",
                    "rel": "self"
                },
                "waitlisted_class__modify": {
                    "href": "https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number",
                    "method": "PUT",
                    "rel": "waitlisted_class__modify"
                }
            },
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Success"
                }
            },
            "position_in_queue": {
                "api_type": "read-only",
                "value": 0
            },
            "section_number": {
                "api_type": "read-only",
                "key": true,
                "value": ""
            },
            "sequencer": {
                "api_type": "read-only",
                "value": ""
            },
            "size_mix_category": {
                "api_type": "read-only",
                "value": ""
            },
            "teaching_area": {
                "api_type": "related",
                "related_resource": "courses",
                "value": "REL"
            },
            "title_code": {
                "api_type": "read-only",
                "key": true,
                "value": ""
            },
            "year_term": {
                "api_type": "read-only",
                "description": "Fall 2017",
                "key": true,
                "long_description": "Fall Semester 2017",
                "value": "20175"
            }
        }
    ]
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Remove Waitlisted Class

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

Remove student from class waitlist


byu_id	BYU Identifier	path	string	#/parameters/byu_id
year_term	Year Term of Class	path	string	#/parameters/year_term
curriculum_id	Curriculum Id of Class	path	string	#/parameters/curriculum_id
title_code	Title Code of Class	path	string	#/parameters/title_code
section_number	Section Number of Class	path	string	#/parameters/section_number
event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }	#/parameters/event_source

Uses default content-types: application/json

204 No Content

The waitlisted class was deleted

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Adds the student in a class waitlist

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

Adds the student in a class waitlist

Uses default content-types: application/json

waitlisted_class


byu_id	BYU Identifier	path	string	#/parameters/byu_id
year_term	Year Term of Class	path	string	#/parameters/year_term
curriculum_id	Curriculum Id of Class	path	string	#/parameters/curriculum_id
title_code	Title Code of Class	path	string	#/parameters/title_code
section_number	Section Number of Class	path	string	#/parameters/section_number
event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }	#/parameters/event_source

Uses default content-types: application/json

200 OK

The waitlisted class for the student

waitlisted_class

Example for application/json

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

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403 Forbidden #/responses/403

Access denied to protected data

error_response

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

error_response

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

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default #/responses/default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Parameter definitions


byu_id	byu_id	BYU Identifier	path	string
year_term	year_term	Year Term of Class	path	string
curriculum_id	curriculum_id	Curriculum Id of Class	path	string
title_code	title_code	Title Code of Class	path	string
section_number	section_number	Section Number of Class	path	string
event_source	event_source	What platform did this call come from?	query	string , x ∈ { Android , iOS , Desktop }
context	context	Indicates a set of subresources	query	string
field_sets	field_sets	List which subresources are to be returned	query	string
page_start	page_start	Skip into a large collection to this item	query	string
page_size	page_size	Return this many items of a large collection	query	string

Response definitions

400

Invalid Request - unable to interpret request

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 400,
            "message": "Invalid Request - unable to interpret request"
        }
    }
}

401

Authentication required to access data

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 401,
            "message": "Authentication required to access data"
        }
    }
}

403

Access denied to protected data

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 403,
            "message": "Access denied to protected data"
        }
    }
}

404

The resource does not exist

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 404,
            "message": "The resource does not exist"
        }
    }
}

409

Query parameters conflict or are malformed

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 409,
            "message": "Query parameters conflict or are malformed"
        }
    }
}

default

Unexpected error

error_response

Example for application/json

{
    "metadata": {
        "validation_response": {
            "code": 500,
            "message": "Internal Server Error"
        }
    }
}

Schema definitions

added_by_id: object

api_type: string , x ∈ { read-only (default) , modifiable }
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 byu_id of the identity that added the class.

basic: object

links: object

students__delete: object

href: string https://api.byu.edu/byuapi/students/:student_id: An explanation about the purpose of this instance.
method: string , x ∈ { DELETE (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

students__info: object

href: string https://api.byu.edu/byuapi/students/:student_id: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.
title: string , x ∈ { students__getStudent (default) }: An explanation about the purpose of this instance.

students__modify: object

href: string https://api.byu.edu/byuapi/students/:student_id: An explanation about the purpose of this instance.
method: string , x ∈ { PUT (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.
title: string , x ∈ { students__modifyStudent (default) }: An explanation about the purpose of this instance.

metadata: simple_metadata

byu_id: byu_id

deceased: object

api_type: string , x ∈ { read-only (default) }
value: boolean: An explanation about the purpose of this instance.

email_address: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

gender: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

name: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

net_id: net_id

phone: object

api_type: string , x ∈ { modifiable (default) }
value: string: An explanation about the purpose of this instance.

restricted: object

api_type: string , x ∈ { read-only (default) }
value: boolean: An explanation about the purpose of this instance.

byu_id: object

{
    "api_type": "system",
    "description": "Jospeh Smith",
    "key": true,
    "value": "123456789"
}

value: string , must match ^[0-9]{9}$
description: string (up to 50 chars) , must match ^(?=.{2,}?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+$
api_type: string , x ∈ { system (default) }
key: boolean true

course_number: object

api_type: string , x ∈ { related (default) }
key: boolean true
related_resource: string , x ∈ { courses (default) }: An explanation about the purpose of this instance.
value: string: An explanation about the purpose of this instance.

course_suffix: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }: An explanation about the purpose of this instance.
value: string: An explanation about the purpose of this instance.

course_title: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }: An explanation about the purpose of this instance.
value: string: An explanation about the purpose of this instance.

credit_hours: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: integer: An explanation about the purpose of this instance.

curriculum_id: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string: An explanation about the purpose of this instance.

date_time_updated: object

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

{
    "api_type": "read-only",
    "value": "2017-07-04T11:22:33.445Z"
}

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

enrolled_class: object

add_drop_card: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

add_message: object

api_type: string , x ∈ { system (default) }
value: string: An explanation about the purpose of this instance.

added_by_id: added_by_id

audit_status: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

block_code: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

byu_id: byu_id

class_repeated: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: boolean: An explanation about the purpose of this instance.

course_number: course_number

course_suffix: course_suffix

course_title: course_title

credit_hours: credit_hours

curriculum_id: curriculum_id

date_added: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date): An explanation about the purpose of this instance.

date_graded: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date): An explanation about the purpose of this instance.

date_time_updated: date_time_updated

drop_implications: object

discontinuance_messages: object

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

drop_allowed: object

api_type: string , x ∈ { read-only (default) }
value: boolean: An explanation about the purpose of this instance.

drop_message: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

impacted_enrollments: object

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

postrequisite_messages: object

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

end_date: object

api_type: string , x ∈ { read-only (default) }
value: string (date): An explanation about the purpose of this instance.

envelope_id: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

envelope_type: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

grade: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

graded_by_id: object

api_type: string , x ∈ { read-only (default) , modifiable }
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 , must match ^(|[0-9]{9})$: The byu_id of the identity who set the grade.

lab_quiz_section: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

links: object

enrolled_class__drop: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number: An explanation about the purpose of this instance.
method: string , x ∈ { DELETE (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { enrolled_class__drop (default) }: An explanation about the purpose of this instance.

enrolled_class__info: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/:year_term,:curriculum_id,:title_code,:section_number: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

metadata: simple_metadata

permission_code: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

section_number: section_number

section_type: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

start_date: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date): An explanation about the purpose of this instance.

teaching_area: teaching_area

title_code: title_code

updated_by_id: updated_by_id

year_term: year_term

enrolled_classes: object

links: object

enrolled_classes__add: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes/{year_term},{curriculum_id},{title_code},{section_number}: An explanation about the purpose of this instance.
method: string , x ∈ { PUT (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { enrolled_classes__add (default) }: An explanation about the purpose of this instance.

enrolled_classes__info: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

enrolled_classes__next: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { enrolled_classes__next (default) }: An explanation about the purpose of this instance.

enrolled_classes__prev: object

href: string https://api.byu.edu/byuapi/students/:byu_id/enrolled_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { enrolled_classes__prev (default) }: An explanation about the purpose of this instance.

metadata: sub_level_metadata

values: object[]

enrolled_class

error_response: object

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

metadata: simple_metadata

net_id: object

The user name to used for authentication to BYU web applications

{
    "api_type": "read-only",
    "value": "js279"
}

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

section_number: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string: An explanation about the purpose of this instance.

simple_metadata: object

validation_response: object

code: integer 200 (3 to 3 chars)
message: string Success

validation_information: string[]

string Success

cache: object

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

date_time: string (date-time)

student: object

basic: basic
enrolled_classes: enrolled_classes
waitlisted_classes: waitlisted_classes

students: object

links: object

students__create: object

href: string https://api.byu.edu/byuapi/students: An explanation about the purpose of this instance.
method: string , x ∈ { POST (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { students__create (default) }: An explanation about the purpose of this instance.

students__current: object

href: string https://api.byu.edu/byuapi/students?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { students__current (default) }: An explanation about the purpose of this instance.

students__info: object

href: string https://api.byu.edu/byuapi/students?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

students__next: object

href: string https://api.byu.edu/byuapi/students?page_start=:page_start_next,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { students__next (default) }: An explanation about the purpose of this instance.

students__prev: object

href: string https://api.byu.edu/byuapi/students?page_start=:page_start_prev,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { students__prev (default) }: An explanation about the purpose of this instance.

metadata: top_level_metadata

values: object[]

student

sub_level_metadata:

simple_metadata

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 } 50
maximum_page_size: integer , { x ∈ ℤ | x ≥ 0 } 200

teaching_area: object

api_type: string , x ∈ { related (default) }
related_resource: string , x ∈ { courses (default) }: An explanation about the purpose of this instance.
value: string: An explanation about the purpose of this instance.

title_code: object

api_type: string , x ∈ { read-only (default) }
key: boolean true
value: string: An explanation about the purpose of this instance.

top_level_metadata:

sub_level_metadata

field_sets_returned: string[] basic

string , x ∈ { basic , enrolled_classes , waitlisted_classes }

field_sets_available: string[] basic,enrolled_classes,waitlisted_classes

string , x ∈ { basic , enrolled_classes , waitlisted_classes }

field_sets_default: string[] basic

string , x ∈ { basic }

contexts_available: object

Pre-designated collections of field_sets

all: string[] basic,enrolled_classes,waitlisted_classes: string , x ∈ { basic , enrolled_classes , waitlisted_classes }

updated_by_id: object

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

{
    "api_type": "system",
    "description": "INIT",
    "value": "123456798"
}

api_type: string , x ∈ { read-only (default) , modifiable }
description: string (up to 50 chars): The display name of the identity that made the update. pattern: ^(|(?=.{2,}?[A-Z])([A-Za-z-]+ )*?[A-Za-z-]+)$
value: string: The byu_id of the identity that made the update.

waitlisted_class: object

links: object

waitlisted_class__delete: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number: An explanation about the purpose of this instance.
method: string , x ∈ { DELETE (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { waitlisted_class__delete (default) }: An explanation about the purpose of this instance.

waitlisted_class__info: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

waitlisted_class__modify: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes/:year_term,:curriculum_id,:title_code,:section_number: An explanation about the purpose of this instance.
method: string , x ∈ { PUT (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { waitlisted_class__modify (default) }: An explanation about the purpose of this instance.

metadata: simple_metadata

add_error_message: object

api_type: string , x ∈ { read-only (default) }
value: string: An explanation about the purpose of this instance.

added_by_id: added_by_id

byu_id: byu_id

course_number: course_number

course_suffix: course_suffix

course_title: course_title

credit_hours: credit_hours

curriculum_id: curriculum_id

date_time_of_error: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date-time): An explanation about the purpose of this instance.

date_time_requested: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string (date-time): An explanation about the purpose of this instance.

position_in_queue: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: integer: An explanation about the purpose of this instance.

section_number: section_number

sequencer: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

size_mix_category: object

api_type: string , x ∈ { read-only (default) , modifiable }
value: string: An explanation about the purpose of this instance.

teaching_area: teaching_area

title_code: title_code

year_term: year_term

waitlisted_classes: object

links: object

waitlisted_classes__add: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { PUT (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { waitlisted_classes__add (default) }: An explanation about the purpose of this instance.

waitlisted_classes__info: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { self (default) }: An explanation about the purpose of this instance.

waitlisted_classes__next: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { waitlisted_classes__next (default) }: An explanation about the purpose of this instance.

waitlisted_classes__prev: object

href: string https://api.byu.edu/byuapi/students/:byu_id/waitlisted_classes?page_start=:page_start,page_size=:page_size: An explanation about the purpose of this instance.
method: string , x ∈ { GET (default) }: An explanation about the purpose of this instance.
rel: string , x ∈ { waitlisted_classes__prev (default) }: An explanation about the purpose of this instance.

metadata: sub_level_metadata

values: object[]

waitlisted_class

year_term: object

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

description: string

An explanation about the purpose of this instance.

"Fall 2017"

long_description: string

The long name.

"Fall Semester 2017"

key: boolean true

value: string , must match ^[0-9]{5}$

The code value of the year term.

"20175"

Service Path:

/byuapi/students

Domain or University API:

/U/students

Tags:

byuapi

students

Students

Students

Summary

Paths

GET /{byu_id}

GET /{byu_id}/enrolled_classes

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

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

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

GET /{byu_id}/waitlisted_classes

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

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

Parameter definitions

Response definitions

Schema definitions

added_by_id: object

basic: object

byu_id: object

course_number: object

course_suffix: object

course_title: object

credit_hours: object

curriculum_id: object

date_time_updated: object

enrolled_class: object

enrolled_classes: object

error_response: object

net_id: object

section_number: object

simple_metadata: object

student: object

students: object

sub_level_metadata:

teaching_area: object

title_code: object

top_level_metadata:

updated_by_id: object

waitlisted_class: object

waitlisted_classes: object

year_term: object

Community

View This API in the API Store

Get Elevated Access

Tags