-
Notifications
You must be signed in to change notification settings - Fork 10
OData Entities
haydenmc edited this page Jan 3, 2015
·
10 revisions
The Purdue.io database is organized into a database of entities with different kinds of relationships to one other. This database is exposed via OData to allow API users to write flexible, powerful queries against course catalog data.
Below you'll find a list of each entity, and what kind of data it contains.
<tr>
<td>TermId</td>
<td>Guid</td>
<td>A unique identifier for a specific term.</td>
</tr>
<tr>
<td>TermCode</td>
<td>String</td>
<td>Official myPurdue term code, i.e. "201520".</td>
</tr>
<tr>
<td>Name</td>
<td>String</td>
<td>Name of the term, i.e. "Spring 2015".</td>
</tr>
<tr>
<td>StartDate</td>
<td>DateTimeOffset</td>
<td>Starting date of the term, i.e. "2015-01-12T00:00:00Z".</td>
</tr>
<tr>
<td>EndDate</td>
<td>DateTimeOffset</td>
<td>Ending date of the term, i.e. "2015-05-12T00:00:00Z".</td>
</tr>
<tr>
<td>Classes</td>
<td>Array<Class></td>
<td>A list of Class entities in this Term.</td>
</tr>
| Property | Type | Description |
|---|
<tr>
<td>SubjectId</td>
<td>Guid</td>
<td>A unique identifier for a specific subject.</td>
</tr>
<tr>
<td>Name</td>
<td>String</td>
<td>Official subject name, i.e. "Mathematics".</td>
</tr>
<tr>
<td>Abbreviation</td>
<td>String</td>
<td>Subject standard abbreviation, i.e. "MA".</td>
</tr>
<tr>
<td>Courses</td>
<td>Array<Course></td>
<td>A list of Course entities in this Subject.</td>
</tr>
| Property | Type | Description |
|---|
<tr>
<td>CourseId</td>
<td>Guid</td>
<td>A unique identifier for a specific course.</td>
</tr>
<tr>
<td>Number</td>
<td>String</td>
<td>Course number in a 5 digit string, i.e. "26100".</td>
</tr>
<tr>
<td>Title</td>
<td>String</td>
<td>Title of the course, i.e. "Multivariate Calculus".</td>
</tr>
<tr>
<td>CreditHours</td>
<td>Double</td>
<td>Numeric value of credits for the course, i.e. "4.0".</td>
</tr>
<tr>
<td>Description</td>
<td>String</td>
<td>Course description and/or notes, i.e. "Evening Exams Required".</td>
</tr>
<tr>
<td>Subject</td>
<td>Subject</td>
<td>Subject entity.</td>
</tr>
<tr>
<td>Classes</td>
<td>Array<Class></td>
<td>A list of Class entities.</td>
</tr>
| Property | Type | Description |
|---|
<tr>
<td>ClassId</td>
<td>Guid</td>
<td>A unique identifier for a specific class.</td>
</tr>
<tr>
<td>Course</td>
<td>Course</td>
<td>Course entity.</td>
</tr>
<tr>
<td>Term</td>
<td>Term</td>
<td>Term entity.</td>
</tr>
<tr>
<td>Campus</td>
<td>Campus</td>
<td>Campus entity.</td>
</tr>
<tr>
<td>Sections</td>
<td>Array<Section></td>
<td>A list of Section entities.</td>
</tr>
| Property | Type | Description |
|---|
<tr>
<td>SectionId</td>
<td>Guid</td>
<td>A unique identifier for a specific section.</td>
</tr>
<tr>
<td>CRN</td>
<td>String</td>
<td>The official number of a section that Purdue uses for reference, i.e. "13342".</td>
</tr>
<tr>
<td>Type</td>
<td>String</td>
<td>The type of the section, i.e. "Lecture".</td>
</tr>
<tr>
<td>RegistrationStatus</td>
<td>String</td>
<td>Status of the section's registration, i.e. "NotAvailable".</td>
</tr>
<tr>
<td>StartDate</td>
<td>DateTimeOffset</td>
<td>Starting date of the section, i.e. "2015-01-12T00:00:00Z".</td>
</tr>
<tr>
<td>EndDate</td>
<td>DateTimeOffset</td>
<td>Ending date of the section, i.e. "2015-01-12T00:00:00Z".</td>
</tr>
<tr>
<td>Capacity</td>
<td>Int32</td>
<td>Maximum number of students that can enroll in the section, i.e. 108.</td>
</tr>
<tr>
<td>Enrolled</td>
<td>Int32</td>
<td>Number of students currently enrolled in the section, i.e. 10.</td>
</tr>
<tr>
<td>RemainingSpace</td>
<td>Int32</td>
<td>Number of seats available in the section, i.e. 98.</td>
</tr>
<tr>
<td>WaitlistCapacity</td>
<td>Int32</td>
<td>Number of students allowed on the section's waitlist, i.e. 36.</td>
</tr>
<tr>
<td>WaitlistCount</td>
<td>Int32</td>
<td>Number of students currently on the section's waitlist, i.e. 0.</td>
</tr>
<tr>
<td>WaitlistSpace</td>
<td>Int32</td>
<td>Number of spaces available on the section's waitlist, i.e. 36.</td>
</tr>
<tr>
<td>Class</td>
<td>Class</td>
<td>Class entity that this section belongs to</td>
</tr>
<tr>
<td>Meetings</td>
<td>Array<Meeting></td>
<td>List of meetings held in this section.</td>
</tr>
| Property | Type | Description |
|---|
<tr>
<td>MeetingId</td>
<td>Guid</td>
<td>A unique identifier for a specific meeting.</td>
</tr>
<tr>
<td>Type</td>
<td>String</td>
<td>The type of the meeting, i.e. "Lecture".</td>
</tr>
<tr>
<td>StartDate</td>
<td>DateTimeOffset</td>
<td>Starting date of the meeting, i.e. "2015-01-12T00:00:00Z".</td>
</tr>
<tr>
<td>EndDate</td>
<td>DateTimeOffset</td>
<td>Ending date of the meeting, i.e. "2015-01-12T00:00:00Z".</td>
</tr>
<tr>
<td>DaysOfWeek</td>
<td>String</td>
<td>A comma delimited list of days the meeting takes place, i.e. "Monday, Wednesday, Friday".</td>
</tr>
<tr>
<td>StartTime</td>
<td>DateTimeOffset</td>
<td>Time at which the meeting takes place, i.e. "2014-10-27T08:30:00Z".</td>
</tr>
<tr>
<td>Duration</td>
<td>TimeSpan</td>
<td>Length of time of the meeting, i.e. "PT50M".</td>
</tr>
<tr>
<td>Section</td>
<td>Section</td>
<td>Section entity that this meeting belongs to.</td>
</tr>
<tr>
<td>Instructors</td>
<td>Array<Instructor></td>
<td>List of instructors teaching this meeting.</td>
</tr>
<tr>
<td>Room</td>
<td>Room</td>
<td>Room entity that this meeting takes place in.</td>
</tr>
| Property | Type | Description |
|---|
##Instructor
<tr>
<td>InstructorId</td>
<td>Guid</td>
<td>A unique identifier for a specific instructor.</td>
</tr>
<tr>
<td>Name</td>
<td>String</td>
<td>Name of a specific instructor, i.e. "Peter W. Cook".</td>
</tr>
<tr>
<td>Email</td>
<td>String</td>
<td>Email address of the instructor.</td>
</tr>
<tr>
<td>Meetings</td>
<td>Array<Meeting></td>
<td>List of Meeting entities this instructor teaches.</td>
</tr>
| Property | Type | Description |
|---|
##Campus
<tr>
<td>CampusId</td>
<td>Guid</td>
<td>A unique identifier for a specific campus.</td>
</tr>
<tr>
<td>Code</td>
<td>String</td>
<td>Abbreviation for a specific campus, i.e. "PWL".</td>
</tr>
<tr>
<td>Name</td>
<td>String</td>
<td>Name of the campus.</td>
</tr>
<tr>
<td>ZipCode</td>
<td>String</td>
<td>Zip code of the campus.</td>
</tr>
<tr>
<td>Buildings</td>
<td>Array<Building></td>
<td>A list of Building entities that are on this campus.</td>
</tr>
| Property | Type | Description |
|---|
##Building
<tr>
<td>BuildingId</td>
<td>Guid</td>
<td>A unique identifier for a specific building.</td>
</tr>
<tr>
<td>Name</td>
<td>String</td>
<td>Official name of the building, i.e. "Class of 1950 Lecture Hall".</td>
</tr>
<tr>
<td>ShortCode</td>
<td>String</td>
<td>Abbreviation of the building, i.e. "CL50".</td>
</tr>
<tr>
<td>Campus</td>
<td>Campus</td>
<td>Campus entity that this Building belongs to.</td>
</tr>
<tr>
<td>Rooms</td>
<td>Array<Room></td>
<td>A list of Room entities that are in this building.</td>
</tr>
| Property | Type | Description |
|---|
##Room
<tr>
<td>RoomId</td>
<td>Guid</td>
<td>A unique identifier for a specific room.</td>
</tr>
<tr>
<td>Number</td>
<td>String</td>
<td>Room number, i.e. "B150".</td>
</tr>
<tr>
<td>Building</td>
<td>Building</td>
<td>Building entity that this Room belongs to.</td>
</tr>
<tr>
<td>Meetings</td>
<td>Array<Meeting></td>
<td>A list of Meeting entities that take place in this room.</td>
</tr>
| Property | Type | Description |
|---|