AcademicAdvisementStudentPrograms
This service accesses a log of a graduate student's study plan in the AIM System.
Base URL: /domains/legacy/academic/advisement/studentprograms
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{person_id_net_id} | GET | Returns information for selected person ID or net ID about students major |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{person_id_net_id}
Tags: StudentProgramsServiceReturns information for selected person ID or net ID about students major
person_id_net_id | string -> 9 digit number. [0-9]{9} | 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{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Credits": [
{
"description": "BYU",
"earned": "128.00",
"gpa": "2.65",
"graded": "126.50",
"points": "334.80"
},
{
"description": "Total",
"earned": "128.00",
"gpa": "2.65",
"graded": "126.50",
"points": "334.80"
}
],
"GPAas": [
],
"Hiers": [
],
"Major_List": [
],
"PKP": "Phi Kappa Phi: No",
"Programs": [
{
"accepted_by_name": "",
"accepted_date": "2011-02-23",
"add_data": "",
"advisor_name": "",
"change_data": "",
"committee_mem_req": "0",
"date_plan_approved": "",
"deadline_year_term": "",
"degree": "PRE",
"dis_prog_status": "Active",
"eff_year_term": "20115",
"effective_year_term": "20115",
"expected_grad_year_term": "",
"expired_date": "",
"faculty_advisor_name": "",
"hier": "COLLEGE: Undergraduate Education",
"major_program_id_desc": "",
"plan_approved_by_name": "",
"primary_program": "N",
"program_code": "111120",
"program_hrs": "0.00",
"program_type": "GE",
"re_enter_year_term": "",
"sl_req": "No",
"status": "Active - Fall 2011",
"teach_cert": "",
"use_new": "No",
"use_old": "No"
},
{
"accepted_by_name": "Person, Name",
"accepted_date": "2017-04-11",
"add_data": "",
"advisor_name": "",
"change_data": "",
"committee_mem_req": "0",
"date_plan_approved": "",
"deadline_year_term": "",
"degree": "BS",
"dis_prog_status": "Active",
"eff_year_term": "20155",
"effective_year_term": "20171",
"expected_grad_year_term": "",
"expired_date": "",
"faculty_advisor_name": "",
"hier": "DEPARTMENT: Computer ScienceCOLLEGE: Physical and Math Sciences",
"major_program_id_desc": "",
"plan_approved_by_name": "",
"primary_program": "Y",
"program_code": "693220",
"program_hrs": "0.00",
"program_type": "MAJOR",
"re_enter_year_term": "",
"sl_req": "No",
"status": "Active - Winter 2017",
"teach_cert": "",
"use_new": "No",
"use_old": "No"
}
],
"Programs_List": [
{
"description": "University Core 2004-Present",
"program_type": "GE",
"space1": "",
"space2": ""
},
{
"description": "Computer Science",
"program_type": "Major",
"space1": "BS",
"space2": "Active"
}
]
}
} - 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.
Schema definitions
- description: description
-
- earned: earned
-
- graded: graded
-
- points: points
-
- gpa: gpa
-
- program_type: program_type
-
- status: status
-
- teach_cert: teach_cert
-
- change_data: change_data
-
- add_data: add_data
-
- hier: hier
-
- program_code: program_code
-
- effective_year_term: effective_year_term
-
- accepted_date: accepted_date
-
- program_hrs: program_hrs
-
- committee_mem_req: committee_mem_req
-
- eff_year_term: eff_year_term
-
- dis_prog_status: dis_prog_status
-
- accepted_by_name: accepted_by_name
-
- deadline_year_term: deadline_year_term
-
- degree: degree
-
- expired_date: expired_date
-
- date_plan_approved: date_plan_approved
-
- expected_grad_year_term: expected_grad_year_term
-
- primary_program: primary_program
-
- re_enter_year_term: re_enter_year_term
-
- plan_approved_by_name: plan_approved_by_name
-
- major_program_id_desc: major_program_id_desc
-
- use_old: use_old
-
- use_new: use_new
-
- sl_req: sl_req
-
- advisor_name: advisor_name
-
- faculty_advisor_name: faculty_advisor_name
-
- program_type: program_type
-
- description: description
-
- space1: space1
-
- space2: space2
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- Credits: Credits
-
- GPAas: GPAas
-
- Programs_List: Programs_List
-
- Hiers: Hiers
-
- Major_List: Major_List
-
- Programs: Programs
-
- PKP: PKP
-