AcademicClassScheduleSummary

This service summarizes capacity and enrollment totals for all courses offered by a teaching area during a particular year term.

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

Contact Info: api@byu.edu

Base URL: /domains/legacy/academic/classschedule/summary

Version: v1

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

Schemes: https

Summary

Path	Operation	Description
/{teaching_area}/{yearTerm}	GET	Get department course summary information a given year-term and department.

Paths

Get department course summary information a given year-term and department.

GET /{teaching_area}/{yearTerm}

Tags: SummaryService

Get department course summary information a given year-term and department.


teaching_area	string ->	path	string
yearTerm	yearTerm -> [1-2][0-9]{3}[1345]	path	string

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

200 OK

return the summary of courses offered by a teaching area during a particular year-term.

DepartmentCourseSummaryService

Example for application/json

{
    "request": {
        "attributes": "",
        "method": "GET",
        "resource": "/json/C S/20181/",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "courses": [
            {
                "allowFlexTitle": false,
                "availableSeats": 348,
                "catalogNumber": "142",
                "catalogSuffix": "",
                "crossListedCourseCount": "1",
                "curriculumId": "01489",
                "fullSectionCount": 1,
                "honors": false,
                "permissionCodesAllowed": true,
                "rainchecked": 0,
                "sectionCount": 7,
                "sectionSize": 1002,
                "titleCode": "002",
                "totalEnrolled": 654,
                "transcriptTitle": "Intro to Computer Programming"
            }
        ],
        "departmentName": "C S",
        "semesterEndDate": "2018-04-25",
        "semesterStartDate": "2018-01-08",
        "totalAvailableSections": 1314,
        "totalEnrolled": 3513,
        "totalFullSections": 11,
        "totalRainchecked": 0,
        "totalSeatsInAllSections": 4827,
        "totalSections": 72,
        "totalWaitlisted": 0,
        "yearTerm": "20181"
    }
}

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

Failure 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.

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