This API returns the public information for course offerings (course sections) for a given termCode and subjectCode. The response is available as JSON or XML. Authentication is required via an API Key which is received after registering an application within the Developer Portal.
Endpoint: https://gw.its.yale.edu/soa-gateway/courses/webservice/v3/index
Request Parameters
|
Name |
Type |
Restriction |
Description |
|---|---|---|---|
|
apikey |
string | required | Enter the API Key received within the Developer Portal upon registration of an application for this API. |
|
subjectCode |
string | required |
Specify the course subject code. This data may include ampersands which should be encoded as %26. Example: ACCT, AFAM, PLSC, ENGL, EP&E
|
|
termCode |
string | optional |
Specify the term code. This is a 6 character string where the first four characters are the year and the last 2 characters are the term designation (01 = Spring, 02 = Summer, 03 = Fall).
Example:
If no termCode is submitted, the API will use the current default term (Spring or Fall). This value changes to the next term on January 3rd and June 1st.
|
|
mode |
string | optional |
Specify the desired response output type. Example: json or xml
|
| school | string | optional | Service returns default YC Yale College and SU Summer Sessions. To specify other schools, submit appropriate school code (ex. school=GS). |
Data Response
|
Name |
Type |
Description |
||||
|---|---|---|---|---|---|---|
|
cSectionStatus |
string |
Course section status. (A - Active, B - Moved to spring term, C - Cancelled, D - Moved to preceding fall term, E - Closed to further enrollments, N - Number changed)
|
||||
|
class |
string | Class. Example: edu.yale.course.Course | ||||
|
courseNumber |
alphanumeric |
Course number. Example: 101
|
||||
|
courseTitle |
string | Full title for the course. Example: Geometry of Nature | ||||
|
crn |
numeric | Unique Course Registration Number (CRN). Example: 20233 | ||||
|
department |
string |
Four-character code for department offering the section. This value may resemble the subject code, but the two are not the same. Example: The department of Spanish and Portuguese (SP&P) offers courses with subject codes SPAN and PORT, the English department (ENGL) offers courses with subject code ENGL.
|
||||
|
description |
string | Full description for the course (HTML-safe). | ||||
|
distDesg* |
string | The designations for Yale College distributional requirements.
|
||||
|
finalExam |
numeric | This code indicates the exam group to which this section belongs. This is only valid for Yale College. If no code, then no final exam is given. Refer to the site of the Office of the Registrar for detailed times and locations. | ||||
|
instructorList* |
string |
List of instructor names. TAs are not included due to FERPA rules. |
||||
|
instructorUPI* |
string | List of instructor Yale UPI. May or may not appear in same order as names list above. | ||||
| meetingEndTimeList | string | List of meeting end times in same order as meetingStartTimeList below (class meeting 1, 2, 3, etc.) | ||||
| meetingPattern* | string | String that describes the days of the week and times that the section meets. | ||||
| meetingStartTimeList | string | List of meeting start times in same order as meetingEndTimeList above (class meeting 1, 2, 3, etc.) | ||||
| prerequisites | string | Description of prerequisites for course: other courses or skill levels. | ||||
| primXLst | string | The course number (example PLSC118, ASTR170) of the primary course in a multi-title relationship. This would return a value only if the offering in this record were a “secondary” numbering. | ||||
|
schoolCode |
string | Two-character abbreviation for the school. Example: YC | ||||
|
schoolDescription |
string | Full name of school offering the course. Example: Yale College | ||||
|
scndXLst* |
string | The course number(s) of the secondary course(s) in a multi-title relationship excluding the current number. | ||||
|
sectionNumber |
numeric | Section for the course. Example: 01 | ||||
| sectionStatus | string | A=Active;O=Active;C=Cancelled;X=Not Offered (same as cSectionStatus) | ||||
| session | string | For Summer courses, the 3-character session identifier (e.g. H5A) | ||||
|
shortTitle |
string | Short title for the course. Example: Geometry of Nature | ||||
|
subjectCode |
string | Short code for subject used in course number. Example: MATH | ||||
|
subjectNumber |
string | Concatenated subject code and number. Example: MATH101 | ||||
| syllabusLink | string | URL for location of the section syllabus | ||||
|
termCode |
numeric | Four digit year and two digit term (01, 02, 03) without spaces. Example: 201401=Spring 2014 |
*Response may contain multiple values