Uses default content-types: application/json

200 OK

Success

documentation

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

PersonSummary

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.