regis

<back to all web services

SectionsTimetableRequest

Requires Authentication
Required permission:ReadSections
The following routes are available for this service:
POST/Sections/Timetable/{reporting_term}
SectionsTimetableRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termpathstringNo
SectionsTimetableResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TermformstringNo
NotesformList<SectionTimetableNoteResponse>No
MondayformList<SectionTimetableResponse>No
TuesdayformList<SectionTimetableResponse>No
WednesdayformList<SectionTimetableResponse>No
ThursdayformList<SectionTimetableResponse>No
FridayformList<SectionTimetableResponse>No
SaturdayformList<SectionTimetableResponse>No
SundayformList<SectionTimetableResponse>No
SectionTimetableNoteResponse Parameters:
NameParameterData TypeRequiredDescription
HeadingformstringNo
BodyformstringNo
SectionTimetableResponse Parameters:
NameParameterData TypeRequiredDescription
TimeformstringNo
SortTimeformint?No
CourseformstringNo
CourseSlugformstringNo
DescformstringNo
InstructorsformList<SectionTimetableInstructorResponse>No
RegistrationInfoformstringNo
RoomformstringNo
CreditMinimumformdecimalNo
CreditMaximumformdecimalNo
AuditMinimumformdecimalNo
AuditMaximumformdecimalNo
SectionTimetableInstructorResponse Parameters:
NameParameterData TypeRequiredDescription
InstructorNameformstringNo
InstructorSlugformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	]
}