AcademicPlanningReportsAcademicSummary

StdCourseWorkService

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

Base URL: /domains/legacy/academic/planning/reports/academicSummary

Version: v1

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

Summary

Path Operation Description
/ GET

Gets the course work for the logged in user

/documentation GET

service definition

/{person_id} GET

Gets the course work for the given student

Paths

Gets the course work for the logged in user

GET /

Tags: StdCourseWorkService

Gets the course work for the logged in user

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/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"ap_credit": "0.00",
"byu_gpa": "2.65",
"byu_id": "12-345-6789",
"data": [
{
"classes": [
{
"catalog_number": "100",
"credit_hours": "3.00",
"curriculum_id": "02859",
"dept_name": "A HTG",
"grade": "C",
"section_number": "081",
"title_code": "006",
"transcript_title": "American Heritage"
}
]
,
"credits": "14.50",
"gpa": "2.86",
"year_term": "20115"
}
]
,
"dataAP": [
{
"APClasses": [
]
,
"earned_hours": "0.00",
"gpa": "0.00",
"grade_points": "0.00",
"graded_hours": "0.00",
"has_repeat": "0",
"orig_earned_hours": "0.00",
"orig_gpa": "0.00",
"orig_grade_points": "0.00",
"orig_graded_hours": "0.00",
"test_type": ""
}
]
,
"dataTransfer": [
]
,
"date_of_birth": "Month Day Year",
"gender": "Male",
"message": "",
"name": "Student, Name",
"total_gpa": "2.65",
"transfer_credit": "0.00"
}
}
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.

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Gets the course work for the given student

GET /{person_id}

Tags: StdCourseWorkService

Gets the course work for the given student

person_id

string -> nine digit number

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/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"ap_credit": "0.00",
"byu_gpa": "2.65",
"byu_id": "12-345-6789",
"data": [
{
"classes": [
{
"catalog_number": "100",
"credit_hours": "3.00",
"curriculum_id": "02859",
"dept_name": "A HTG",
"grade": "C",
"section_number": "081",
"title_code": "006",
"transcript_title": "American Heritage"
}
]
,
"credits": "14.50",
"gpa": "2.86",
"year_term": "20115"
}
]
,
"dataAP": [
{
"APClasses": [
]
,
"earned_hours": "0.00",
"gpa": "0.00",
"grade_points": "0.00",
"graded_hours": "0.00",
"has_repeat": "0",
"orig_earned_hours": "0.00",
"orig_gpa": "0.00",
"orig_grade_points": "0.00",
"orig_graded_hours": "0.00",
"test_type": ""
}
]
,
"dataTransfer": [
]
,
"date_of_birth": "Month Day Year",
"gender": "Male",
"message": "",
"name": "Student, Name",
"total_gpa": "2.65",
"transfer_credit": "0.00"
}
}
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

ap_credit: string

APClasses: object[]

object

byu_gpa: string

byu_id: string

catalog_number: string

classes: object[]

object
curriculum_id: curriculum_id
title_code: title_code
dept_name: dept_name
catalog_number: catalog_number
section_number: section_number
transcript_title: transcript_title
credit_hours: credit_hours
grade: grade

credit_hours: string

credits: string

curriculum_id: string

data: object[]

object
year_term: year_term
credits: credits
gpa: gpa
classes: classes

dataAP: object[]

object
test_type: test_type
earned_hours: earned_hours
graded_hours: graded_hours
grade_points: grade_points
gpa: gpa
has_repeat: has_repeat
orig_earned_hours: orig_earned_hours
orig_graded_hours: orig_graded_hours
orig_grade_points: orig_grade_points
orig_gpa: orig_gpa
APClasses: APClasses

dataTransfer: object[]

object

date_of_birth: string

dept_name: string

earned_hours: string

gender: string

gpa: string

grade: string

grade_points: string

graded_hours: string

has_repeat: string

message: string

name: string

orig_earned_hours: string

orig_gpa: string

orig_grade_points: string

orig_graded_hours: string

request: object

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

response: object

message: message
name: name
byu_id: byu_id
date_of_birth: date_of_birth
gender: gender
byu_gpa: byu_gpa
total_gpa: total_gpa
ap_credit: ap_credit
transfer_credit: transfer_credit
data: data
dataTransfer: dataTransfer
dataAP: dataAP

section_number: string

StdCourseWorkService: object

request: request
response: response

test_type: string

title_code: string

total_gpa: string

transcript_title: string

transfer_credit: string

year_term: string

Service Path: 
/domains/legacy/academic/planning/reports/academicSummary
Domain or University API: 
/domains/D/academic/planning/reports/academicSummary

Community

 

Don't see your question listed here? Ask!