AcademicRegistrationRegistrationService

This service accesses the classes for which the student has registered for a given term. The operations of this service correspond to the class schedule capabilities of the REG11 web page in the AIM System

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personid_netid}/{yearterm} GET

Returns registration information for selected person ID or net ID and year/term

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Returns registration information for selected person ID or net ID and year/term

GET /{personid_netid}/{yearterm}

Tags: RegistrationService

Returns registration information for selected person ID or net ID and year/term

personid_netid

string ->

path string
yearterm

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": "/joestud/20181",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Address1": "Address",
"Address2": "",
"Address3": "",
"Address4": "",
"Address_Type": "Mailing Address",
"Class_List": [
{
"building": "JSB",
"class_hours": "2:00p - 3:15p",
"credit_hours": "3.0",
"days_taught": "MW",
"dept_name": "A HTG 100",
"end": "",
"grade": "",
"instructor": "Professor, Teacher",
"lab_quiz_section": "",
"room": "140",
"section_number": "001",
"section_type": "",
"start": "",
"transcript_title": "American Heritage"
}
]
,
"Discontinuance_Date": "",
"Grad_Full_Time": "None",
"Holds": [
{
"name": "None",
"value": ""
}
]
,
"Number_of_Classes": "4",
"Phone": "000-000-0000U",
"Programs": [
{
"degree": "PRE",
"description": "Pre-Management Core",
"major": "Major"
}
]
,
"Reg_Eligibility": "DC - Day Continuing",
"Reg_Status": "9 - Continuing Student",
"Total_Credit_Hours": "12.0"
}
}
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

Address1: string

Address2: string

Address3: string

Address4: string

Address_Type: string

attributes: string

building: string

class_hours: string

Class_List: object[]

object
dept_name: dept_name
section_number: section_number
section_type: section_type
lab_quiz_section: lab_quiz_section
credit_hours: credit_hours
grade: grade
class_hours: class_hours
days_taught: days_taught
room: room
building: building
transcript_title: transcript_title
instructor: instructor
start: start
end: end

credit_hours: string

days_taught: string

degree: string

dept_name: string

description: string

Discontinuance_Date: string

end: string

Grad_Full_Time: string

grade: string

Holds: object[]

object
name: name
value: value

instructor: string

lab_quiz_section: string

major: string

method: string

name: string

Number_of_Classes: string

Phone: string

Programs: object[]

object
major: major
description: description
degree: degree

Reg_Eligibility: string

Reg_Status: string

RegServiceService: object

request: request
response: response

request: object

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

resource: string

response: object

Programs: Programs
Holds: Holds
Class_List: Class_List
Reg_Status: Reg_Status
Reg_Eligibility: Reg_Eligibility
Discontinuance_Date: Discontinuance_Date
Grad_Full_Time: Grad_Full_Time
Address_Type: Address_Type
Phone: Phone
Address1: Address1
Address2: Address2
Address3: Address3
Address4: Address4
Total_Credit_Hours: Total_Credit_Hours
Number_of_Classes: Number_of_Classes

room: string

section_number: string

section_type: string

start: string

status: integer

statusMessage: string

Total_Credit_Hours: string

transcript_title: string

value: string

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

Community

 

Don't see your question listed here? Ask!