AcademicCurriculumCourseListing

AcademicCurriculumCourseListing

This service returns a course listing from the university catalog in the AIM System.

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

Base URL: /domains/legacy/academic/curriculum/courselisting

Version: v1

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

Summary

Path Operation Description
/?* GET

Get all/active courses based on various identifiers. Available sections are included if do_sec_xref='Y'

Paths

Get all/active courses based on various identifiers. Available sections are included if do_sec_xref='Y'

GET /?*

Tags: CourseListingService

Get all/active courses based on various identifiers. See the x-tra_description to see which queries can be combined to show data. Page is the only constant query but will not give data by it's self.
teachingArea

Specified teaching area

 query string
activeOrAll

'active' or 'all'

 query string , x ∈ { active , all }
page

int > 0

 query string
containsOrBeginsWith query string , x ∈ { contains , beginswith }
transcriptTitle query string
curriculumId

Curriculum identifier

 query string
sectionNumber

Individual catalog number

 query string
catalogNumber

Individual catalog number

 query string
yearTerm

YYYYT

 query string
titleCode

Title code

 query string
do_sec_xref

Y|N

 query string

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

200 OK

Service request is OK and a response has been generated.

CourseXrefService
Example for application/json
{
    "request": {
        "attributes": "teachingArea=MUSIC&catalogNumber=160&page=3",
        "method": "GET",
        "resource": "/json",
        "status": 200,
        "statusMessage": "Service request is OK and a response has been generated."
    },
    "response": {
        "available_sections": [
        ],
        "classes": [
            {
                "catalogNumber": "160",
                "curriculumId": "03981",
                "departmentName": "MUSIC",
                "effectiveFrom": "02 Sep 1980",
                "effectiveTo": "03 Sep 1990",
                "honors": "N",
                "suffix": "R",
                "titleCode": "018",
                "transcriptTitle": "Percussion Prf Ins"
            }
        ]
    }
}
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.

ErrorResponse
401 Unauthorized

Failure to authenticate

ErrorResponse
403 Forbidden

The user does not have access to the resource.

ErrorResponse
404 Not Found

The target resource can not be found for the provided resource identifiers.

ErrorResponse
405 Method Not Allowed

The service method is not supported by the service.

ErrorResponse
409 Conflict

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

ErrorResponse
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.

ErrorResponse

Schema definitions

catalogNumber: string

classes: object

departmentName: departmentName
catalogNumber: catalogNumber
suffix: suffix
honors: honors
transcriptTitle: transcriptTitle
curriculumId: curriculumId
titleCode: titleCode
effectiveFrom: effectiveFrom
effectiveTo: effectiveTo

CourseXrefService: object

request: request
response: response

curriculumId: string

departmentName: string

effectiveFrom: string

dd Mon yyyy

effectiveTo: string

dd Mon yyyy

error_data: object

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

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

error_data

honors: string

request: object

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

response: object

classes: object[]
classes
available_sections: object[]
object

suffix: string

titleCode: string

transcriptTitle: string

Service Path: 
/domains/legacy/academic/curriculum/courselisting
Domain or University API: 
/domains/D/academic/curriculum/courselisting
Tags: 
domains
legacy
Academic
curriculum
courselisting

Community

 

Don't see your question listed here? Ask!

View This API in the API Store

Get Elevated Access