AcademicClassScheduleInstructorSchedule

This service accesses instructor resources in the AIM System including the Instructor Schedule, the Instructor Exam Schedule, and Class Rolls.

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id}/{year_term} GET

Returns an instructors exam schedule for a given year term using the person id given.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Returns an instructors exam schedule for a given year term using the person id given.

GET /{person_id}/{year_term}

Tags: InstructorScheduleService

Returns an instructors exam schedule for a given year term using the person id given.

person_id

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/{person_id}/20181/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"classes": [
{
"bldg": "",
"catalog_number": "101",
"catalog_suffix": "",
"class_period": "",
"credit_hours": "1.0",
"curriculum_id": "12245",
"date_begins": "",
"date_ends": "",
"days": "",
"enrolled": "0",
"honors": "",
"lab_quiz": "",
"rain_checks": "",
"room": "",
"room_capacity": "",
"section": "001",
"section_type": "St Abroad",
"service": "",
"size": "3",
"submission_type": "AIM",
"teaching_area": "TEST",
"title": "Test Class-contact Registrar",
"title_code": "000",
"waitlist": ""
}
]
,
"credits_scheduled": "1.0",
"email": "email@example.com",
"instructor": "Person, Name",
"number_of_classes": "1",
"office": "",
"phone": "",
"year_term_date_range": "(Winter Semester 2018: 08 Jan 18 - 18 Apr 18)"
}
}
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.

401 Unauthorized

Failure to authenticate.

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.

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

bldg: string

catalog_number: string

catalog_suffix: string

class_period: string

classes: object[]

object
curriculum_id: curriculum_id
title_code: title_code
teaching_area: teaching_area
catalog_number: catalog_number
catalog_suffix: catalog_suffix
section: section
lab_quiz: lab_quiz
honors: honors
service: service
credit_hours: credit_hours
section_type: section_type
class_period: class_period
days: days
room: room
bldg: bldg
date_begins: date_begins
date_ends: date_ends
title: title
size: size
enrolled: enrolled
room_capacity: room_capacity
rain_checks: rain_checks
waitlist: waitlist
submission_type: submission_type

credit_hours: string

credits_scheduled: string

curriculum_id: string

date_begins: string

date_ends: string

days: string

email: string

enrolled: string

honors: string

instructor: string

InstructorScheduleService: object

request: request
response: response

lab_quiz: string

number_of_classes: string

office: string

phone: string

rain_checks: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

response: object

instructor: instructor
year_term_date_range: year_term_date_range
number_of_classes: number_of_classes
credits_scheduled: credits_scheduled
office: office
phone: phone
email: email
classes: classes

room: string

room_capacity: string

section: string

section_type: string

service: string

size: string

submission_type: string

teaching_area: string

title: string

title_code: string

waitlist: string

year_term_date_range: string

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

Community

 

Don't see your question listed here? Ask!