Classes

Classes Resource of the University API

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

Base URL: /byuapi/classes

Version: v1

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

Summary

Path Operation Description
/ GET

Classes

OPTIONS

Classes

POST

Classes

PUT

Classes

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

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students/{person_id},{date_created_key} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors/{person_id},{instructor_type} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules/{sequence_number} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/class_headers GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/class_headers/{sequence_number} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/class_limitations GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/class_limitations/{limitation_type},{limitation_value} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/course_headers GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/course_headers/{sequence_number} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/course_limitations GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/course_limitations/{limitation_type},{limitation_value} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/enrolled_student_logs GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/enrolled_student_logs/{enrolled_student_log_id} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/enrolled_students GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/enrolled_students/{person_id} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/linked_classes GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/notes GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/notes/{note_type},{note_value} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/permission_to_add_codes GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/permission_to_add_codes/{code_value} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/prerequisites GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/size_mixes GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/size_mixes/{size_mix_category},{size_mix_type} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/summary GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/teaching_area_headers GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/teaching_area_headers/{sequence_number} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/waitlisted_student_logs GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/waitlisted_student_logs/{person_id},{action_date_time} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/waitlisted_students GET

Classes

OPTIONS

Classes

POST

Classes

/{year_term},{curriculum_id},{title_code},{section_number}/waitlisted_students/{person_id} DELETE

Classes

GET

Classes

OPTIONS

Classes

PUT

Classes

Paths

Classes

GET /

Tags: Classes

Returns a collection of AIM Classes

year_term

Enrollment period in which the class is offered

query string
curriculum_id

The curriculum designator for the course

query string
title_code

Differentiates the different curriculum offerings

query string
section_number

The section designator

query string
teaching_area

The subject area of the class offering

query string
catalog_number

The catalog number of the class offering

query string
catalog_suffix

The catalog suffix of the class offering

query string
enrollment_status

Indicates what enrollment actions may be performed on the class

query string
credit_hours

How many credit hours the class is worth

query string
section_type

The type of section (DAY, EVENING, SLC)

query string
honors

If the section is an honors section

query string
person_id

Classes with this instructor

query string
instructor_net_id

Classes with this instructor - use net_id of the instructor

query string
days_taught

Limit the classes collection to the following days

query string
time_taught

Limit the classes collection to the following times

query string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be returned in collection

query string
page_start

Skip into the classes collection before starting to return items

query string
page_size

The number of items of the classes collection returned

query string
block

The block of the AIM Class

query string
course_number

The number designator for the course

query string
course_level

The level of the course

query string
building

The building location of the AIM Class

query string
begin_time

The time the AIM Class begins

query string
end_time

The time the AIM Class ends

query string
instructor

The teacher over the class

query string
course_title

The title of the course

query string
course_description

The description of the course

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

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

No Classes satisfy the query parameters - the collection is empty

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

query string
curriculum_id

The curriculum designator for the course

query string
title_code

Differentiates the different curriculum offerings

query string
section_number

The section designator

query string
teaching_area

The subject area of the class offering

query string
catalog_number

The catalog number of the class offering

query string
catalog_suffix

The catalog suffix of the class offering

query string
enrollment_status

Indicates what enrollment actions may be performed on the class

query string
credit_hours

The credit hours the class is worth

query string
section_type

The type of section (DAY, EVENING, SLC)

query string
honors

If the section is an honors section

query string
person_id

Classes with this instructor

query string
instructor_net_id

Classes with this instructor - use net_id of the instructor

query string
days_taught

Limit the classes collection to the following days

query string
time_taught

Limit the classes collection to the following times

query string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be returned in collection

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /

Tags: Classes

Create a new AIM Class

The class to be added

Uses default content-types: application/json

201 Created

Returns the class that was added

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to schedule a new class

403 Forbidden

Access denied - not authorized to schedule the new class

409 Conflict

Body of the request contains conflicting, malformed, or invalid data

default

Unexpected error

Classes

PUT /

Tags: Classes

Modify a specific AIM Class (defined by query parameters)

The class to be modified

year_term

Enrollment period in which the class is offered

query string
teaching_area

The subject area of the class offering

query string
catalog_number

The catalog number of the class offering

query string
catalog_suffix

The catalog suffix of the class offering

query string
section_number

The section designator

query string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be returned in collection

query string

Uses default content-types: application/json

200 OK

Returns the class that was modified

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to modify a class

