AcademicAdvisementAcadProgram

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/pcode/{program_code} GET

Shows everything belonging to the Academic Program looking up by program code

/{program_id} GET

GET

PUT

(CURRENTLY NOT SUPPORTED)Updates the program page with the attributes specified

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Shows everything belonging to the Academic Program looking up by program code

GET /pcode/{program_code}

Tags: AcadProgramsService

Shows everything belonging to the Academic Program looking up by program code

program_code

6 digit number

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"AcadProgramsService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/pcode/322622/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"CIPCode": "52.0301",
"GEProgramDescription": "",
"GEProgramID": "",
"academicUnitDescription": "Accountancy&Informtn Sys",
"academicUnitID": "1039",
"advisorID": "",
"advisorName": "",
"comments": "",
"committeeMembersRequired": "0",
"coreProgramDescription": "",
"coreProgramID": "",
"degree": "BS",
"degreeLevel": "Bachelors",
"description": "Accounting",
"diplomaDescription": "Accounting",
"effectiveYearTerm": "20175",
"emphasisRequired": "No",
"exiredYearTerm": "20184",
"facultyAdvisorID": "",
"facultyAdvisorName": "",
"hierarchy": [
{
"unit_name": "Accountancy",
"unit_type": "SCHOOL:"
},
{
"unit_name": "Business",
"unit_type": "SCHOOL:"
}
]
,
"honorsRecognition": "Yes",
"limEnrProgram": "Yes",
"longDescription": "Accounting",
"majorProgramCode": "",
"majorProgramDescription": "",
"majorProgramID": "",
"mastersRequired": "No",
"maxYearsToComplete": "",
"maximumProgramHours": "64",
"minimumProgramHours": "64",
"minorRequired": "No",
"programCode": "322622",
"programID": "33812",
"programType": "MAJOR",
"studyListRequired": "No",
"teachingProgram": "No",
"validAdmission": "No"
}
}
}
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.

GET

GET /{program_id}

Shows everything belonging to the Academic Program

program_id

5 digit number

path string

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

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"AcadProgramsService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/pcode/322622/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"CIPCode": "52.0301",
"GEProgramDescription": "",
"GEProgramID": "",
"academicUnitDescription": "Accountancy&Informtn Sys",
"academicUnitID": "1039",
"advisorID": "",
"advisorName": "",
"comments": "",
"committeeMembersRequired": "0",
"coreProgramDescription": "",
"coreProgramID": "",
"degree": "BS",
"degreeLevel": "Bachelors",
"description": "Accounting",
"diplomaDescription": "Accounting",
"effectiveYearTerm": "20175",
"emphasisRequired": "No",
"exiredYearTerm": "20184",
"facultyAdvisorID": "",
"facultyAdvisorName": "",
"hierarchy": [
{
"unit_name": "Accountancy",
"unit_type": "SCHOOL:"
},
{
"unit_name": "Business",
"unit_type": "SCHOOL:"
}
]
,
"honorsRecognition": "Yes",
"limEnrProgram": "Yes",
"longDescription": "Accounting",
"majorProgramCode": "",
"majorProgramDescription": "",
"majorProgramID": "",
"mastersRequired": "No",
"maxYearsToComplete": "",
"maximumProgramHours": "64",
"minimumProgramHours": "64",
"minorRequired": "No",
"programCode": "322622",
"programID": "33812",
"programType": "MAJOR",
"studyListRequired": "No",
"teachingProgram": "No",
"validAdmission": "No"
}
}
}
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.

(CURRENTLY NOT SUPPORTED)Updates the program page with the attributes specified

PUT /{program_id}

Tags: AcadProgramsService

(CURRENTLY NOT SUPPORTED)Updates the program page with the attributes specified

program_id

5 digit number

path string
program_code

6 digit number

query string
eff_year_term

xxx

query string
exp_year_term

xxx

query string
program_type

xxx

query string
degree

xxx

query string
degree_level

xxx

query string
description

xxx

query string
long_desc

xxx

query string
diploma_desc

xxx

query string
valid_admit

xxx

query string
comments

xxx

query string
advisor_id

xxx

query string
advisor_name

xxx

query string
faculty_advisor_id

xxx

query string
faculty_advisor_name

xxx

query string
emphasis_req

xxx

query string
masters_req

xxx

query string
minor_req

xxx

query string
honors_rec

xxx

query string
teaching_program

xxx

query string
major_program_id

xxx

query string
major_program_code

xxx

query string
major_program_id_desc

xxx

query string
core_program_id

xxx

query string
core_program_id_desc

xxx

query string
ge_program_id

xxx

query string
ge_program_id_desc

xxx

query string
max_yrs_compl

xxx

query string
min_program_hrs

xxx

query string
max_program_hrs

xxx

query string
updated_by_id

xxx

query string
updated_by_name

xxx

query string

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

200 OK

Service request is OK and a response has been generated.

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

academicUnitDescription: string

academicUnitID: string

AcadProgramsServiceDef: object

AcadProgramsService: object
request: request
response: response

advisorID: string

advisorName: string

CIPCode: string

comments: string

committeeMembersRequired: string

coreProgramDescription: string

coreProgramID: string

degree: string

degreeLevel: string

description: string

diplomaDescription: string

effectiveYearTerm: string

emphasisRequired: string

exiredYearTerm: string

facultyAdvisorID: string

facultyAdvisorName: string

GEProgramDescription: string

GEProgramID: string

hierarchy: object[]

object
unit_type: unit_type
unit_name: unit_name

honorsRecognition: string

limEnrProgram: string

longDescription: string

majorProgramCode: string

majorProgramDescription: string

majorProgramID: string

mastersRequired: string

maximumProgramHours: string

maxYearsToComplete: string

minimumProgramHours: string

minorRequired: string

programCode: string

programID: string

programType: string

request: object

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

response: object

programID: programID
programCode: programCode
effectiveYearTerm: effectiveYearTerm
exiredYearTerm: exiredYearTerm
programType: programType
degree: degree
degreeLevel: degreeLevel
description: description
longDescription: longDescription
diplomaDescription: diplomaDescription
validAdmission: validAdmission
CIPCode: CIPCode
comments: comments
advisorName: advisorName
advisorID: advisorID
facultyAdvisorName: facultyAdvisorName
facultyAdvisorID: facultyAdvisorID
emphasisRequired: emphasisRequired
mastersRequired: mastersRequired
minorRequired: minorRequired
limEnrProgram: limEnrProgram
studyListRequired: studyListRequired
honorsRecognition: honorsRecognition
teachingProgram: teachingProgram
majorProgramID: majorProgramID
majorProgramCode: majorProgramCode
majorProgramDescription: majorProgramDescription
coreProgramID: coreProgramID
coreProgramDescription: coreProgramDescription
GEProgramID: GEProgramID
GEProgramDescription: GEProgramDescription
academicUnitID: academicUnitID
academicUnitDescription: academicUnitDescription
maxYearsToComplete: maxYearsToComplete
minimumProgramHours: minimumProgramHours
maximumProgramHours: maximumProgramHours
committeeMembersRequired: committeeMembersRequired
hierarchy: hierarchy

studyListRequired: string

teachingProgram: string

unit_name: string

unit_type: string

validAdmission: string

Service Path: 
/domains/legacy/academic/advisement/acadprogram
Domain or University API: 
/domains/D/academic/advisement/acadprogram

Community

 

Don't see your question listed here? Ask!