Required permission: | ReadSections |
POST | /Sections/Timetable/{reporting_term} |
---|
"use strict";
export class SectionTimetableNoteResponse {
/** @param {{heading?:string,body?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
heading;
/** @type {string} */
body;
}
export class SectionTimetableInstructorResponse {
/** @param {{instructorName?:string,instructorSlug?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
instructorName;
/** @type {string} */
instructorSlug;
}
export class SectionTimetableResponse {
/** @param {{time?:string,sortTime?:number,course?:string,courseSlug?:string,desc?:string,instructors?:SectionTimetableInstructorResponse[],registrationInfo?:string,room?:string,creditMinimum?:number,creditMaximum?:number,auditMinimum?:number,auditMaximum?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
time;
/** @type {?number} */
sortTime;
/** @type {string} */
course;
/** @type {string} */
courseSlug;
/** @type {string} */
desc;
/** @type {SectionTimetableInstructorResponse[]} */
instructors;
/** @type {string} */
registrationInfo;
/** @type {string} */
room;
/** @type {number} */
creditMinimum;
/** @type {number} */
creditMaximum;
/** @type {number} */
auditMinimum;
/** @type {number} */
auditMaximum;
}
export class SectionsTimetableResponse {
/** @param {{responseStatus?:ResponseStatus,term?:string,notes?:SectionTimetableNoteResponse[],monday?:SectionTimetableResponse[],tuesday?:SectionTimetableResponse[],wednesday?:SectionTimetableResponse[],thursday?:SectionTimetableResponse[],friday?:SectionTimetableResponse[],saturday?:SectionTimetableResponse[],sunday?:SectionTimetableResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
term;
/** @type {SectionTimetableNoteResponse[]} */
notes;
/** @type {SectionTimetableResponse[]} */
monday;
/** @type {SectionTimetableResponse[]} */
tuesday;
/** @type {SectionTimetableResponse[]} */
wednesday;
/** @type {SectionTimetableResponse[]} */
thursday;
/** @type {SectionTimetableResponse[]} */
friday;
/** @type {SectionTimetableResponse[]} */
saturday;
/** @type {SectionTimetableResponse[]} */
sunday;
}
export class SectionsTimetableRequest {
/** @param {{reporting_term?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
reporting_term;
}
JavaScript SectionsTimetableRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Sections/Timetable/{reporting_term} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
reporting_term: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, term: String, notes: [ { heading: String, body: String } ], monday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], tuesday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], wednesday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], thursday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], friday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], saturday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ], sunday: [ { time: String, sortTime: 0, course: String, courseSlug: String, desc: String, instructors: [ { instructorName: String, instructorSlug: String } ], registrationInfo: String, room: String, creditMinimum: 0, creditMaximum: 0, auditMinimum: 0, auditMaximum: 0 } ] }