AcademicRecordsPublicInfo

This service returns the student's public information from the AIM System.

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personId_netId} GET

Returns Public Information for specified person

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Returns Public Information for specified person

GET /{personId_netId}

Tags: PublicInfoService

Returns Public Information for specified person

personId_netId

string -> 9 digit number or string

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": null,
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"addresses": [
{
"additionalNum": "Phone",
"emailAdd": "Email",
"mailAdd": "Address Phone",
"permAdd": "Address Phone"
}
]
,
"awards": [
]
,
"byu_id": "123456789",
"classStanding": "Senior",
"currentEnrollment": "Winter 2018",
"degreesAwarded": [
]
,
"degreesSought": [
{
"degree": "Degree:",
"degreeName": "BS",
"major": "Major:",
"majorName": "Computer Science"
}
]
,
"enrollmentStatus": "Half-time",
"enrollomentStatus": "Half-time",
"lastEnrollment": "Fall 2017",
"person_id": "123456789",
"person_name": "Person"
}
}
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

address: object

List of addresses

permAdd: string,null
mailAdd: string,null
emailAdd: string,null
additionalNum: string,null

degrees: object

major, majorName, degree, degreeName

major: string,null
majorName: string,null
degree: string,null
degreeName: string,null

error_data: object

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

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

RecStdInfoService: object

request: request
response: response

request: object

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

response: object

byu_id: string,null

9 digit number

person_id: string,null

9 digit number

person_name: string,null

lastName, firstName middleName

addresses: array,null

permanent address, mailing address, email address, and additional phone numbers.

degreesSought: array,null

Degree information

degreesAwarded: array,null
awards: array,null
classStanding: string,null
currentEnrollment: string,null
enrollomentStatus: string,null
lastEnrollment: string,null
enrollmentStatus: string,null
Service Path: 
/domains/legacy/academic/records/publicinfo
Domain or University API: 
/domains/D/academic/records/publicinfo

Community

 

Don't see your question listed here? Ask!