AcademicRecordsProgressReport

ProgressReportService

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

Base URL: /domains/legacy/academic/records/progressreport

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/grad/{net_id}/{program_id}/{abc_program_list} GET

Returns the information found on a graduate progress report

/grad/{person_id_net_id} GET

Returns the information found on a graduate progress report

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Returns the information found on a graduate progress report

GET /grad/{net_id}/{program_id}/{abc_program_list}

Tags: ProgressReportService

Returns the information found on a graduate progress report

net_id

string -> identifier string

path string
program_id

string -> [0-9]{5} 5 digit int

path string
abc_program_list

string -> character string

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": "/grad/net_id/20143/abc_program_list",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"ADMIT_PROVISIONS": [
]
,
"CLASS_MESSAGE": [
"If changes are needed to your program of study or committee, please see your graduate coordinator."
]
,
"CLASS_NOT_ON_PROGRAM_OF_STUDY": [
]
,
"CLEARED_REQ": [
]
,
"COMMITTEE_INFO": [
{
"name": "Person",
"position": "Chair:"
}
]
,
"COMPLETED_COURSES": [
{
"catalog_number": "590",
"catalog_suffix": "R",
"course_title": "Seminar in Information Systems",
"dept_name": "I SYS",
"grade": "A",
"hrs": "3.0",
"req": "MAJOR",
"sem": "Fall 1999",
"transfer_flag": "",
"year_term": "19995"
}
]
,
"COMPLETED_REQUIREMENTS": [
]
,
"COURSE_REQ": [
]
,
"COURSE_STAR_MESSAGE": "",
"DEFICENT_REQ": [
]
,
"DEFICIENT_COURSES": [
]
,
"DEFICIENT_REQUIREMENTS": [
]
,
"DEG_REC": [
{
"degree": "BS",
"degree_year": "1999",
"name": "Brigham Young University"
}
]
,
"DEG_SOUGHT": [
{
"degree": "MISM",
"department": "Information Systems",
"major": "Information Systems Management",
"minor": "",
"program_type": "Non-Thesis",
"specialization": ""
}
]
,
"DOC_SKILL_EXEMP": [
]
,
"GENERAL_ANNOUNCEMENTS": [
{
"announcement": "Please review your progress report carefully and contact your graduate advisor if there are any incorrect grades, changes to your program of study, and address or phone number changes.",
"subject": "YOU ARE RESPONSIBLE FOR THE ACCURACY OF THIS REPORT"
}
]
,
"GRAD_CHECK": [
{
"cap_gown_diploma_info": "",
"college_convocation": "",
"eval_diploma_name": "",
"expected_attendence": "",
"note_on_when": "",
"thesis_title": "",
"university_commencement": ""
}
]
,
"HEADER": [
{
"byu_id": "12-345-6789",
"date_of_progress_report": "February 20, 2018",
"grad_progress": "Graduate Progress Report",
"person_addr_line1": "",
"person_addr_line2": "",
"person_addr_line3": "",
"person_addr_line4": "",
"person_name": "Person",
"person_phone": "123-456-7890"
}
]
,
"MESSAGE": "",
"NOT_APPROVED_COURSES": [
]
,
"OUTDATED_CREDIT": [
]
,
"PREREQ_SKILL_COMPLETED_HOURS": "3.0",
"PREREQ_SKILL_CURRENT_HOURS": "0.0",
"PREREQ_SKILL_DEFICIENT_HOURS": "0.0",
"PREREQ_SKILL_GPA": "3.82",
"PREREQ_SKILL_TOTAL_HOURS": "3.0",
"PROGRAM_COURSES_COMPLETED_HOURS": "3.0",
"PROGRAM_COURSES_CURRENT_HOURS": "0.0",
"PROGRAM_COURSES_DEFICIENT_HOURS": "0.0",
"PROGRAM_COURSES_GPA": "3.83",
"PROGRAM_COURSES_TOTAL_HOURS": "3.0",
"PROGRAM_OF_STUDY_MESSAGE": [
"Coursework is Approved"
]
,
"REGISTERED_COURSES": [
]
,
"REMINDERS": [
]
,
"SINCE_ADMISSION_GPA": "3.83",
"SINCE_ADMISSION_TOTAL_HOURS": "3.0",
"SPECIAL_COMMENTS": [
]
,
"academic_status_msg": "No departmental evaluation recorded",
"degrees_needed_msg": "",
"gpa_too_low_msg": "",
"minimum_registration_requirement": "",
"time_limit_1": "",
"time_limit_2": "First admitted Fall 1999"
}
}
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.

Returns the information found on a graduate progress report

GET /grad/{person_id_net_id}

Tags: ProgressReportService

