AcademicCurriculumSubjectAreaWS

SubjectAreaWSService

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

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

Version: v1

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

Summary

Path Operation Description
/extended GET

Get an extended list of subject areas

/list GET

Get a list of subject areas

Paths

Get an extended list of subject areas

GET /extended

Tags: SubjectAreaWSService

Get an extended list of subject areas

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/extended",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"request_count": 229,
"subject_area_set": [
{
"academic_unit_id": "1018",
"date_time_updated": "20180225",
"effective_date": "19820907",
"expired_date": "29991231",
"level_2_name": "Family, Home, and Social Sciences, College of",
"level_2_type": "COLLEGE",
"level_2_unit_id": "1018",
"level_3_name": "",
"level_3_type": "",
"level_3_unit_id": "",
"level_4_name": "",
"level_4_type": "",
"level_4_unit_id": "",
"level_5_name": "",
"level_5_type": "",
"level_5_unit_id": "",
"parent_academic_unit_id": "1000",
"prev_subject_area_name": "",
"subject_area": "A HTG",
"subject_area_desc": "American Heritage",
"unit_level": "2",
"unit_name": "Family, Home, and Social Sciences, College of",
"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.

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 list of subject areas

GET /list

Tags: SubjectAreaWSService

Get a list of subject areas

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/list",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"request_count": 229,
"subject_area_set": [
{
"effective_date": "19820907",
"expired_date": "29991231",
"prev_subject_area_name": "",
"subject_area": "A HTG",
"subject_area_desc": "American Heritage"
}
]
}
}
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

request: object

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

response: object

request_count: number
subject_area_set: object[]

responseEx: object

request_count: number
subject_area_set: object[]

subject_area_set: object

subject_area: string
effective_date: string
expired_date: string

yyyymmdd

subject_area_desc: string
prev_subject_area_name: string

subject_area_set_extended: object

subject_area: string
effective_date: string
expired_date: string

yyyymmdd

subject_area_desc: string
prev_subject_area_name: string
academic_unit_id: string
unit_type: string
unit_level: string
unit_name: string
parent_academic_unit_id: string
level_2_unit_id: string
level_2_type: string
level_2_name: string
level_3_unit_id: string
level_3_type: string
level_3_name: string
level_4_unit_id: string
level_4_type: string
level_4_name: string
level_5_unit_id: string
level_5_type: string
level_5_name: string
date_time_updated: string

SubjectareawsService: object

request: request
response: response

SubjectareawsServiceEx: object

request: request
response: responseEx
Service Path: 
/domains/legacy/academic/curriculum/subjectareaws
Domain or University API: 
/domains/D/academic/curriculum/subjectareaws

Community

 

Don't see your question listed here? Ask!