AcademicCurriculumAcademicUnitWS

AcademicUnitWSService

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

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

Version: v1

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

Summary

Path Operation Description
/all GET

Get all academic units

/all/{year_term} GET

Get all academic units with specified year term

/unit/{unit_id} GET

Get a specific unit

/unit/{unit_id}/{year_term} GET

Get a specific unit with specified year term

Paths

Get all academic units

GET /all

Tags: AcademicUnitWSService

Get all academic units

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"academic_unit_set": [
{
"academic_unit_id": "1007",
"credit_institution": "BYU PROVO",
"date_time_updated": "20170330 09:04:27",
"effective_date": "20170905",
"expired_date": "29991231",
"official_name": "Business, Marriott School of",
"old_unit_id": "1007",
"parent_academic_unit_id": "1000",
"sub_academic_unit_set": [
{
"sub_academic_unit_id": "1039",
"sub_credit_institution": "BYU PROVO",
"sub_date_time_updated": "20160718 11:02:57",
"sub_effective_date": "20050829",
"sub_expired_date": "29991231",
"sub_official_name": "Accountancy, School of",
"sub_old_unit_id": "1039",
"sub_parent_academic_unit_id": "1007",
"sub_unit_level": "3",
"sub_unit_name": "Accountancy",
"sub_unit_type": "SCHOOL",
"sub_updated_by_id": "123456789"
}
]
,
"unit_level": "2",
"unit_name": "Business",
"unit_type": "SCHOOL",
"updated_by_id": "123456789"
}
]
,
"unit_count": 3
}
}
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.

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 academic units with specified year term

GET /all/{year_term}

Tags: AcademicUnitWSService

Get all academic units with specified year term

year_term

Specified year and term by YYYYMMDD OR YYYYT

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/all/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"academic_unit_set": [
{
"academic_unit_id": "1007",
"credit_institution": "BYU PROVO",
"date_time_updated": "20170330 09:04:27",
"effective_date": "20170905",
"expired_date": "29991231",
"official_name": "Business, Marriott School of",
"old_unit_id": "1007",
"parent_academic_unit_id": "1000",
"sub_academic_unit_set": [
{
"sub_academic_unit_id": "1039",
"sub_credit_institution": "BYU PROVO",
"sub_date_time_updated": "20160718 11:02:57",
"sub_effective_date": "20050829",
"sub_expired_date": "29991231",
"sub_official_name": "Accountancy, School of",
"sub_old_unit_id": "1039",
"sub_parent_academic_unit_id": "1007",
"sub_unit_level": "3",
"sub_unit_name": "Accountancy",
"sub_unit_type": "SCHOOL",
"sub_updated_by_id": "123456789"
}
]
,
"unit_level": "2",
"unit_name": "Business",
"unit_type": "SCHOOL",
"updated_by_id": "123456789"
}
]
,
"unit_count": 3
}
}
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.

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 a specific unit

GET /unit/{unit_id}

Tags: AcademicUnitWSService

Get a specific unit

unit_id

Specified unit identification 4 digits

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/unit/1007/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"academic_unit_id": "1007",
"credit_institution": "BYU PROVO",
"date_time_updated": "20170330 09:04:27",
"effective_date": "20170905",
"expired_date": "29991231",
"official_name": "Business, Marriott School of",
"old_unit_id": "1007",
"parent_academic_unit_id": "1000",
"unit_level": "2",
"unit_name": "Business",
"unit_type": "SCHOOL",
"updated_by_id": "123456789"
}
}
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.

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 a specific unit with specified year term

GET /unit/{unit_id}/{year_term}

Tags: AcademicUnitWSService

Get a specific unit with specified year term

unit_id

Specified unit identification 4 digits

path string
year_term

Specified year and term by YYYYMMDD OR YYYYT

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/unit/1007/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"academic_unit_id": "1007",
"credit_institution": "BYU PROVO",
"date_time_updated": "20170330 09:04:27",
"effective_date": "20170905",
"expired_date": "29991231",
"official_name": "Business, Marriott School of",
"old_unit_id": "1007",
"parent_academic_unit_id": "1000",
"unit_level": "2",
"unit_name": "Business",
"unit_type": "SCHOOL",
"updated_by_id": "123456789"
}
}
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.

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

academic_unit_id: string

academic_unit_set: object[]

object
credit_institution: credit_institution
academic_unit_id: academic_unit_id
effective_date: effective_date
expired_date: expired_date
unit_type: unit_type
unit_level: unit_level
unit_name: unit_name
official_name: official_name
parent_academic_unit_id: parent_academic_unit_id
old_unit_id: old_unit_id
date_time_updated: date_time_updated
updated_by_id: updated_by_id
sub_academic_unit_set: sub_academic_unit_set

AcademicunitwsServiceAll: object

request: request
response: response

AcademicunitwsServiceUnit: object

request: request
response: unitResponse

credit_institution: string

date_time_updated: string

effective_date: string

expired_date: string

official_name: string

old_unit_id: string

parent_academic_unit_id: string

request: object

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

response: object

unit_count: unit_count
academic_unit_set: academic_unit_set

sub_academic_unit_id: string

sub_academic_unit_set: object[]

object
sub_credit_institution: sub_credit_institution
sub_academic_unit_id: sub_academic_unit_id
sub_effective_date: sub_effective_date
sub_expired_date: sub_expired_date
sub_unit_type: sub_unit_type
sub_unit_level: sub_unit_level
sub_unit_name: sub_unit_name
sub_official_name: sub_official_name
sub_parent_academic_unit_id: sub_parent_academic_unit_id
sub_old_unit_id: sub_old_unit_id
sub_date_time_updated: sub_date_time_updated
sub_updated_by_id: sub_updated_by_id

sub_credit_institution: string

sub_date_time_updated: string

sub_effective_date: string

sub_expired_date: string

sub_official_name: string

sub_old_unit_id: string

sub_parent_academic_unit_id: string

sub_unit_level: string

sub_unit_name: string

sub_unit_type: string

sub_updated_by_id: string

unit_count: number

unit_level: string

unit_name: string

unit_type: string

unitResponse: object

credit_institution: credit_institution
academic_unit_id: academic_unit_id
effective_date: effective_date
expired_date: expired_date
unit_type: unit_type
unit_level: unit_level
unit_name: unit_name
official_name: official_name
parent_academic_unit_id: parent_academic_unit_id
old_unit_id: old_unit_id
date_time_updated: date_time_updated
updated_by_id: updated_by_id

updated_by_id: string

Service Path: 
/domains/legacy/academic/curriculum/academicunitws
Domain or University API: 
/domains/D/academic/curriculum/academicunitws

Community

 

Don't see your question listed here? Ask!