Persons

Persons Resource of the University API

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

Base URL: /byuapi/persons

Version: v3

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

Summary

Path Operation Description
/ GET

Persons

POST

Persons

/{byu_id} DELETE

Persons

GET

Persons

PUT

Persons

/{byu_id}/addresses GET

Addresses

/{byu_id}/addresses/{address_type} DELETE

Addresses

GET

Addresses

PUT

Addresses

/{byu_id}/alias_domains GET

Alias domains

/{byu_id}/credentials GET

Credentials

/{byu_id}/credentials/{credential_type},{credential_id} DELETE

Credentials

GET

Credentials

PUT

Credentials

/{byu_id}/email_addresses GET

Email addresses

/{byu_id}/email_addresses/{email_address_type} DELETE

Email addresses

GET

Email addresses

PUT

Email addresses

/{byu_id}/email_aliases GET

Email aliases

/{byu_id}/email_aliases/{email_alias} DELETE

Email aliases

GET

Email aliases

PUT

Email aliases

/{byu_id}/employee_summary GET

Employee summary

/{byu_id}/family_phones GET

Family phones

/{byu_id}/family_phones/{phone_type},{lookup_number} DELETE

Family phones

GET

Family phones

PUT

Family phones

/{byu_id}/group_memberships GET

Group memberships

/{byu_id}/group_memberships/{group_id} DELETE

Group memberships

GET

Group memberships

PUT

Group memberships

/{byu_id}/groups_administered GET

Groups administered

/{byu_id}/groups_administered/{group_id} GET

Groups administered

/{byu_id}/id_card GET

ID cards

PUT

ID cards

/{byu_id}/languages GET

Languages

/{byu_id}/languages/{language_code} DELETE

Languages

GET

Languages

PUT

Languages

/{byu_id}/personal_record GET

Persons

PUT

Persons

/{byu_id}/phones GET

Phones

/{byu_id}/phones/{lookup_number} DELETE

Phones

GET

Phones

PUT

Phones

/{byu_id}/relationships GET

Relationships

/{byu_id}/relationships/{related_byu_id} DELETE

Relationships

GET

Relationships

PUT

Relationships

/{byu_id}/student_summary GET

Student summary

/{byu_id}/vital_record GET

Persons

PUT

Persons

Paths

Persons

GET /

Tags: persons

Returns a collection of Persons

byu_ids

The person's BYU ID

query string[]
person_ids

The person's person ID

query string[]
net_ids

The person's Net ID

query string[]
credentials.credential_type

The type of credential being looked up

query string , x ∈ { BYU_HAWAII_ID , BYU_IDAHO_ID , FACEBOOK_ID , GOOGLE_ID , ID_CARD , LDS_ACCOUNT_ID , LDS_CMIS_ID , NET_ID , PROX_CARD , SEMINARY_STUDENT_ID , SEOS_CARD , WSO2_CLIENT_ID }
credentials.credential_id

The credential id

query string (1 to 100 chars)
credentials.user_names

The user name belonging to the credential type

query string[]
email_addresses.email_address

The person's PERSONAL email address. A case-insensitive search is performed. A wildcard character is automatically appended.

query string (email)
email_aliases.email_alias

The person's email alias. A case-insensitive search is performed. A wildcard character is automatically appended.

query string (email)
phones.phone_numbers

The person's phone number. A numerics-only search is performed. Search multiple numbers separated by commas

query string[]
surname

The person's surname. A case-insensitive search is performed. You may insert '*' wildcards anywhere in the string, and a wildcard character is automatically appended.

query string (up to 40 chars) , must match ^([A-Za-z-x27;*]+ )*?[A-Za-z-x27;*]+$
rest_of_name

The person's given names. A case-insensitive search is performed.

query string (up to 80 chars) , must match ^([A-Za-z-x27;]+ )*?[A-Za-z-x27;]+$
preferred_surname

The person's preferred surname. A case-insensitive search is performed.

query string (up to 40 chars) , must match ^([A-Za-z-x27;]+ )*?[A-Za-z-x27;]+$
preferred_first_name

The person's preferred first name. A case-insensitive search is performed.

query string (up to 25 chars) , must match ^([A-Za-z-x27;]+ )*?[A-Za-z-x27;]+$
sex

The person's sex

query string , x ∈ { ? , F , M , f , m }
deceased

The person's deceased status

query boolean
vital_record.marital_status

The person's marital status

query string , x ∈ { ? , D , M , S , W , d , m , s , w }
personal_record.religion_code

The person's religion, validated through the meta/religion service

query string , must match ^([?]{3}|[A-Za-z]{3})$
personal_record.citizenship_country_code

The person's citizenship, validated through the meta/country service

query string , must match ^([?]{3}|[A-Za-z]{2,3})$
home_town

The person's home town

query string (up to 30 chars) , must match ^([A-Za-z-]+ )*?[A-Za-z-]+$
home_state_code

The person's home state, validated through the meta/state service

query string (up to 4 chars) , must match ^([?]{2}|[A-Za-z]{2,5})$
home_country_code

The person's home country code, validated through the meta/country service

query string , must match ^([?]{3}|[A-Za-z]{2,3})$
restricted

The FERPA restricted status

query boolean
personal_record.visa_type

The person's visa type, validated through the meta/visa_type service

query string (up to 3 chars) , must match ^( |[0-9A-Za-z?-]{1,3})$
employee_summary.employee_role

The person's employee type in XXX-XX-XXX format. (See the meta/employee_role service)

query string , must match ^[ACEOPRS][ADEFHMNOT][ACDFHMNPS]-[CFOPST][123BCMT]-[ADLRT][CER][CMTV]$
student_summary.student_status

The person's student status. Provided by Student Status Info service