403 Forbidden

Access denied - not authorized to modify the class

409 Conflict

Body of the request contains conflicting, malformed, or invalid data

default

Unexpected error

Classes

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

Tags: Classes

Delete/Cancel a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string

Uses default content-types: application/json

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to delete/cancel a class

403 Forbidden

Access denied to protected data

409 Conflict

Unable to perform delete/cancel request

default

Unexpected error

Classes

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

Tags: Classes

Returns a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be returned in collection

query string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to schedule a new class

403 Forbidden

Access denied to protected data

404 Not Found

Class does not exist

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
catalog_number

The catalog number of the class offering

query string
catalog_suffix

The catalog suffix of the class offering

query string
enrollment_status

Indicates what enrollment actions may be performed on the class

query string
credit_hours

The credit hours the class is worth

query string
section_type

The type of section (DAY, EVENING, SLC)

query string
honors

If the section is an honors section

query string
person_id

Classes with this instructor

query string
instructor_net_id

Classes with this instructor - use net_id of the instructor

query string
days_taught

Limit the classes collection to the following days

query string
time_taught

Limit the classes collection to the following times

query string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be returned in collection

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

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

Tags: Classes

Modify a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
context

Defines a group of field sets to be returned in collection

query string
field_sets

List of field sets to be modified in collection

query string

Uses default content-types: application/json

200 OK

The specific AIM class that was modified

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to modify a class

403 Forbidden

Access denied to protected data

409 Conflict

Unable to perform update request

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students

Tags: Classes

Returns the add approved students for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the add_approved_students collection before starting to return items

query string
page_size

The number of items of the add_approved_students collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

404 Not Found

No approved students for specific AIM Class

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students

Tags: Classes

Add an approved student for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string

Uses default content-types: application/json

201 Created

Return the added student

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to add add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Body of the request contains conflicting, malformed, or invalid data

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students/{person_id},{date_created_key}

Tags: Classes

Delete an add permission code for a specific AIM Class and student combination

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person_id of the student

path string
date_created_key

Returns the add permission codes for a specific date

path string

Uses default content-types: application/json

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to delete add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students/{person_id},{date_created_key}

Tags: Classes

Returns the add permission codes for a specific AIM Class and student

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person_id of the student

path string
date_created_key

Returns the add permission codes for a specific date

path string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students/{person_id},{date_created_key}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

path string
date_created_key

Returns the add permission codes for a specific date

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to access data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/add_approved_students/{person_id},{date_created_key}

Tags: Classes

Modifies/Redeems an add permission code for a specific AIM Class and student combination

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person_id of the student

path string
date_created_key

Returns the add permission codes for a specific date

path string

Uses default content-types: application/json

200 OK

A collection of Classes

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to modify add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Body of the request contains conflicting, malformed, or invalid data

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors

Tags: Classes

Returns the instructors assigned to a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the assigned_instructors collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

Assigned instructor does not exist

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors

Tags: Classes

Create new instructor assigned to AIM Class

Instructors assigned to AIM class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string

Uses default content-types: application/json

201 Created

Assigned instructor added to collection

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors/{person_id},{instructor_type}

Tags: Classes
year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person designator for the instructor

path string
instructor_type

The type of the instructor

path string

Uses default content-types: application/json

204 No Content

No class/instructor combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors/{person_id},{instructor_type}

Tags: Classes

Returns the class associated with the given person id

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person designator for the instructor

path string
instructor_type

The type of the instructor

path string
page_start

Skip into the assigned_instructors collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors/{person_id},{instructor_type}

Tags: Classes

Display all available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
person_id

The person designator for the instructor

path string
instructor_type

The type of the instructor

path string

Uses default content-types: application/json

200 OK

Items Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/assigned_instructors/{person_id},{instructor_type}

Tags: Classes

Modifies/Redeems an assigned_instructor for a specific instructor id and instructor type

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
person_id

The person designator for the instructor

path string
instructor_type

The type of the instructor

path string

Uses default content-types: application/json

200 OK

Item Retrieved

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules

Tags: Classes

Returns the schedules for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the assigned schedules collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

The person_id for the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules

Tags: Classes

Create new assigned schedule

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

The person_id for the student

query string

Uses default content-types: application/json

201 Created

Collection Created

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules/{sequence_number}

Tags: Classes

Delete/Remove an assigned schedule with a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

The sequence number of an assigned schedule

path string

