AcademicClassScheduleInstructorScheduleClassRoll
ClassRollService
More information: https://it.byu.edu
Contact Info: api@byu.edu
Version: v1
BasePath:/domains/legacy/academic/classschedule/instructorschedule/classRoll
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]
Table of Contents
ClassRollService
get /{teaching_area_curriculum_id}/{catalog_number_title_code}/{section_number}get /{teaching_area_curriculum_id}/{catalog_number_title_code}/{section_number}/{year_term}
Default
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 (getClassRollCurrentYearTermByTeachingAreaCatalogNumberORCurriculumIDTitleCode)
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
Path parameters
teaching_area_curriculum_id (required)
Path Parameter x2014; string ->
catalog_number_title_code (required)
Path Parameter x2014; string ->
section_number (required)
Path Parameter x2014; string ->
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. StringReturns 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 (getClassRollForCurrentYearTerm)
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
Path parameters
teaching_area_curriculum_id (required)
Path Parameter x2014; string ->
catalog_number_title_code (required)
Path Parameter x2014; string ->
section_number (required)
Path Parameter x2014; string ->
year_term (required)
Path Parameter x2014; yearTerm -> [1-2][0-9]{3}[1345]
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Service request is OK and a response has been generated. String400
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. String403
The user does not have access to the resource. String404
The target resource can not be found for the provided resource identifiers. String405
The service method is not supported by the service. String409
A conflict has occurred. The response structure may contain information about the conflict. String500
An error occurred generating the response to the service request. This is strictly a server error and not an application error. StringDefault
service definition (getServiceDocumentation)
service definition
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success StringModels
[ Jump to Methods ]
Table of Contents
Service Path:
/domains/legacy/academic/classschedule/instructorschedule/classRoll
Domain or University API:
D
