AcademicCurriculumAcademicUnitXReference

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/academicunitxreference

Version: v1

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

Summary

Path Operation Description
/* GET

Searches for an academic unit by name or by number. Will provide 100 records, for next 100 records search the last given record

/documentation GET

service definition

Paths

Searches for an academic unit by name or by number. Will provide 100 records, for next 100 records search the last given record

GET /*

Tags: AcademicUnitXReferenceService

Searches for an academic unit by name or by number. Will provide 100 records, for next 100 records search the last given record

search

Name or number of academic unit

query 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": "search=Family",
"method": "GET",
"resource": "/json",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"academic_units": [
{
"acad_unit_id": "1010",
"effective_date": "1900-01-01",
"expired_date": "1981-09-07",
"unit_name": "Family Living",
"unit_type": "COLLEGE"
}
]
}
}
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.

service definition

GET /documentation

service definition

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

200 OK

Success

Schema definitions

academic_units: object

acad_unit_id: string
unit_name: string
unit_type: string
effective_date: string

yyyy-mm-dd

expired_date: string

yyyy-mm-dd

AcademicUnitXrefService: object

request: request
response: response

error_data: object

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

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

request: object

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

response: object

academic_units: object[]
Service Path: 
/domains/legacy/academic/curriculum/academicunitxreference
Domain or University API: 
/domains/D/academic/curriculum/academicunitxreference

Community

 

Don't see your question listed here? Ask!