IdentityPersonPersonSummary

PersonSummaryService

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

Base URL: /domains/legacy/identity/person/personsummary

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id_net_id} GET

A summary of a person's PRO data.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

A summary of a person's PRO data.

GET /{person_id_net_id}

Tags: PersonSummaryService

A summary of a person's PRO data.

person_id_net_id

Identifier of individual person

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Summary Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": "200"
}
,
"resource": {
"methods": {
"URI": "/[personid|netid]",
"examples": [
"/",
"/123456789",
"/byu999"
]
,
"options": [
"GET"
]
,
"parameter": [
{
"personid": {
"default": "Identifier of authenticated individual",
"description": "Unique identifier of an individual",
"required": false
}
},
{
"netid": {
"description": "Online account or network identifier of an individual",
"required": false
}
}
]
}
}
,
"response": {
"contact_information": {
"email": "mock@example.com",
"mailing_address": [
"123 Fake St.",
"Apt. 3",
"Provo, UT 84604"
]
,
"phone_number": "801-000-0000",
"work_address": [
"1388 N University Ave",
"Provo, UT 84602"
]
,
"work_email": "",
"work_phone": "801-000-0000"
}
,
"employee_information": {
"date_hired": {
"date": "2015-10-31",
"qualification": "full_time",
"years_of_service": "2 Years, 3 Months"
}
,
"department": "OIT-App Dev Student Info Mgmt",
"employee_role": "STD/PT/ACT",
"job_title": "Computer Programmer",
"reports_to_person_id": "111222333",
"reports_to_person_id_2": "",
"reports_to_person_name": "Fred Smith",
"reports_to_person_name_2": ""
}
,
"identifiers": {
"byu_id": "98-765-4321",
"byu_id_issue_number": "02",
"net_id": "johnd",
"person_id": "123456789"
}
,
"names": {
"complete_name": "Doe, John Albert",
"preferred_name": "John Doe"
}
,
"personal_information": {
"age": "28",
"citizenship": "United States of America",
"date_of_birth": "1990-01-31",
"deceased": false,
"ethnicity": "White",
"gender": "Male",
"home_town": "Provo, Utah",
"marital_status": "Single",
"religion": "Latter-day Saint",
"restricted_record": false
}
,
"photo_URL": "https://y.byu.edu/ry/ae/prod/person/cgi/personPhoto.cgi?p=123456789",
"student_information": {
"classes": [
{
"catalog_entry": "101-004",
"instructor": "(Roberts)",
"teaching_area": "GERM"
},
{
"catalog_entry": "490R-004",
"instructor": "(Smith)",
"teaching_area": "GERM"
},
{
"catalog_entry": "202-008",
"instructor": "(Jacobsen)",
"teaching_area": "HIST"
},
{
"catalog_entry": "113-002",
"instructor": "(Matthews)",
"teaching_area": "MATH"
}
]
,
"credit_hours": "12.0",
"student_role": "Junior",
"year_term": "Winter 2018"
}
,
"summary_line": {
"byu_id": "98-765-4321",
"date_of_birth": "1990-01-31",
"deceased": false,
"email": "mock@example.com",
"employee_role": "STD/PT/ACT",
"gender": "M",
"merge_pending": false,
"merge_to_byu_id": "",
"net_id": "johnd",
"organization": false,
"registrar_warning": false,
"restricted": false,
"sort_name": "",
"student_role": "Junior",
"suffix": ""
}
,
"warnings": [
"Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know"
]
}
}
}
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

contact_information: object

mailing_address: string[]
string
phone_number: string
work_address: string[]
string
work_phone: string
email: string
work_email: string

documentation: object

WebService: object
name: string
operations: operations
errors: errors
httpStatusCodes: httpStatusCodes

employee_information: object

employee_role: string
department: string
job_title: string
date_hired: object
date: string
qualification: string
years_of_service: string
reports_to_person_id: string

ID of person's supervisor/employer

reports_to_person_name: string

Name of person's supervisor/employer

reports_to_person_id_2: string
reports_to_person_name_2: string

errors: object[]

object
code: integer
name: string
message: string
httpStatusCode: integer

httpStatusCodes: object[]

object
code: integer
message: string

identifiers: object

byu_id: string
byu_id_issue_number: string
net_id: string
person_id: string

names: object

preferred_name: string
complete_name: string

The person's full name: Last, First Middle

operations: object[]

object
name: string
description: string
method: string
path: string
path_identifiers: object[]
object
name: string
type: string
format: string
query_attributes: object[]
object
name: string
type: string
format: string
required: string

personal_information: object

date_of_birth: string
age: string
ethnicity: string
gender: string
marital_status: string
citizenship: string
home_town: string
religion: string
deceased: boolean
restricted_record: boolean

PersonSummary: object

Person Summary Service: object
resource: resource
request: request
response: response

request: object

method: string
resource: string
attributes: string
status: string

resource: object

methods: object
options: string[]
string
URI: string
examples: string[]
string
parameter: object[]
object
personid: object
description: string
required: boolean
default: string
netid: object
description: string
required: boolean
default: string

response: object

summary_line: summary_line
photo_URL: string

URL for the person's university photo

identifiers: identifiers
names: names
personal_information: personal_information
employee_information: employee_information
contact_information: contact_information
student_information: student_information
warnings: string[]
string

student_information: object

student_role: string
year_term: string
credit_hours: string
classes: object[]
object
teaching_area: string

Abbreviated prefix of the subject

catalog_entry: string

The course and section numbers

instructor: string

Last name of professor

summary_line: object

email: string
sort_name: string
suffix: string
net_id: string
byu_id: string
date_of_birth: string
gender: string
student_role: string
employee_role: string
organization: boolean
restricted: boolean
deceased: boolean
merge_pending: boolean
merge_to_byu_id: string
registrar_warning: boolean
Service Path: 
/domains/legacy/identity/person/personsummary
Domain or University API: 
/domains/D/identity/person/personsummary

Community

 

Don't see your question listed here? Ask!