Returns the information found on a graduate progress report

person_id_net_id

string -> [0-9]{9} 9 digit int or identifier string

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/grad/net_id/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"EVAL1": "",
"EVAL2": "checked",
"MODE": "U",
"NUM_MAJORS": "3",
"PRINTER": "pdf",
"RELEASE": "00001474",
"RESTCompletePrograms": [
{
"degree": "BS",
"effective": "Fall 1998",
"other_info": "Primary Undergraduate",
"program_id": "21968",
"program_info": "(323119) Management",
"type": "Major"
}
]
,
"RESTCurrentPrograms": [
{
"degree": "",
"effective": "Fall 2004",
"other_info": "",
"program_id": "30710",
"program_info": "(819999) Division of Continuing Education",
"type": "Nondegree"
}
]
,
"RESTProgramIds": [
{
"rest_program_id": "30710"
}
]
,
"VERSION": "pro5",
"abc_pgm_list": "listOfCharacters",
"message": "",
"opid": ""
}
}
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

abc_pgm_list: string

academic_status_msg: string

ADMIT_PROVISIONS: object[]

object

announcement: string

byu_id: string

cap_gown_diploma_info: string

catalog_number: string

catalog_suffix: string

CLASS_MESSAGE: string[]

string

CLASS_NOT_ON_PROGRAM_OF_STUDY: object[]

object

CLEARED_REQ: object[]

object

college_convocation: string

COMMITTEE_INFO: object[]

object
position: position
name: name

COMPLETED_COURSES: object[]

object
transfer_flag: transfer_flag
dept_name: dept_name
catalog_number: catalog_number
catalog_suffix: catalog_suffix
course_title: course_title
grade: grade
hrs: hrs
sem: sem
year_term: year_term
req: req

COMPLETED_REQUIREMENTS: object[]

object

COURSE_REQ: object[]

object

COURSE_STAR_MESSAGE: string

course_title: string

date_of_progress_report: string

DEFICENT_REQ: object[]

object

DEFICIENT_COURSES: object[]

object

DEFICIENT_REQUIREMENTS: object[]

object

DEG_REC: object[]

object
degree: degree
name: name
degree_year: degree_year

DEG_SOUGHT: object[]

object
degree: degree
department: department
major: major
specialization: specialization
minor: minor
program_type: program_type

degree: string

degree_year: string

degrees_needed_msg: string

department: string

dept_name: string

DOC_SKILL_EXEMP: object[]

object

effective: string

EVAL1: string

EVAL2: string

eval_diploma_name: string

expected_attendence: string

GENERAL_ANNOUNCEMENTS: object[]

object
subject: subject
announcement: announcement

gpa_too_low_msg: string

GRAD_CHECK: object[]

object
eval_diploma_name: eval_diploma_name
note_on_when: note_on_when
university_commencement: university_commencement
college_convocation: college_convocation
expected_attendence: expected_attendence
cap_gown_diploma_info: cap_gown_diploma_info
thesis_title: thesis_title

grad_progress: string

grade: string

HEADER: object[]

object
byu_id: byu_id
grad_progress: grad_progress
date_of_progress_report: date_of_progress_report
person_name: person_name
person_addr_line1: person_addr_line1
person_addr_line2: person_addr_line2
person_addr_line3: person_addr_line3
person_addr_line4: person_addr_line4
person_phone: person_phone

hrs: string

major: string

message: string

MESSAGE: string

minimum_registration_requirement: string

minor: string

MODE: string

name: string

NOT_APPROVED_COURSES: object[]

object

note_on_when: string

NUM_MAJORS: string

opid: string

other_info: string

OUTDATED_CREDIT: object[]

object

person_addr_line1: string

person_addr_line2: string

person_addr_line3: string

person_addr_line4: string

person_name: string

person_phone: string

position: string

PREREQ_SKILL_COMPLETED_HOURS: string

PREREQ_SKILL_CURRENT_HOURS: string

PREREQ_SKILL_DEFICIENT_HOURS: string

PREREQ_SKILL_GPA: string

PREREQ_SKILL_TOTAL_HOURS: string

PRINTER: string

PROGRAM_COURSES_COMPLETED_HOURS: string

PROGRAM_COURSES_CURRENT_HOURS: string

PROGRAM_COURSES_DEFICIENT_HOURS: string

PROGRAM_COURSES_GPA: string

PROGRAM_COURSES_TOTAL_HOURS: string

program_id: string

program_info: string

PROGRAM_OF_STUDY_MESSAGE: string[]

string

program_type: string

programResponse: object

