IdentityPersonPROPersonSummary

PersonSummaryService

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id} GET

A summary of a person's PRO data.

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

A summary of a person's PRO data.

GET /{person_id}

Tags: PersonSummaryService

A summary of a person's PRO data.

person_id

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
{
"PersonSummaryService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"contact_information": {
"email": "mock@example.com",
"email_address": "mock@example.com",
"email_address_unlisted": true,
"mailing_address": [
"123 Fake St.",
"Apt. 3",
"Provo, UT 84604"
]
,
"mailing_address_unlisted": false,
"mailing_phone": "801-000-0000",
"mailing_phone_unlisted": false,
"phone_number": "801-000-0000",
"work_address": [
"1388 N University Ave",
"Provo, UT 84602"
]
,
"work_address_unlisted": false,
"work_phone": "801-000-0000",
"work_phone_unlisted": false
}
,
"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",
"reportsToId": "111222333",
"reportsToName": "Fred Smith"
}
,
"identifiers": {
"byu_id": "98-765-4321",
"byu_id_issue_number": "02",
"net_id": "johnd",
"person_id": "123456789",
"ssn": "***-**-1234"
}
,
"names": {
"complete_name": "Doe, John Albert",
"preferred_name": "John Doe"
}
,
"person_summary_line": {
"academic_record": true,
"byu_id": "987654321",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Doe, John Albert",
"net_id": "johnd",
"non_person_organization": false,
"person_id": "123456789",
"registrar_warning": false,
"restricted": false,
"student_role": "Junior"
}
,
"personal_information": {
"age": 28,
"citizenship": "United States of America",
"citizenship_code": "USA",
"date_of_birth": "1990-01-31",
"deceased": false,
"ethnicity": "White",
"ethnicity_code": "WHI",
"gender": "Male",
"gender_code": "M",
"home_town": "Provo, Utah",
"marital_status": "Single",
"marital_status_code": "S",
"religion": "Latter-day Saint",
"religion_code": "LDS",
"restricted_record": false
}
,
"relationships": [
{
"affiliation": "",
"deceased": false,
"employee": "ADM/FT/TRM",
"name": "Jack Doe",
"person_id": "999888777",
"student": "Former Student",
"type": "Child of:"
}
]
,
"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"
}
}
}
}
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.

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
mailing_address_unlisted: boolean
phone_number: string
mailing_phone: string
mailing_phone_unlisted: boolean
work_address: string[]
string
work_address_unlisted: boolean
work_phone: string
work_phone_unlisted: boolean
email: string
email_address: string
email_address_unlisted: boolean

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
reportsToId: string
reportsToName: string

errors: object[]

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

httpStatusCodes: object[]

object
code: integer
message: string

identifiers: object

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

names: object

preferred_name: string
complete_name: string

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

person_summary_line: object

name: string
net_id: string
byu_id: string
person_id: string
student_role: string
employee_role: string
academic_record: boolean
is_employee: boolean
non_person_organization: boolean
restricted: boolean
deceased: boolean
merge_pending: boolean
registrar_warning: boolean

personal_information: object

date_of_birth: string
age: integer
ethnicity: string
ethnicity_code: string
gender: string
gender_code: string
marital_status: string
marital_status_code: string
citizenship: string
citizenship_code: string
home_town: string
religion: string
religion_code: string
deceased: boolean
restricted_record: boolean

personSummary: object

PersonSummaryService: object
request: request
response: response

relationships: object[]

object
type: string
person_id: string
name: string
deceased: boolean
employee: string
student: string
affiliation: string

request: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

response: object

person_summary_line: person_summary_line
identifiers: identifiers
names: names
personal_information: personal_information
employee_information: employee_information
contact_information: contact_information
student_information: student_information
relationships: relationships

student_information: object

student_role: string
year_term: string
credit_hours: string
classes: object[]
object
teaching_area: string
catalog_entry: string
instructor: string
Service Path: 
/domains/legacy/identity/person/PRO/personsummary
Domain or University API: 
/domains/D/identity/person/PRO/personsummary

Community

 

Don't see your question listed here? Ask!