Uses default content-types: application/json

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules/{sequence_number}

Tags: Classes

Return the assigned schedule associated with the sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
sequence_number

The sequence number of an assigned schedule

path string

Uses default content-types: application/json

200 OK

Item Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules/{sequence_number}

Tags: Classes

Display all available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

The sequence number of an assigned schedule

path string

Uses default content-types: application/json

200 OK

Item Retrieved

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/assigned_schedules/{sequence_number}

Tags: Classes

Modifies/Redeems an assigned schedule for the sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

The sequence number of an assigned schedule

path string

Uses default content-types: application/json

200 OK

Item Retrieved

204 No Content

No class/student combination found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view add_approved_students

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/class_headers

Tags: Classes

Returns the class schedule section headers for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the class headers collection before starting to return items

query string
page_size

The number of items of the identity collection are returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/class_headers

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/class_headers

Tags: Classes

Create new class headers for AIM class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Created

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/class_headers/{sequence_number}

Tags: Classes

Delete/Remove class header for specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/class_headers/{sequence_number}

Tags: Classes

Returns the classes associated with a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/class_headers/{sequence_number}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/class_headers/{sequence_number}

Tags: Classes

Modifies/Redeems class header for a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations

Tags: Classes

Returns the class limitations for AIM Classes

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the class limitations collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

Class limitation does not exist

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations

Tags: Classes

Create new limitation for AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string

Uses default content-types: application/json

201 Created

Class limitation added to collection

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations/{limitation_type},{limitation_value}

Tags: Classes

Delete/Remove a class limitation

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations/{limitation_type},{limitation_value}

Tags: Classes

Returns the class limitations for a specific AIM class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations/{limitation_type},{limitation_value}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/class_limitations/{limitation_type},{limitation_value}

Tags: Classes

Modifies/Redeems a class limitation for the limitation type and limitation value

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/course_headers

Tags: Classes

Returns the course section headers for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the course headers collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/course_headers

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/course_headers

Tags: Classes

Create new course headers for AIM class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

201 Created

Collection Created

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/course_headers/{sequence_number}

Tags: Classes

Delete/Remove course headers for a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/course_headers/{sequence_number}

Tags: Classes

Returns the courses associated with a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/course_headers/{sequence_number}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/course_headers/{sequence_number}

Tags: Classes

Modifies/Redeems course headers for a specific sequence number

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
sequence_number

A sequence number for a specific class header

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations

Tags: Classes

Returns the limitations for courses

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into the course limitations collection before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

POST /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations

Tags: Classes

Creates new course limitations for AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
teaching_area

The subject area of the class offering

query string
person_id

the person_id of the student

query string

Uses default content-types: application/json

201 Created

Collection Created

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

DELETE /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations/{limitation_type},{limitation_value}

Tags: Classes

Delete/Remove a course limitation with specific limitation types and limitation values

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations/{limitation_type},{limitation_value}

Tags: Classes

Returns the limitations for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

404 Not Found

No class found that matches key values

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

OPTIONS /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations/{limitation_type},{limitation_value}

Tags: Classes

Display available options

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

PUT /{year_term},{curriculum_id},{title_code},{section_number}/course_limitations/{limitation_type},{limitation_value}

Tags: Classes

Modifies/Redeems course limitations for specific limitation types and limitation value

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different curriculum offerings

path string
section_number

The section designator

path string
limitation_type

The type of the limitation

path string
limitation_value

The value of the limitation

path string

Uses default content-types: application/json

200 OK

Collection Retrieved

204 No Content

No class found that matches key values

400 Bad Request

Invalid Request - unable to interpret request

401 Unauthorized

Authentication required to view data

403 Forbidden

Access denied to protected data

409 Conflict

Query parameters conflict or are malformed

default

Unexpected error

Classes

GET /{year_term},{curriculum_id},{title_code},{section_number}/enrolled_student_logs

Tags: Classes

Returns the log records for enrollment actions for a specific AIM Class

year_term

Enrollment period in which the class is offered

path string
curriculum_id

The curriculum designator for the course

path string
title_code

Differentiates the different offerings of the course

path string
section_number

The section designator

path string
page_start

Skip into enrolled student logs before starting to return items

query string
page_size

The number of items of the identity collection returned

query string

Uses default content-types: application/json

200 OK

Collection Retrieved

400 Bad Request

Invalid Request - unable to interpret request