AcademicRecordsExamCredit

This service returns a student's exam credits (AP, CLEP, IB, etc.) from the AIM System.

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personId} GET

Shows page according to specified person Id

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Shows page according to specified person Id

GET /{personId}

Tags: ExamCreditService

Shows page according to specified person Id

personId

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": {
"BYUExams": [
{
"byu_id": "123456789",
"catalog_number": "142",
"catalog_suffix": "",
"course_name": "C S142",
"credit_hours": 3,
"credit_hours_use": 0,
"credit_institution": "BYU PROVO",
"curriculum_id": "01489",
"date_time_updated": "2018-02-16",
"dept_name": "C S",
"grade": "C",
"honors": "N",
"person_id": "123456789",
"person_name": "Student, Name",
"person_name_f_l": "",
"repeat_status": "N",
"service_learning": "N",
"std_exam_class_id": "1154872",
"title_code": "002",
"transcript_title": "Intro to Computer Programming",
"updated_by_byu_id": "123456789",
"updated_by_id": "123456789",
"updated_by_name": "Student, Name",
"updated_by_name_f_l": "",
"year_term": "20175"
}
]
,
"admissions_limitation": "N",
"mode": "U",
"numberOfBYUExams": 1,
"numberOfOtherExams": 0,
"otherData": [
]
,
"otherExams": [
]
}
}
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

byu_id: string

BYUExam: object

year_term: year_term
std_exam_class_id: std_exam_class_id
course_name: course_name
transcript_title: transcript_title
credit_hours: credit_hours
credit_hours_use: credit_hours_use
honors: honors
service_learning: service_learning
grade: grade
repeat_status: repeat_status
curriculum_id: curriculum_id
title_code: title_code
date_time_updated: date_time_updated
updated_by_name: updated_by_name
updated_by_name_f_l: updated_by_name_f_l
dept_name: dept_name
catalog_number: catalog_number
catalog_suffix: catalog_suffix
updated_by_byu_id: updated_by_byu_id
byu_id: byu_id
person_name: person_name
person_name_f_l: person_name_f_l
updated_by_id: updated_by_id
person_id: person_id
credit_institution: credit_institution

catalog_number: string

catalog_suffix: string

course_name: string

courseName: string

credit_hours: number

credit_hours_use: number

credit_institution: string

creditHours: number

curriculum_id: string

curriculumID: string

date_time_updated: string

dateTimeUpdated: string

yyyy-mm-dd

dept_name: string

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

grade: string

honors: string

isUpdatedByName: string

otherData: object

testType: testType
testDate: testDate
testName: testName
testScore: testScore

otherExam: object

testType: testType
standardExamClassID: standardExamClassID
testDate: testDate
testDescription: testDescription
testScore: testScore
courseName: courseName
transcriptTitle: transcriptTitle
creditHours: creditHours
grade: grade
repeatStatus: repeatStatus
curriculumID: curriculumID
titleCode: titleCode
dateTimeUpdated: dateTimeUpdated
isUpdatedByName: isUpdatedByName

person_id: string

person_name: string

person_name_f_l: string

RecExamCreditService: object

request: request
response: response

repeat_status: string

repeatStatus: string

request: object

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

response: object

BYUExams: object[]
otherExams: object[]
otherData: object[]
numberOfBYUExams: integer
numberOfOtherExams: integer
mode: string
admissions_limitation: string

service_learning: string

standardExamClassID: string

std_exam_class_id: string

testDate: string

mm/yyyy

testDescription: string

testName: string

testScore: number

testType: string

title_code: string

titleCode: string

transcript_title: string

transcriptTitle: string

updated_by_byu_id: string

updated_by_id: string

updated_by_name: string

updated_by_name_f_l: string

year_term: string

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

Community

 

Don't see your question listed here? Ask!