AcademicAdvisementAcademicProgramsWS

This service accesses resources in the Academic Programs portion of the AIM System.

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

Base URL: /domains/legacy/academic/advisement/academicprogramsws

Version: v1

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

Summary

Path Operation Description
/{program_id_or_program_code} GET

GET

Paths

GET

GET /{program_id_or_program_code}

Shows everything belonging to the Academic Program

program_id_or_program_code

5 digit number Program ID, or 6 digit number Program Code

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
{
"AcademicProgramsWSService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/31875",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"degree": "MIN",
"degree_level": "2",
"effective_date": "04 Sep 2007",
"effective_year_term": "20075",
"expired_date": "31 Dec 2999",
"expired_year_term": "29995",
"major_program_id": "",
"program_code": "735401",
"program_diploma_name": "",
"program_id": "31875",
"program_name": "Psychology",
"program_type": "Minor",
"unit_list": [
{
"unit_id": "1018",
"unit_name": "Family, Home, and Social Sciences, College of",
"unit_type": "College"
},
{
"unit_id": "1379",
"unit_name": "Psychology, Department of",
"unit_type": "Department"
}
]
}
}
}
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

Bad request - unable to interpret body of the message.

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

AcademicProgramsWSService: object

AcademicProgramsWSService: object
request: request
response: response

request: object

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

response: object

program_id: string , must match ^[0-9]{5}$
program_code: string , must match ^[0-9]{6}$
program_type: string
program_name: string
program_diploma_name: string
degree: string
degree_level: string
effective_date: string
expired_date: string
effective_year_term: string
expired_year_term: string
major_program_id: string
unit_list: object[]

unit_item: object

unit_id: string
unit_name: string
unit_type: string
Service Path: 
/domains/legacy/academic/advisement/academicprogramsws
Domain or University API: 
/domains/D/academic/advisement/academicprogramsws

Community

 

Don't see your question listed here? Ask!