AcademicClassScheduleInstructorScheduleClassRoll

AcademicClassScheduleInstructorScheduleClassRoll

ClassRollService

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

Base URL: /domains/legacy/academic/classschedule/instructorschedule/classRoll

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition
/{curriculum_id}/{title_code}/{section_number} GET

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR curriculum id and title code
/{curriculum_id}/{title_code}/{section_number}/{year_term} GET

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR curriculum id and title code

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR curriculum id and title code

GET /{curriculum_id}/{title_code}/{section_number}

Tags: ClassRollService

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR curriculum id and title code
curriculum_id

string ->

path string
title_code

string ->

path string
section_number

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

ClassRollService
Example for application/json
{
    "request": {
        "attributes": "",
        "method": "GET",
        "resource": "/json/01489/002/001/",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "catalog_number": "142",
        "catalog_suffix": "",
        "course_title": "Intro to Computer Programming",
        "credit_hours": "3.00",
        "curriculum_id": "01489",
        "dept_name": "C S",
        "end_date": "18 Apr 2018",
        "events": [
            {
                "capacity": "203",
                "days": "MWF",
                "location": "1170 TMCB",
                "time": "9:00 - 9:50"
            }
        ],
        "grade_rule": "Inclusive Grade Rule: A B C D E I P T",
        "honors_flag": "No",
        "instructors": [
            "Teacher, Professor"
        ],
        "lab_quiz": "No",
        "req_size": "203",
        "section_number": "001",
        "sectiontype": "Day",
        "serv_learn": "No",
        "start_date": "08 Jan 2018",
        "students": [
            {
                "address_line1": "",
                "address_line2": "",
                "byu_id": "123456789",
                "class_standing": "Freshman",
                "email": "",
                "emphasis": "Open-Major",
                "hours": "3.00",
                "index": "1",
                "net_id": "",
                "person_id": "123456789",
                "phone": "",
                "preferred_name": "Student",
                "sort_name": "Student"
            }
        ],
        "title_code": "002",
        "total_enrolled": "1",
        "yeartermstring": "Winter 2018"
    }
}
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.

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.

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR curriculum id and title code

GET /{curriculum_id}/{title_code}/{section_number}/{year_term}

Tags: ClassRollService

Returns the class roll for the the current year term for the class identified by the teaching area and catalog number OR the curriculum id and title code
curriculum_id

string ->

path string
title_code

string ->

path string
section_number

string ->

path string
year_term

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

 path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

ClassRollService
Example for application/json
{
    "request": {
        "attributes": "",
        "method": "GET",
        "resource": "/json/01489/002/001/",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "catalog_number": "142",
        "catalog_suffix": "",
        "course_title": "Intro to Computer Programming",
        "credit_hours": "3.00",
        "curriculum_id": "01489",
        "dept_name": "C S",
        "end_date": "18 Apr 2018",
        "events": [
            {
                "capacity": "203",
                "days": "MWF",
                "location": "1170 TMCB",
                "time": "9:00 - 9:50"
            }
        ],
        "grade_rule": "Inclusive Grade Rule: A B C D E I P T",
        "honors_flag": "No",
        "instructors": [
            "Teacher, Professor"
        ],
        "lab_quiz": "No",
        "req_size": "203",
        "section_number": "001",
        "sectiontype": "Day",
        "serv_learn": "No",
        "start_date": "08 Jan 2018",
        "students": [
            {
                "address_line1": "",
                "address_line2": "",
                "byu_id": "123456789",
                "class_standing": "Freshman",
                "email": "",
                "emphasis": "Open-Major",
                "hours": "3.00",
                "index": "1",
                "net_id": "",
                "person_id": "123456789",
                "phone": "",
                "preferred_name": "Student",
                "sort_name": "Student"
            }
        ],
        "title_code": "002",
        "total_enrolled": "1",
        "yeartermstring": "Winter 2018"
    }
}
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.

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

address_line1: string

address_line2: string

attributes: string

byu_id: string

capacity: string

catalog_number: string

catalog_suffix: string

class_standing: string

ClassRollService: object

request: request
response: response

course_title: string

credit_hours: string

curriculum_id: string

days: string

dept_name: string

email: string

emphasis: string

end_date: string

events: object[]

object
days: days
time: time
location: location
capacity: capacity

grade_rule: string

honors_flags: string

hours: string

index: string

instructors: string[]

string

lab_quiz: string

location: string

method: string

net_id: string

person_id: string

phone: string

preferred_name: string

req_size: string

request: object

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

resource: string

response: object

course_title: course_title
dept_name: dept_name
catalog_number: catalog_number
catalog_suffix: catalog_suffix
section_number: section_number
curriculum_id: curriculum_id
title_code: title_code
credit_hours: credit_hours
total_enrolled: total_enrolled
req_size: req_size
sectiontype: sectiontype
grade_rule: grade_rule
honors_flag: honors_flags
lab_quiz: lab_quiz
serv_learn: serv_learn
yeartermstring: yeartermstring
start_date: start_date
end_date: end_date
events: events
instructors: instructors
students: students

section_number: string

sectiontype: string

serv_learn: string

sort_name: string

start_date: string

status: number

statusMessage: string

students: object[]

object
index: index
person_id: person_id
sort_name: sort_name
preferred_name: preferred_name
byu_id: byu_id
net_id: net_id
class_standing: class_standing
hours: hours
emphasis: emphasis
email: email
phone: phone
address_line1: address_line1
address_line2: address_line2

time: string

title_code: string

total_enrolled: string

yeartermstring: string

Service Path: 
/domains/legacy/academic/classschedule/instructorschedule/classRoll
Domain or University API: 
/domains/D/academic/classschedule/instructorschedule/classRoll
Tags: 
domains
legacy
Academic
classschedule
instructorSchedule
classRoll

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access