AcademicClassScheduleClsEnrollmentCounts

Provides the enrollment count data for a class

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

Base URL: /domains/legacy/academic/class_schedule/cls_enrollment_counts

Version: v1

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

Summary

Path Operation Description
/ GET

enrollment counts for one or a list of classes

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

enrollment counts for a class

Paths

enrollment counts for one or a list of classes

GET /

Tags: enrollmentcounts

This service takes a query parm as its argument. ?sections= it allows for one or multiple sections of a class to be requested in the same call. Each section record consists of a year_term, curriculum_id, title_code and section_number separated by periods. Each section record is separated by a comma to get counts for 1 section: ?sections=20175.06387.001.001 to get counts for more than 1 section at a time: ?sections=20175.06387.001.001,20175.01857.005.022

sections

The list of class key for a list of classes

query string

Uses default content-types: application/json application/xml

200 OK

Expected response

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/20161/06387/001/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"enrollment_counts": [
{
"class_size": 33,
"class_start": 766,
"credit_institution": "BYU PROVO",
"curriculum_id": "06387",
"envelope_only": "N",
"fixed_or_variable": "F",
"reg_end": 759,
"reg_method": "O",
"reg_start": 836,
"seats_available": 10,
"section_number": "001",
"section_type": "DAY",
"title_code": "001",
"total_enrolled": 23,
"unused_permission_codes": 0,
"waitlist_count": 0,
"waitlist_status": "E",
"year_term": "20161",
"year_term_desc": "Winter 2016",
"year_term_ext_desc": "Winter Semester 2016"
}
]
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failed to authenticate.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

enrollment counts for a class

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

Tags: enrollmentcounts
year_term

The year term of the class

path string , must match ^[0-9]{5}$
curriculum_id

The curriculum id of the class

path string , must match ^[0-9]{5}$
title_code

The title code of the class

path string , must match ^[0-9]{3}$
section_number

The section number of the class

path string , must match ^[0-9]{3}$

Uses default content-types: application/json application/xml

200 OK

Expected response

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/20161/06387/001/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"enrollment_counts": [
{
"class_size": 33,
"class_start": 766,
"credit_institution": "BYU PROVO",
"curriculum_id": "06387",
"envelope_only": "N",
"fixed_or_variable": "F",
"reg_end": 759,
"reg_method": "O",
"reg_start": 836,
"seats_available": 10,
"section_number": "001",
"section_type": "DAY",
"title_code": "001",
"total_enrolled": 23,
"unused_permission_codes": 0,
"waitlist_count": 0,
"waitlist_status": "E",
"year_term": "20161",
"year_term_desc": "Winter 2016",
"year_term_ext_desc": "Winter Semester 2016"
}
]
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

401 Unauthorized

Failed to authenticate.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

ClsEnrollmentCountsService: object

request: request
response: response

enrollment_counts: object

year_term: string
year_term_desc: string
year_term_ext_desc: string
curriculum_id: string
title_code: string
section_number: string
credit_institution: string
section_type: string
reg_method: string
fixed_or_variable: string
waitlist_status: string
envelope_only: string
class_start: number
reg_start: number
reg_end: number
class_size: number
total_enrolled: number
waitlist_count: number
seats_available: number
unused_permission_codes: number

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

A collection of Enrollment Counts

enrollment_counts: object[]
Service Path: 
/domains/legacy/academic/class_schedule/cls_enrollment_counts
Domain or University API: 
/domains/D/academic/class_schedule/cls_enrollment_counts

Community

 

Don't see your question listed here? Ask!