AcademicRegistrationStudentSchedule

This service accesses the student schedule only in the AIM System.

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

Base URL: /domains/legacy/academic/registration/studentschedule

Version: v1

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

Summary

Path Operation Description
/ GET

Get the weekly schedule for the authenticated user for the current year term.

/documentation GET

service definition

/{person_id_year_term} GET

Get the weekly schedule for the specified person for the current year term OR the year term specified

/{person_id}/{year_term} GET

Get the weekly schedule for the specified person and for the year term specified

Paths

Get the weekly schedule for the authenticated user for the current year term.

GET /

Tags: WeeklySchedService

Get the weekly schedule for the authenticated user for the current year term.

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

200 OK

Service request is OK and a response has been generated.

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.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

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.

service definition

GET /documentation

service definition

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

200 OK

Success

Get the weekly schedule for the specified person for the current year term OR the year term specified

GET /{person_id_year_term}

Tags: WeeklySchedService

Get the weekly schedule for the specified person for the current year term OR the year term specified

person_id_year_term

string ->

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789/20181",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"display_year_term": "Winter Semester 2018",
"email_address": "joeschmo@-----.com",
"end_year_term": "18 Apr 2018",
"enrolled": "",
"schedule_table": [
{
"block": "",
"building": "JSB",
"class_period": "2:00p - 3:15p",
"course": "FIN 201",
"course_title": "Principles of Finance",
"credit_hours": "3.0",
"curriculum_id": "00796",
"days": "TTh",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "140",
"section": "002",
"section_type": "",
"sequence": "parent",
"title_code": "009"
},
{
"block": "",
"building": "JKB",
"class_period": "5:00p - 5:50p",
"course": "FREN 346R",
"course_title": "French Choir",
"credit_hours": "1.0",
"curriculum_id": "11541",
"days": "Th",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "2105",
"section": "001",
"section_type": "EVENING",
"sequence": "parent",
"title_code": "000"
},
{
"block": "",
"building": "TNRB",
"class_period": "9:30a - 10:45a",
"course": "IS 303",
"course_title": "Intro Computer Programming",
"credit_hours": "3.0",
"curriculum_id": "10418",
"days": "MW",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "260",
"section": "001",
"section_type": "",
"sequence": "parent",
"title_code": "002"
},
{
"block": "",
"building": "JSB",
"class_period": "1:00p - 1:50p",
"course": "REL A 304",
"course_title": "Writings of Isaiah",
"credit_hours": "2.0",
"curriculum_id": "06800",
"days": "TTh",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "106",
"section": "002",
"section_type": "",
"sequence": "parent",
"title_code": "000"
},
{
"block": "",
"building": "BNSN",
"class_period": "7:00p - 9:30p",
"course": "STDEV 150",
"course_title": "Public Speaking",
"credit_hours": "3.0",
"curriculum_id": "01345",
"days": "T",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "W006",
"section": "006",
"section_type": "EVENING",
"sequence": "parent",
"title_code": "009"
}
]
,
"sort_name": "Student, Joe",
"start_year_term": "08 Jan 2018",
"year_term": "20181"
}
}
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.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

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.

Get the weekly schedule for the specified person and for the year term specified

GET /{person_id}/{year_term}

Tags: WeeklySchedService

Get the weekly schedule for the specified person and for the year term specified

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 applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789/20181",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"display_year_term": "Winter Semester 2018",
"email_address": "joeschmo@-----.com",
"end_year_term": "18 Apr 2018",
"enrolled": "",
"schedule_table": [
{
"block": "",
"building": "JSB",
"class_period": "2:00p - 3:15p",
"course": "FIN 201",
"course_title": "Principles of Finance",
"credit_hours": "3.0",
"curriculum_id": "00796",
"days": "TTh",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "140",
"section": "002",
"section_type": "",
"sequence": "parent",
"title_code": "009"
},
{
"block": "",
"building": "JKB",
"class_period": "5:00p - 5:50p",
"course": "FREN 346R",
"course_title": "French Choir",
"credit_hours": "1.0",
"curriculum_id": "11541",
"days": "Th",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "2105",
"section": "001",
"section_type": "EVENING",
"sequence": "parent",
"title_code": "000"
},
{
"block": "",
"building": "TNRB",
"class_period": "9:30a - 10:45a",
"course": "IS 303",
"course_title": "Intro Computer Programming",
"credit_hours": "3.0",
"curriculum_id": "10418",
"days": "MW",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "260",
"section": "001",
"section_type": "",
"sequence": "parent",
"title_code": "002"
},
{
"block": "",
"building": "JSB",
"class_period": "1:00p - 1:50p",
"course": "REL A 304",
"course_title": "Writings of Isaiah",
"credit_hours": "2.0",
"curriculum_id": "06800",
"days": "TTh",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "106",
"section": "002",
"section_type": "",
"sequence": "parent",
"title_code": "000"
},
{
"block": "",
"building": "BNSN",
"class_period": "7:00p - 9:30p",
"course": "STDEV 150",
"course_title": "Public Speaking",
"credit_hours": "3.0",
"curriculum_id": "01345",
"days": "T",
"instructor": "FakeLastName, FakeFirstName",
"lab_quiz_section": "",
"room": "W006",
"section": "006",
"section_type": "EVENING",
"sequence": "parent",
"title_code": "009"
}
]
,
"sort_name": "Student, Joe",
"start_year_term": "08 Jan 2018",
"year_term": "20181"
}
}
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.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

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

attributes: string

block: string

building: string

class_period: string

course: string

course_title: string

credit_hours: string

curriculum_id: string

days: string

display_year_term: string

email_address: string

end_year_term: string

dd Mon yyyy

enrolled: string

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

instructor: string

lab_quiz_section: string

method: string

request: object

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

response: object

sort_name: sort_name
email_address: email_address
year_term: year_term
display_year_term: display_year_term
start_year_term: start_year_term
end_year_term: end_year_term
enrolled: enrolled
schedule_table: schedule_table

room: string

schedule_table: object[]

schedule_table_data: object

sequence: sequence
course: course
section: section
section_type: section_type
block: block
curriculum_id: curriculum_id
title_code: title_code
lab_quiz_section: lab_quiz_section
credit_hours: credit_hours
class_period: class_period
days: days
room: room
building: building
course_title: course_title
instructor: instructor

section: string

section_type: string

sequence: string

sort_name: string

start_year_term: string

dd Mon yyyy

status: number

statusMessage: string

title_code: string

WeeklySchedService: object

request: request
response: response

year_term: string

YYYYT

Service Path: 
/domains/legacy/academic/registration/studentschedule
Domain or University API: 
/domains/D/academic/registration/studentschedule

Community

 

Don't see your question listed here? Ask!