AcademicCurriculumProgramClassesMap

This service returns a program's 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/programclassesmap

Version: v1

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

Summary

Path Operation Description
/classes/{program_code}/{year_term} GET

Get all courses under a program

/classes/{program_id} GET

Get all courses under a program

Paths

Get all courses under a program

GET /classes/{program_code}/{year_term}

Get all courses under a program. EXAMPLE endpoint: /classes/735401/20175

program_code

Program Code

path string
year_term

Year Term

path string

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

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/classes/31875",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"class_count": 79,
"class_list": [
{
"course_name": "PSYCH 101",
"course_title": "Orientation to Psych Major",
"curriculum_id": "10389",
"effective_date": "20020903",
"expired_date": "29991231",
"honors_approved": "N",
"title_code": "000"
}
]
}
}
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.

Get all courses under a program

GET /classes/{program_id}

Get all courses under a program

program_id

Specified Program ID

path string

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

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/classes/31875",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"class_count": 79,
"class_list": [
{
"course_name": "PSYCH 101",
"course_title": "Orientation to Psych Major",
"curriculum_id": "10389",
"effective_date": "20020903",
"expired_date": "29991231",
"honors_approved": "N",
"title_code": "000"
}
]
}
}
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

class_item: object

curriculum_id: string
title_code: string
effective_date: string
expired_date: string
course_name: string
course_title: string
honors_approved: string

ProgramClassesMapService: object

request: request
response: response

request: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

response: object

class_count: integer
class_list: object[]
Service Path: 
/domains/legacy/academic/curriculum/programclassesmap
Domain or University API: 
/domains/D/academic/curriculum/programclassesmap

Community

 

Don't see your question listed here? Ask!