AcademicRegistrationClassLog

AcademicRegistrationClassLog

This service returns the registration log (adds and drops) for any section in the AIM System.

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

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

Version: v1

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

Summary

Path Operation Description
/{curriculumId_teachingArea}/{titleCode_catalogNumber}/{sectionNumber}/{yearTerm} GET

Shows the class logs identified by the Curriculum ID and Title Code

Paths

Shows the class logs identified by the Curriculum ID and Title Code

GET /{curriculumId_teachingArea}/{titleCode_catalogNumber}/{sectionNumber}/{yearTerm}

Tags: ClassLogService

Shows the class logs identified by the Curriculum ID and Title Code
curriculumId_teachingArea

string -> [0-9]{5} 5 digit int OR [A-Z]{3-5} string of 3 to 5 chars

 path string
titleCode_catalogNumber

string -> [0-9]{3} 3 digit int OR [0-9]{3} 3 digit int

 path string
sectionNumber

string -> [0-9]{3}[A-Z] 3 digit int that sometimes includes an appended char

 path string
yearTerm

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

 path string
page

Set to corresponding page. int (?page=1)

 query string

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

200 OK

Service request is OK and a response has been generated.

RegClassLogService
Example for application/json
{
    "request": {
        "attributes": "page=1",
        "method": "GET",
        "resource": "/json/01489/002/002/20121",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "adds": 345,
        "classList": [
            {
                "ACTION": "",
                "BYUID": "123456789",
                "DATE": "2011-10-24T11:03:04",
                "GRADE": "",
                "HOURS": 3,
                "NAME": "Doe, John E",
                "USER": ""
            }
        ],
        "dataList": [
            {
                "BUILDING": "TMCB",
                "DAYS": "MWF",
                "ROOM": "1170",
                "ROOMCAP": 211,
                "TIME": "10:00a - 10:50a"
            }
        ],
        "drops": 193,
        "enrolled": 129,
        "instructor": "Teacher, Professor",
        "pages": 6,
        "size": 165
    }
}
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

RegClassLogService: object

request: request
response: response

request: object

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

response: object

instructor: string
adds: number
drops: number
enrolled: number
size: number
pages: number
dataList: object[]
object
DAYS: string
TIME: string
BUILDING: string
ROOM: string
ROOMCAP: number
classList: object[]
object
BYUID: string
NAME: string
ACTION: string
GRADE: string
HOURS: number
DATE: string
USER: string
Service Path: 
/domains/legacy/academic/registration/classlog
Domain or University API: 
/domains/D/academic/registration/classlog
Tags: 
domains
legacy
Academic
registration
classlog

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access