AcademicClassScheduleOfferings

CourseOfferingsService

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{curriculumID_teachingArea}/{titleCode_catalogNumber}/{yearTerm} GET

Shows courses offered by specified Curriculum ID and Title Code OR Shows courses offered by a specified Teaching Area and Catalog Number

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Shows courses offered by specified Curriculum ID and Title Code OR Shows courses offered by a specified Teaching Area and Catalog Number

GET /{curriculumID_teachingArea}/{titleCode_catalogNumber}/{yearTerm}

Tags: CourseOfferingsService

Shows courses offered by specified Curriculum ID and Title Code OR Shows courses offered by a specified Teaching Area and Catalog Number

curriculumID_teachingArea

Identification of the Curriculum courses are in -> 5 digit int OR Determines a specific teaching area ->String of 3 to 5 chars

path string
titleCode_catalogNumber

title code of the courses -> 3 digit int OR A specific catalog number -> 3 digit int, sometimes has apended char

path string
yearTerm

year and term specified

path string ([1-2][0-9]{3}[1345])

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/01489/002/20181/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"catalogNumber": "142",
"catalogSuffix": "",
"courseList": [
{
"availableSeats": 85,
"building": "TMCB",
"classDays": "MWF",
"classTime": "9:00a - 9:50a",
"credits": "3.0",
"endDate": "18 Apr 2018",
"envelopes": "",
"honors": "",
"instructor": "Teacher, Professor",
"labQuizSection": "",
"raincheck": "",
"regMethod": "O",
"room": "1170",
"sectionNumber": "001",
"sectionType": "",
"size": "203",
"startDate": "08 Jan 2018",
"totalEnrolled": "118",
"waitlisted": "0"
}
]
,
"courseTotals": [
{
"capacity": "1250",
"enrollment": "654",
"raincheck": "0",
"seatsAvailable": "348",
"size": "1002",
"waitlisted": "0"
}
]
,
"curriculumID": "01489",
"departmentName": "C S",
"termDates": "Winter 2018 (08 Jan 2018 - 18 Apr 2018)",
"titleCode": "002",
"transcriptTitle": "Intro to Computer Programming"
}
}
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.

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

attributes: string

availableSeats: integer

building: string

capacity: string

catalogNumber: string

catalogSuffix: string

classDays: string

classTime: string

courseList: object[]

object
regMethod: regMethod
availableSeats: availableSeats
size: size
totalEnrolled: totalEnrolled
raincheck: raincheck
waitlisted: waitlisted
sectionNumber: sectionNumber
labQuizSection: labQuizSection
honors: honors
credits: credits
sectionType: sectionType
classTime: classTime
classDays: classDays
room: room
building: building
instructor: instructor
envelopes: envelopes
startDate: startDate
endDate: endDate

CourseOfferingService: object

request: request
response: response

courseTotals: object[]

object
seatsAvailable: seatsAvailable
size: size
enrollment: enrollment
capacity: capacity
raincheck: raincheck
waitlisted: waitlisted

credits: string

curriculumID: string

departmentName: string

endDate: string

enrollment: string

envelopes: string

honors: string

instructor: string

labQuizSection: string

method: string

raincheck: string

regMethod: string

request: object

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

response: object

departmentName: departmentName
catalogNumber: catalogNumber
catalogSuffix: catalogSuffix
transcriptTitle: transcriptTitle
curriculumID: curriculumID
titleCode: titleCode
termDates: termDates
courseTotals: courseTotals
courseList: courseList

room: string

seatsAvailable: string

sectionNumber: string

sectionType: string

size: string

startDate: string

status: number

statusMessage: string

termDates: string

titleCode: string

totalEnrolled: string

transcriptTitle: string

waitlisted: string

Service Path: 
/domains/legacy/academic/classschedule/offerings
Domain or University API: 
/domains/D/academic/classschedule/offerings

Community

 

Don't see your question listed here? Ask!