MESSAGE: MESSAGE
HEADER: HEADER
DEG_SOUGHT: DEG_SOUGHT
DEG_REC: DEG_REC
GRAD_CHECK: GRAD_CHECK
CLEARED_REQ: CLEARED_REQ
DEFICENT_REQ: DEFICENT_REQ
COMMITTEE_INFO: COMMITTEE_INFO
PROGRAM_OF_STUDY_MESSAGE: PROGRAM_OF_STUDY_MESSAGE
CLASS_MESSAGE: CLASS_MESSAGE
DOC_SKILL_EXEMP: DOC_SKILL_EXEMP
COURSE_REQ: COURSE_REQ
COMPLETED_COURSES: COMPLETED_COURSES
REGISTERED_COURSES: REGISTERED_COURSES
DEFICIENT_COURSES: DEFICIENT_COURSES
NOT_APPROVED_COURSES: NOT_APPROVED_COURSES
COURSE_STAR_MESSAGE: COURSE_STAR_MESSAGE
PROGRAM_COURSES_GPA: PROGRAM_COURSES_GPA
PROGRAM_COURSES_TOTAL_HOURS: PROGRAM_COURSES_TOTAL_HOURS
PROGRAM_COURSES_COMPLETED_HOURS: PROGRAM_COURSES_COMPLETED_HOURS
PROGRAM_COURSES_CURRENT_HOURS: PROGRAM_COURSES_CURRENT_HOURS
PROGRAM_COURSES_DEFICIENT_HOURS: PROGRAM_COURSES_DEFICIENT_HOURS
PREREQ_SKILL_GPA: PREREQ_SKILL_GPA
PREREQ_SKILL_TOTAL_HOURS: PREREQ_SKILL_TOTAL_HOURS
PREREQ_SKILL_COMPLETED_HOURS: PREREQ_SKILL_COMPLETED_HOURS
PREREQ_SKILL_CURRENT_HOURS: PREREQ_SKILL_CURRENT_HOURS
PREREQ_SKILL_DEFICIENT_HOURS: PREREQ_SKILL_DEFICIENT_HOURS
SINCE_ADMISSION_GPA: SINCE_ADMISSION_GPA
SINCE_ADMISSION_TOTAL_HOURS: SINCE_ADMISSION_TOTAL_HOURS
CLASS_NOT_ON_PROGRAM_OF_STUDY: CLASS_NOT_ON_PROGRAM_OF_STUDY
ADMIT_PROVISIONS: ADMIT_PROVISIONS
SPECIAL_COMMENTS: SPECIAL_COMMENTS
academic_status_msg: academic_status_msg
gpa_too_low_msg: gpa_too_low_msg
degrees_needed_msg: degrees_needed_msg
minimum_registration_requirement: minimum_registration_requirement
time_limit_1: time_limit_1
time_limit_2: time_limit_2
OUTDATED_CREDIT: OUTDATED_CREDIT
REMINDERS: REMINDERS
COMPLETED_REQUIREMENTS: COMPLETED_REQUIREMENTS
DEFICIENT_REQUIREMENTS: DEFICIENT_REQUIREMENTS
GENERAL_ANNOUNCEMENTS: GENERAL_ANNOUNCEMENTS

ProgressRptService: object

request: request
response: response

ProgressRptServiceProgramList: object

request: request
response: programResponse

REGISTERED_COURSES: object[]

object

RELEASE: string

REMINDERS: object[]

object

req: string

request: object

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

response: object

message: message
VERSION: VERSION
RELEASE: RELEASE
MODE: MODE
NUM_MAJORS: NUM_MAJORS
opid: opid
EVAL1: EVAL1
EVAL2: EVAL2
PRINTER: PRINTER
abc_pgm_list: abc_pgm_list
RESTProgramIds: RESTProgramIds
RESTCurrentPrograms: RESTCurrentPrograms
RESTCompletePrograms: RESTCompletePrograms

rest_program_id: string

RESTCompletePrograms: object[]

object
program_id: program_id
program_info: program_info
type: RESTtype
degree: degree
effective: effective
other_info: other_info

RESTCurrentPrograms: object[]

object
program_id: program_id
program_info: program_info
type: RESTtype
degree: degree
effective: effective
other_info: other_info

RESTProgramIds: object[]

object
rest_program_id: rest_program_id

RESTtype: string

sem: string

SINCE_ADMISSION_GPA: string

SINCE_ADMISSION_TOTAL_HOURS: string

SPECIAL_COMMENTS: object[]

object

specialization: string

subject: string

thesis_title: string

time_limit_1: string

time_limit_2: string

transfer_flag: string

university_commencement: string

VERSION: string

year_term: string

Service Path: 
/domains/legacy/academic/records/progressreport
Domain or University API: 
/domains/D/academic/records/progressreport

Community

 

Don't see your question listed here? Ask!