query string
group_memberships.group_ids

Returns a collection of people who are members of group_id. Group ID must match exactly

query string[]
groups_administered.group_id

Returns a collection of people who are administrators of group_id. Group ID must match exactly

query string
field_sets

indicates which field sets are to be returned

query string[] basic
contexts

indicates which contexts are to be returned

query string[]
page_start

Which page to start on, Must be greater than 0

query integer (int32) 1
page_size

Size of the collection returned, Must be greater than 0

query integer (int32) 100

Uses default content-types: application/json

200 OK

A collection of Persons successfully returned

Example for application/json
{
"links": {
"persons__create": {
"href": "https://api.byu.edu/byuapi/persons/v3/",
"method": "POST",
"rel": "persons__create"
}
,
"persons__current": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=1,page_size=50",
"method": "GET",
"rel": "persons__current"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/",
"method": "GET",
"rel": "self"
}
,
"persons__next": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=101,page_size=50",
"method": "GET",
"rel": "persons__next"
}
,
"persons__prev": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=1,page_size=50",
"method": "GET",
"rel": "persons__prev"
}
}
,
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"contact": [
"basic",
"addresses",
"email_addresses",
"family_phones",
"phones"
]
,
"emergency": [
"family_phones",
"relationships"
]
,
"marriott_school": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"official": [
"credentials",
"vital_record",
"personal_record",
"id_card"
]
}
,
"default_page_size": 50,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"maximum_page_size": 200,
"page_end": 1,
"page_size": 50,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"alias_domain": {
"api_type": "system",
"key": true,
"value": "@byu.edu"
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"limit": {
"api_type": "system",
"value": 25
}
,
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
}
,
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"quantity": {
"api_type": "derived",
"value": 4
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"deceased": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"value": false
}
,
"first_name": {
"api_type": "modifiable",
"value": "Abernathy"
}
,
"high_school_city": {
"api_type": "derived",
"value": "Cypress"
}
,
"high_school_code": {
"api_type": "modifiable",
"description": "Cypress High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools/v1",
"value": "050714"
}
,
"high_school_state_code": {
"api_type": "derived",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"home_state_code": {
"api_type": "modifiable",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_town": {
"api_type": "modifiable",
"value": "Cypress"
}
,
"links": {
"basic__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "DELETE",
"rel": "persons__delete"
}
,
"basic__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic",
"method": "GET",
"rel": "self"
}
,
"basic__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "PUT",
"rel": "persons__modify"
}
}
,
"merge_in_process": {
"api_type": "derived",
"value": false
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"restricted": false,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"name_fnf": {
"api_type": "derived",
"value": "Abernathy Cosmo Cougar-Rodriguez II"
}
,
"name_lnf": {
"api_type": "derived",
"value": "Cougar-Rodriguez, Abernathy Cosmo, II"
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
}
,
"person_id": {
"api_type": "system",
"value": "987654321"
}
,
"personal_email_address": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"value": "cosmo5@byu.edu"
}
,
"preferred_first_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"preferred_name": {
"api_type": "derived",
"value": "Cosmo Cougar"
}
,
"preferred_surname": {
"api_type": "modifiable",
"value": "Cougar"
}
,
"primary_phone_number": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/8014224000",
"value": "8014224000"
}
,
"rest_of_name": {
"api_type": "derived",
"value": "Abernathy Cosmo"
}
,
"restricted": {
"api_type": "modifiable",
"value": false
}
,
"sex": {
"api_type": "modifiable",
"value": "M"
}
,
"suffix": {
"api_type": "modifiable",
"value": "II"
}
,
"surname": {
"api_type": "modifiable",
"value": "Cougar-Rodriguez"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
}
,
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
}
,
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
}
,
"issuing_location": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations/v1",
"value": "133"
}
,
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
}
,
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
}
,
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
}
,
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "modifiable",
"value": ""
}
,
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
}
,
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
}
,
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
}
,
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
]
,
"key": true,
"value": "PERSONAL"
}
,
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
}
,
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
}
,
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
}
,
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
}
,
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
}
,
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"employee_summary": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments/v1",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "Student, Part-time, Active",
"value": "STD-PT-ACT"
}
,
"hire_date": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"employee_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/employee_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"reports_to_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
}
,
"family_phones": {
"links": {
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": false
}
,
"contact_person": {
"api_type": "modifiable",
"value": "Hello Father"
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"family_phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "DELETE",
"rel": "familyPhones__delete"
}
,
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones/:phone_type,:lookup_number",
"method": "GET",
"rel": "self"
}
,
"family_phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "PUT",
"rel": "familyPhones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"phone_type": {
"api_type": "modifiable",
"domain": [
"EMR",
"PRM"
]
,
"key": true,
"value": ""
}
,
"preferred_language_code": {
"api_type": "modifiable",
"description": "English",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "EN"
}
,
"relationship": {
"api_type": "modifiable",
"value": "PARENT"
}
,
"texts_okay": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered",
"method": "GET",
"rel": "self"
}
,
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
}
,
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/domains/department",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"effective_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"expiration_date": {
"api_type": "read-only",
"value": "2018-06-13"
}
,
"group_description": {
"api_type": "read-only",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"inactivated_by_byu_id": {
"api_type": "read-only",
"description": "inactivated_by_name_lnf",
"value": ""
}
,
"inactivated_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
}
,
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
}
,
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"id_card": {
"beard_flag": {
"api_type": "read-only",
"value": false
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"dtf_flag": {
"api_type": "read-only",
"value": false
}
,
"links": {
"id_card__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "GET",
"rel": "self"
}
,
"id_card__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "read-only",
"value": ""
}
,
"primary_role_when_issued": {
"api_type": "read-only",
"value": "Student"
}
,
"printed_name": {
"api_type": "read-only",
"value": "Cosmo Cougar"
}
,
"secondary_role_when_issued": {
"api_type": "read-only",
"value": "Senior"
}
,
"site_id": {
"api_type": "read-only",
"value": "133"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"use_preferred_name_on_id_card": {
"api_type": "modifiable",
"value": true
}
}
,
"languages": {
"links": {
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"language_code": {
"api_type": "modifiable",
"description": "Spanish",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"key": true,
"long_description": "Spanish",
"value": "ES"
}
,
"links": {
"languages__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "DELETE",
"rel": "languages__delete"
}
,
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "GET",
"rel": "self"
}
,
"languages__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "PUT",
"rel": "languages__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"native": {
"api_type": "modifiable",
"value": true
}
,
"read_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "M"
}
,
"speak_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "L"
}
,
"translator": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"write_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "H"
}
}
]
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic,addresses,alias_domains,credentials,email_addresses,email_aliases,employee_summary,family_phones,group_memberships,groups_administered,id_card,languages,personal_record,phones,relationships,student_summary,vital_record",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"contact": [
"basic",
"addresses",
"email_addresses",
"family_phones",
"phones"
]
,
"emergency": [
"family_phones",
"relationships"
]
,
"marriott_school": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"official": [
"credentials",
"vital_record",
"personal_record",
"id_card"
]
}
,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"restricted": false,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"personal_record": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"date_of_birth": {
"api_type": "modifiable",
"value": ""
}
,
"date_of_death": {
"api_type": "modifiable",
"value": "2018-06-13"
}
,
"deceased": {
"api_type": "modifiable",
"value": true
}
,
"lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"links": {
"personal_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "GET",
"rel": "self"
}
,
"personal_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "PUT",
"rel": "self"
}
}
,
"marital_status": {
"api_type": "modifiable",
"description": "",
"domain": [
"W",
"M",
"?",
"D",
"S"
]
,
"value": ""
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"parent_lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"religion_code": {
"api_type": "modifiable",
"description": "",
"value": ""
}
,
"sex": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": true
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
}
,
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
}
,
"phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"primary_flag": {
"api_type": "modifiable",
"value": true
}
,
"texts_okay": {
"api_type": "modifiable",
"value": true
}
,
"time_code": {
"api_type": "modifiable",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
}
,
"tty": {
"api_type": "modifiable",
"value": false
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"work_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
}
,
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
}
,
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"related_byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"related_name_fnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_name_lnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_first_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_rest_of_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"relationship_type": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
}
,
"verified_datetime": {
"api_type": "system",
"value": "2018-06-13T14:20:00.000Z"
}
}
]
}
,
"student_summary": {
"attended_byu": {
"api_type": "derived",
"value": true
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"current_student": {
"api_type": "related",
"value": ""
}
,
"eligible_to_register": {
"api_type": "related",
"value": ""
}
,
"links": {
"student_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/:byu_id/student_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"student_status": {
"api_type": "related",
"value": ""
}
}
,
"vital_record": {
"birth_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"citizenship_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"i20_expiration_date": {
"api_type": "modifiable",
"value": ""
}
,
"links": {
"vital_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "GET",
"rel": "self"
}
,
"vital_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"ssn": {
"api_type": "modifiable",
"value": ""
}
,
"ssn_verification_date": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"visa_type": {
"api_type": "modifiable",
"value": ""
}
,
"visa_type_source": {
"api_type": "modifiable",
"value": ""
}
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Persons

POST /

Tags: persons

Creates a Person

Uses default content-types: application/json

The address values to be set

Uses default content-types: application/json

201 Created

Person successfully created

Example for application/json
{
"links": {
"persons__create": {
"href": "https://api.byu.edu/byuapi/persons/v3/",
"method": "POST",
"rel": "persons__create"
}
,
"persons__current": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=1,page_size=50",
"method": "GET",
"rel": "persons__current"
}
,
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/",
"method": "GET",
"rel": "self"
}
,
"persons__next": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=101,page_size=50",
"method": "GET",
"rel": "persons__next"
}
,
"persons__prev": {
"href": "https://api.byu.edu/byuapi/persons/v3/?page_start=1,page_size=50",
"method": "GET",
"rel": "persons__prev"
}
}
,
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"contact": [
"basic",
"addresses",
"email_addresses",
"family_phones",
"phones"
]
,
"emergency": [
"family_phones",
"relationships"
]
,
"marriott_school": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"official": [
"credentials",
"vital_record",
"personal_record",
"id_card"
]
}
,
"default_page_size": 50,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"maximum_page_size": 200,
"page_end": 1,
"page_size": 50,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"alias_domain": {
"api_type": "system",
"key": true,
"value": "@byu.edu"
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"limit": {
"api_type": "system",
"value": 25
}
,
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
}
,
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"quantity": {
"api_type": "derived",
"value": 4
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"deceased": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"value": false
}
,
"first_name": {
"api_type": "modifiable",
"value": "Abernathy"
}
,
"high_school_city": {
"api_type": "derived",
"value": "Cypress"
}
,
"high_school_code": {
"api_type": "modifiable",
"description": "Cypress High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools/v1",
"value": "050714"
}
,
"high_school_state_code": {
"api_type": "derived",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"home_state_code": {
"api_type": "modifiable",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_town": {
"api_type": "modifiable",
"value": "Cypress"
}
,
"links": {
"basic__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "DELETE",
"rel": "persons__delete"
}
,
"basic__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic",
"method": "GET",
"rel": "self"
}
,
"basic__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "PUT",
"rel": "persons__modify"
}
}
,
"merge_in_process": {
"api_type": "derived",
"value": false
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"restricted": false,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"name_fnf": {
"api_type": "derived",
"value": "Abernathy Cosmo Cougar-Rodriguez II"
}
,
"name_lnf": {
"api_type": "derived",
"value": "Cougar-Rodriguez, Abernathy Cosmo, II"
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
}
,
"person_id": {
"api_type": "system",
"value": "987654321"
}
,
"personal_email_address": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"value": "cosmo5@byu.edu"
}
,
"preferred_first_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"preferred_name": {
"api_type": "derived",
"value": "Cosmo Cougar"
}
,
"preferred_surname": {
"api_type": "modifiable",
"value": "Cougar"
}
,
"primary_phone_number": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/8014224000",
"value": "8014224000"
}
,
"rest_of_name": {
"api_type": "derived",
"value": "Abernathy Cosmo"
}
,
"restricted": {
"api_type": "modifiable",
"value": false
}
,
"sex": {
"api_type": "modifiable",
"value": "M"
}
,
"suffix": {
"api_type": "modifiable",
"value": "II"
}
,
"surname": {
"api_type": "modifiable",
"value": "Cougar-Rodriguez"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
}
,
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
}
,
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
}
,
"issuing_location": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations/v1",
"value": "133"
}
,
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
}
,
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
}
,
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
}
,
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "modifiable",
"value": ""
}
,
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
}
,
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
}
,
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
}
,
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
]
,
"key": true,
"value": "PERSONAL"
}
,
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
}
,
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
}
,
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
}
,
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
}
,
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
}
,
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"employee_summary": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments/v1",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "Student, Part-time, Active",
"value": "STD-PT-ACT"
}
,
"hire_date": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"employee_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/employee_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"reports_to_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
}
,
"family_phones": {
"links": {
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": false
}
,
"contact_person": {
"api_type": "modifiable",
"value": "Hello Father"
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"family_phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "DELETE",
"rel": "familyPhones__delete"
}
,
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones/:phone_type,:lookup_number",
"method": "GET",
"rel": "self"
}
,
"family_phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "PUT",
"rel": "familyPhones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"phone_type": {
"api_type": "modifiable",
"domain": [
"EMR",
"PRM"
]
,
"key": true,
"value": ""
}
,
"preferred_language_code": {
"api_type": "modifiable",
"description": "English",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "EN"
}
,
"relationship": {
"api_type": "modifiable",
"value": "PARENT"
}
,
"texts_okay": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered",
"method": "GET",
"rel": "self"
}
,
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
}
,
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/domains/department",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"effective_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"expiration_date": {
"api_type": "read-only",
"value": "2018-06-13"
}
,
"group_description": {
"api_type": "read-only",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"inactivated_by_byu_id": {
"api_type": "read-only",
"description": "inactivated_by_name_lnf",
"value": ""
}
,
"inactivated_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
}
,
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
}
,
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"id_card": {
"beard_flag": {
"api_type": "read-only",
"value": false
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"dtf_flag": {
"api_type": "read-only",
"value": false
}
,
"links": {
"id_card__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "GET",
"rel": "self"
}
,
"id_card__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "read-only",
"value": ""
}
,
"primary_role_when_issued": {
"api_type": "read-only",
"value": "Student"
}
,
"printed_name": {
"api_type": "read-only",
"value": "Cosmo Cougar"
}
,
"secondary_role_when_issued": {
"api_type": "read-only",
"value": "Senior"
}
,
"site_id": {
"api_type": "read-only",
"value": "133"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"use_preferred_name_on_id_card": {
"api_type": "modifiable",
"value": true
}
}
,
"languages": {
"links": {
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"language_code": {
"api_type": "modifiable",
"description": "Spanish",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"key": true,
"long_description": "Spanish",
"value": "ES"
}
,
"links": {
"languages__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "DELETE",
"rel": "languages__delete"
}
,
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "GET",
"rel": "self"
}
,
"languages__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "PUT",
"rel": "languages__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"native": {
"api_type": "modifiable",
"value": true
}
,
"read_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "M"
}
,
"speak_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "L"
}
,
"translator": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"write_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "H"
}
}
]
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic,addresses,alias_domains,credentials,email_addresses,email_aliases,employee_summary,family_phones,group_memberships,groups_administered,id_card,languages,personal_record,phones,relationships,student_summary,vital_record",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"contact": [
"basic",
"addresses",
"email_addresses",
"family_phones",
"phones"
]
,
"emergency": [
"family_phones",
"relationships"
]
,
"marriott_school": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"official": [
"credentials",
"vital_record",
"personal_record",
"id_card"
]
}
,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"restricted": false,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"personal_record": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"date_of_birth": {
"api_type": "modifiable",
"value": ""
}
,
"date_of_death": {
"api_type": "modifiable",
"value": "2018-06-13"
}
,
"deceased": {
"api_type": "modifiable",
"value": true
}
,
"lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"links": {
"personal_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "GET",
"rel": "self"
}
,
"personal_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "PUT",
"rel": "self"
}
}
,
"marital_status": {
"api_type": "modifiable",
"description": "",
"domain": [
"W",
"M",
"?",
"D",
"S"
]
,
"value": ""
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"parent_lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"religion_code": {
"api_type": "modifiable",
"description": "",
"value": ""
}
,
"sex": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": true
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
}
,
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
}
,
"phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"primary_flag": {
"api_type": "modifiable",
"value": true
}
,
"texts_okay": {
"api_type": "modifiable",
"value": true
}
,
"time_code": {
"api_type": "modifiable",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
}
,
"tty": {
"api_type": "modifiable",
"value": false
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"work_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
}
,
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
}
,
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"related_byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"related_name_fnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_name_lnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_first_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_rest_of_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"relationship_type": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
}
,
"verified_datetime": {
"api_type": "system",
"value": "2018-06-13T14:20:00.000Z"
}
}
]
}
,
"student_summary": {
"attended_byu": {
"api_type": "derived",
"value": true
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"current_student": {
"api_type": "related",
"value": ""
}
,
"eligible_to_register": {
"api_type": "related",
"value": ""
}
,
"links": {
"student_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/:byu_id/student_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"student_status": {
"api_type": "related",
"value": ""
}
}
,
"vital_record": {
"birth_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"citizenship_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"i20_expiration_date": {
"api_type": "modifiable",
"value": ""
}
,
"links": {
"vital_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "GET",
"rel": "self"
}
,
"vital_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"ssn": {
"api_type": "modifiable",
"value": ""
}
,
"ssn_verification_date": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"visa_type": {
"api_type": "modifiable",
"value": ""
}
,
"visa_type_source": {
"api_type": "modifiable",
"value": ""
}
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

405 Method Not Allowed #/responses/405

Method Not Allowed

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Persons

DELETE /{byu_id}

Tags: persons

Deletes the person with the specified BYU ID

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$

Uses default content-types: application/json

204 No Content

Person successfully deleted

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Persons

GET /{byu_id}

Tags: persons

Returns the person with the specified BYU ID

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$
field_sets

indicates which field sets are to be returned

query string[] basic
contexts

indicates which contexts are to be returned

query string[]

Uses default content-types: application/json

200 OK

Person successfully returned

Example for application/json
{
"addresses": {
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"alias_domains": {
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"alias_domain": {
"api_type": "system",
"key": true,
"value": "@byu.edu"
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"limit": {
"api_type": "system",
"value": 25
}
,
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
}
,
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"quantity": {
"api_type": "derived",
"value": 4
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"basic": {
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"deceased": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"value": false
}
,
"first_name": {
"api_type": "modifiable",
"value": "Abernathy"
}
,
"high_school_city": {
"api_type": "derived",
"value": "Cypress"
}
,
"high_school_code": {
"api_type": "modifiable",
"description": "Cypress High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools/v1",
"value": "050714"
}
,
"high_school_state_code": {
"api_type": "derived",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"home_state_code": {
"api_type": "modifiable",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_town": {
"api_type": "modifiable",
"value": "Cypress"
}
,
"links": {
"basic__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "DELETE",
"rel": "persons__delete"
}
,
"basic__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic",
"method": "GET",
"rel": "self"
}
,
"basic__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "PUT",
"rel": "persons__modify"
}
}
,
"merge_in_process": {
"api_type": "derived",
"value": false
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"restricted": false,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"name_fnf": {
"api_type": "derived",
"value": "Abernathy Cosmo Cougar-Rodriguez II"
}
,
"name_lnf": {
"api_type": "derived",
"value": "Cougar-Rodriguez, Abernathy Cosmo, II"
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
}
,
"person_id": {
"api_type": "system",
"value": "987654321"
}
,
"personal_email_address": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"value": "cosmo5@byu.edu"
}
,
"preferred_first_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"preferred_name": {
"api_type": "derived",
"value": "Cosmo Cougar"
}
,
"preferred_surname": {
"api_type": "modifiable",
"value": "Cougar"
}
,
"primary_phone_number": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/8014224000",
"value": "8014224000"
}
,
"rest_of_name": {
"api_type": "derived",
"value": "Abernathy Cosmo"
}
,
"restricted": {
"api_type": "modifiable",
"value": false
}
,
"sex": {
"api_type": "modifiable",
"value": "M"
}
,
"suffix": {
"api_type": "modifiable",
"value": "II"
}
,
"surname": {
"api_type": "modifiable",
"value": "Cougar-Rodriguez"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"credentials": {
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
}
,
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
}
,
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
}
,
"issuing_location": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations/v1",
"value": "133"
}
,
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
}
,
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
}
,
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
}
,
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "modifiable",
"value": ""
}
,
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
}
,
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
}
,
"email_addresses": {
"links": {
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_address": {
"api_type": "modifiable",
"value": "cosmo5@byu.edu"
}
,
"email_address_type": {
"api_type": "modifiable",
"domain": [
"PERSONAL",
"SECURITY",
"WORK"
]
,
"key": true,
"value": "PERSONAL"
}
,
"links": {
"email_addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "DELETE",
"rel": "email_address__delete"
}
,
"email_addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "GET",
"rel": "self"
}
,
"email_addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"method": "PUT",
"rel": "email_address__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"email_aliases": {
"links": {
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"email_alias": {
"api_type": "read-only",
"key": true,
"value": "cosmo_cougar@byu.edu"
}
,
"forwards_to": {
"api_type": "read-only",
"value": "cosmo5@gmail.com,cosmo55@yahoo.com"
}
,
"links": {
"email_aliases__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"email_aliases__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "GET",
"rel": "self"
}
,
"email_aliases__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/email_aliases/cosmo_cougar@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"employee_summary": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments/v1",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "Student, Part-time, Active",
"value": "STD-PT-ACT"
}
,
"hire_date": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"employee_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/employee_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"reports_to_id": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
}
,
"family_phones": {
"links": {
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": false
}
,
"contact_person": {
"api_type": "modifiable",
"value": "Hello Father"
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"family_phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "DELETE",
"rel": "familyPhones__delete"
}
,
"family_phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/family_phones/:phone_type,:lookup_number",
"method": "GET",
"rel": "self"
}
,
"family_phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/familyPhones/:phone_type,:lookup_number",
"method": "PUT",
"rel": "familyPhones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"phone_type": {
"api_type": "modifiable",
"domain": [
"EMR",
"PRM"
]
,
"key": true,
"value": ""
}
,
"preferred_language_code": {
"api_type": "modifiable",
"description": "English",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"value": "EN"
}
,
"relationship": {
"api_type": "modifiable",
"value": "PARENT"
}
,
"texts_okay": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
,
"group_memberships": {
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/byuapi/meta/departments",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"group_memberships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/group_memberships/:group_id",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"groups_administered": {
"links": {
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered",
"method": "GET",
"rel": "self"
}
,
"groups_administered__next": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__next"
}
,
"groups_administered__prev": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered?page_start=:page_start,page_size=:page_size",
"method": "GET",
"rel": "groups_administered__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "",
"key": true,
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"department": {
"api_type": "related",
"domain": "https://api.byu.edu/domains/department",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"effective_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"employee_role": {
"api_type": "derived",
"description": "",
"value": ""
}
,
"expiration_date": {
"api_type": "read-only",
"value": "2018-06-13"
}
,
"group_description": {
"api_type": "read-only",
"value": ""
}
,
"group_id": {
"api_type": "read-only",
"description": "",
"key": true,
"value": ""
}
,
"group_type": {
"api_type": "read-only",
"value": ""
}
,
"inactivated_by_byu_id": {
"api_type": "read-only",
"description": "inactivated_by_name_lnf",
"value": ""
}
,
"inactivated_date": {
"api_type": "system",
"value": "2018-06-13"
}
,
"job_code": {
"api_type": "related",
"description": "",
"related_resource": "https://api.byu.edu/byuapi/employees",
"value": ""
}
,
"links": {
"groups_administered__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "DELETE",
"rel": "groups_administered__delete"
}
,
"groups_administered__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "GET",
"rel": "self"
}
,
"groups_administered__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/groups_administered/:group_id",
"method": "PUT",
"rel": "groups_administered__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
}
]
}
,
"id_card": {
"beard_flag": {
"api_type": "read-only",
"value": false
}
,
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"dtf_flag": {
"api_type": "read-only",
"value": false
}
,
"links": {
"id_card__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "GET",
"rel": "self"
}
,
"id_card__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/id_card",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "read-only",
"value": ""
}
,
"primary_role_when_issued": {
"api_type": "read-only",
"value": "Student"
}
,
"printed_name": {
"api_type": "read-only",
"value": "Cosmo Cougar"
}
,
"secondary_role_when_issued": {
"api_type": "read-only",
"value": "Senior"
}
,
"site_id": {
"api_type": "read-only",
"value": "133"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"use_preferred_name_on_id_card": {
"api_type": "modifiable",
"value": true
}
}
,
"languages": {
"links": {
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"language_code": {
"api_type": "modifiable",
"description": "Spanish",
"domain": "https://api.byu.edu/byuapi/meta/languages",
"key": true,
"long_description": "Spanish",
"value": "ES"
}
,
"links": {
"languages__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "DELETE",
"rel": "languages__delete"
}
,
"languages__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "GET",
"rel": "self"
}
,
"languages__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/languages/:language_code",
"method": "PUT",
"rel": "languages__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"native": {
"api_type": "modifiable",
"value": true
}
,
"read_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "M"
}
,
"speak_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "L"
}
,
"translator": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"write_proficiency": {
"api_type": "modifiable",
"domain": [
"H",
"M",
"L",
"N"
]
,
"value": "H"
}
}
]
}
,
"links": {
"persons__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic,addresses,alias_domains,credentials,email_addresses,email_aliases,employee_summary,family_phones,group_memberships,groups_administered,id_card,languages,personal_record,phones,relationships,student_summary,vital_record",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"contact": [
"basic",
"addresses",
"email_addresses",
"family_phones",
"phones"
]
,
"emergency": [
"family_phones",
"relationships"
]
,
"marriott_school": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"vital_record",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary"
]
,
"official": [
"credentials",
"vital_record",
"personal_record",
"id_card"
]
}
,
"field_sets_available": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"field_sets_default": [
"basic"
]
,
"field_sets_returned": [
"basic",
"addresses",
"credentials",
"email_addresses",
"employee_summary",
"family_phones",
"group_memberships",
"groups_administered",
"id_card",
"languages",
"personal_record",
"phones",
"relationships",
"student_summary",
"vital_record"
]
,
"restricted": false,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"personal_record": {
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"date_of_birth": {
"api_type": "modifiable",
"value": ""
}
,
"date_of_death": {
"api_type": "modifiable",
"value": "2018-06-13"
}
,
"deceased": {
"api_type": "modifiable",
"value": true
}
,
"lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"links": {
"personal_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "GET",
"rel": "self"
}
,
"personal_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"method": "PUT",
"rel": "self"
}
}
,
"marital_status": {
"api_type": "modifiable",
"description": "",
"domain": [
"W",
"M",
"?",
"D",
"S"
]
,
"value": ""
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"parent_lds_unit_number": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/lds_units",
"value": ""
}
,
"religion_code": {
"api_type": "modifiable",
"description": "",
"value": ""
}
,
"sex": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
,
"phones": {
"links": {
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"cell_flag": {
"api_type": "modifiable",
"value": true
}
,
"country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"country_number": {
"api_type": "related",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"phones__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "DELETE",
"rel": "phones__delete"
}
,
"phones__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "GET",
"rel": "self"
}
,
"phones__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/:lookup_number",
"method": "PUT",
"rel": "phones__modify"
}
}
,
"lookup_number": {
"api_type": "modifiable",
"key": true,
"value": "1"
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"phone_number": {
"api_type": "modifiable",
"value": ""
}
,
"primary_flag": {
"api_type": "modifiable",
"value": true
}
,
"texts_okay": {
"api_type": "modifiable",
"value": true
}
,
"time_code": {
"api_type": "modifiable",
"domain": "https://api.byu.edu/byuapi/meta/time_codes",
"value": ""
}
,
"tty": {
"api_type": "modifiable",
"value": false
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"work_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
,
"relationships": {
"links": {
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"relationships__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "DELETE",
"rel": "relationships__delete"
}
,
"relationships__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "GET",
"rel": "self"
}
,
"relationships__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/relationships/:related_byu_id",
"method": "PUT",
"rel": "relationships__modify"
}
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"related_byu_id": {
"api_type": "read-only",
"key": true,
"value": ""
}
,
"related_name_fnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_name_lnf": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_first_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_preferred_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_rest_of_name": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"related_surname": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/:related_byu_id",
"value": ""
}
,
"relationship_type": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_by_byu_id": {
"api_type": "system",
"description": "",
"value": ""
}
,
"verified_datetime": {
"api_type": "system",
"value": "2018-06-13T14:20:00.000Z"
}
}
]
}
,
"student_summary": {
"attended_byu": {
"api_type": "derived",
"value": true
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"current_student": {
"api_type": "related",
"value": ""
}
,
"eligible_to_register": {
"api_type": "related",
"value": ""
}
,
"links": {
"student_summary__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/:byu_id/student_summary",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"student_status": {
"api_type": "related",
"value": ""
}
}
,
"vital_record": {
"birth_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"citizenship_country_code": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/countries",
"value": ""
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"i20_expiration_date": {
"api_type": "modifiable",
"value": ""
}
,
"links": {
"vital_record__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "GET",
"rel": "self"
}
,
"vital_record__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/vital_record",
"method": "PUT",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/123456789/credentials/NET_ID,:net_id",
"value": ""
}
,
"ssn": {
"api_type": "modifiable",
"value": ""
}
,
"ssn_verification_date": {
"api_type": "modifiable",
"value": ""
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"visa_type": {
"api_type": "modifiable",
"value": ""
}
,
"visa_type_source": {
"api_type": "modifiable",
"value": ""
}
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Persons

PUT /{byu_id}

Tags: persons

Modifies the Person with specified BYU ID

Uses default content-types: application/json

The person data to be updated

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$

Uses default content-types: application/json

200 OK

Person successfully updated

Example for application/json
{
"byu_id": {
"api_type": "system",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"deceased": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/personal_record",
"value": false
}
,
"first_name": {
"api_type": "modifiable",
"value": "Abernathy"
}
,
"high_school_city": {
"api_type": "derived",
"value": "Cypress"
}
,
"high_school_code": {
"api_type": "modifiable",
"description": "Cypress High School",
"domain": "https://api.byu.edu/byuapi/meta/high_schools/v1",
"value": "050714"
}
,
"high_school_state_code": {
"api_type": "derived",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"home_state_code": {
"api_type": "modifiable",
"description": "California",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "CA"
}
,
"home_town": {
"api_type": "modifiable",
"value": "Cypress"
}
,
"links": {
"basic__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "DELETE",
"rel": "persons__delete"
}
,
"basic__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789?field_sets=basic",
"method": "GET",
"rel": "self"
}
,
"basic__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789",
"method": "PUT",
"rel": "persons__modify"
}
}
,
"merge_in_process": {
"api_type": "derived",
"value": false
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"restricted": false,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"middle_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"name_fnf": {
"api_type": "derived",
"value": "Abernathy Cosmo Cougar-Rodriguez II"
}
,
"name_lnf": {
"api_type": "derived",
"value": "Cougar-Rodriguez, Abernathy Cosmo, II"
}
,
"net_id": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"value": "cosmo5"
}
,
"person_id": {
"api_type": "system",
"value": "987654321"
}
,
"personal_email_address": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/email_addresses/PERSONAL",
"value": "cosmo5@byu.edu"
}
,
"preferred_first_name": {
"api_type": "modifiable",
"value": "Cosmo"
}
,
"preferred_name": {
"api_type": "derived",
"value": "Cosmo Cougar"
}
,
"preferred_surname": {
"api_type": "modifiable",
"value": "Cougar"
}
,
"primary_phone_number": {
"api_type": "related",
"related_resource": "https://api.byu.edu/byuapi/persons/v3/123456789/phones/8014224000",
"value": "8014224000"
}
,
"rest_of_name": {
"api_type": "derived",
"value": "Abernathy Cosmo"
}
,
"restricted": {
"api_type": "modifiable",
"value": false
}
,
"sex": {
"api_type": "modifiable",
"value": "M"
}
,
"suffix": {
"api_type": "modifiable",
"value": "II"
}
,
"surname": {
"api_type": "modifiable",
"value": "Cougar-Rodriguez"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Addresses

GET /{byu_id}/addresses

Tags: addresses

Returns all addresses for the BYU ID

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$

Uses default content-types: application/json

200 OK

Addresses successfully returned

Example for application/json
{
"links": {
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Addresses

DELETE /{byu_id}/addresses/{address_type}

Tags: addresses

Deletes the address for the BYU ID/address_type

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$
address_type

The type of address

path string , x ∈ { MAL , PRM , RES , WRK }

Uses default content-types: application/json

204 No Content

Address successfully deleted

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Addresses

GET /{byu_id}/addresses/{address_type}

Tags: addresses

Returns the address for the specified BYU ID and address type

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$
address_type

The type of address

path string , x ∈ { MAL , PRM , RES , WRK }

Uses default content-types: application/json

200 OK

Address successfully returned

Example for application/json
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Addresses

PUT /{byu_id}/addresses/{address_type}

Tags: addresses

Modifies or creates an address for the specified BYU ID and address_type

Uses default content-types: application/json

The address values to be set

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$
address_type

The type of address

path string , x ∈ { MAL , PRM , RES , WRK }

Uses default content-types: application/json

200 OK

Address successfully updated

Example for application/json
{
"address_line_1": {
"api_type": "modifiable",
"value": "1234 Milky Way"
}
,
"address_line_2": {
"api_type": "modifiable",
"value": "Orem, UT 84062"
}
,
"address_line_3": {
"api_type": "modifiable",
"value": " "
}
,
"address_line_4": {
"api_type": "modifiable",
"value": " "
}
,
"address_type": {
"api_type": "modifiable",
"domain": [
"RES",
"MAL",
"WRK",
"PRM"
]
,
"key": true,
"value": "MAL"
}
,
"building": {
"api_type": "modifiable",
"description": "",
"domain": "https://api.byu.edu/byuapi/meta/buildings/v1",
"long_description": "",
"value": " "
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"city": {
"api_type": "modifiable",
"value": "Orem"
}
,
"country_code": {
"api_type": "modifiable",
"description": "United States of America",
"domain": "https://api.byu.edu/byuapi/meta/countries/v1",
"value": "USA"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"links": {
"addresses__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"addresses__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "GET",
"rel": "self"
}
,
"addresses__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/addresses/MAL",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"postal_code": {
"api_type": "modifiable",
"value": "84062"
}
,
"room": {
"api_type": "modifiable",
"value": " "
}
,
"state_code": {
"api_type": "modifiable",
"description": "Utah",
"domain": "https://api.byu.edu/byuapi/meta/states/v1",
"value": "UT"
}
,
"unlisted": {
"api_type": "modifiable",
"value": false
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"verified_flag": {
"api_type": "modifiable",
"value": true
}
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Alias domains

GET /{byu_id}/alias_domains

Tags: alias_domains

Returns all alias domains for the BYU ID

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$

Uses default content-types: application/json

200 OK

Alias domains successfully returned

Example for application/json
{
"links": {
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"alias_domain": {
"api_type": "system",
"key": true,
"value": "@byu.edu"
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"limit": {
"api_type": "system",
"value": 25
}
,
"links": {
"alias_domains__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "DELETE",
"rel": "addresses__delete"
}
,
"alias_domains__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "GET",
"rel": "self"
}
,
"alias_domains__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/alias_domains/@byu.edu",
"method": "PUT",
"rel": "addresses__modify"
}
}
,
"metadata": {
"collection_size": 1,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"quantity": {
"api_type": "derived",
"value": 4
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error

Credentials

GET /{byu_id}/credentials

Tags: credentials

Returns all credentials for the BYU ID

byu_id

The person's BYU ID

path string , must match ^[0-9]{9}$
credential_type

One of the credential types available through the meta/credential_type service.

query string , x ∈ { BYU_HAWAII_ID , BYU_IDAHO_ID , FACEBOOK_ID , GOOGLE_ID , ID_CARD , LDS_ACCOUNT_ID , LDS_CMIS_ID , NET_ID , PROX_CARD , SEMINARY_STUDENT_ID , SEOS_CARD , WSO2_CLIENT_ID }

Uses default content-types: application/json

200 OK

Credentials successfully returned

Example for application/json
{
"links": {
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-19T19:53:21.123Z"
}
,
"collection_size": 1,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_information": [
"Success"
]
,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"values": [
{
"associated_device": {
"api_type": "modifiable",
"value": ""
}
,
"byu_id": {
"api_type": "system",
"description": "Cosmo Cougar",
"key": true,
"value": "123456789"
}
,
"created_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"created_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"credential_id": {
"api_type": "read-only",
"key": true,
"value": "cosmo5"
}
,
"credential_type": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/credential_types/v1",
"key": true,
"value": "NET_ID"
}
,
"expiration_date": {
"api_type": "modifiable",
"value": "2018-09-09"
}
,
"issuing_location": {
"api_type": "read-only",
"domain": "https://api.byu.edu/byuapi/meta/issuing_locations/v1",
"value": "133"
}
,
"links": {
"credentials__delete": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "DELETE",
"rel": "credentials__delete"
}
,
"credentials__info": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "GET",
"rel": "self"
}
,
"credentials__modify": {
"href": "https://api.byu.edu/byuapi/persons/v3/123456789/credentials/NET_ID,cosmo5",
"method": "PUT",
"rel": "credentials__modify"
}
}
,
"lost_or_stolen": {
"api_type": "modifiable",
"value": false
}
,
"metadata": {
"collection_size": 0,
"default_db": [
"ces"
]
,
"default_page_size": 20,
"max_page_size": 20,
"page_end": 1,
"page_size": 20,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
}
,
"physical_form": {
"api_type": "modifiable",
"value": ""
}
,
"scoped_affiliation": {
"api_type": "modifiable",
"value": "BYU Provo Student"
}
,
"status": {
"api_type": "modifiable",
"value": "ACTIVE"
}
,
"updated_by_byu_id": {
"api_type": "system",
"description": "John Bench",
"value": "023296921"
}
,
"updated_datetime": {
"api_type": "system",
"value": "2017-09-09T19:15:22.123Z"
}
,
"user_name": {
"api_type": "modifiable",
"value": " "
}
}
]
}
400 Bad Request #/responses/400

Invalid Request - unable to interpret request

401 Unauthorized #/responses/401

Authentication required to access data

403 Forbidden #/responses/403

Access denied to protected data

404 Not Found #/responses/404

The resource does not exist

409 Conflict #/responses/409

Query parameters conflict or are malformed

500 Internal Server Error #/responses/500

Internal Server Error - Error occurred that wasn't the user's fault

503 Service Unavailable #/responses/503

Service Unavailable - Under construction

504 Gateway Timeout #/responses/504

Gateway Timeout

default #/responses/default

Unexpected error