IdentityPersonPROPersonBio
PersonBioService
Base URL: /domains/legacy/identity/person/PRO/personbio
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{person_id}* | GET | Gets biographical information about a person |
PUT | Update a person's biographical info. |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
Gets biographical information about a person
person_id | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"PersonBioService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"ethnicity_info": {
"ethnicity_list": [
{
"code": "AMI",
"is_set": false,
"value": "American Indian/Alaskan Native"
},
{
"code": "ASN",
"is_set": false,
"value": "Asian/Asian-American"
},
{
"code": "BLK",
"is_set": false,
"value": "Black/African-American"
},
{
"code": "HAW",
"is_set": false,
"value": "Hawaiian/Part Hawaiian"
},
{
"code": "HIS",
"is_set": false,
"value": "Hispanic-Latino"
},
{
"code": "PAC",
"is_set": false,
"value": "Pacific Islander"
},
{
"code": "WHI",
"is_set": true,
"value": "White"
}
],
"is_hispanic": false
},
"home_town": {
"home_country_code": "USA",
"home_state_code": "UT",
"home_town": "Bountiful",
"hometown_desc": "Bountiful, Utah"
},
"person_summary_line": {
"academic_record": true,
"byu_id": "987654321",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Doe, John Albert",
"net_id": "johnd",
"non_person_organization": false,
"person_id": "123456789",
"registrar_warning": false,
"restricted": false,
"student_role": "Junior"
},
"personal_info": {
"birth_country": "United States of America",
"birth_country_code": "USA",
"citizenship_country": "United States of America",
"citizenship_country_code": "USA",
"date_of_birth": "1996-01-31",
"date_of_death": "",
"gender": "M",
"marital_status": "S",
"marital_status_description": "Single",
"religion": "Latter-day Saint",
"religion_code": "LDS",
"ward_lds_unit_code": "0012345"
},
"update_field_set": {
"birth_country": "Y",
"ethnicity": "Y",
"home_country": "Y",
"home_state_province": "Y",
"home_town": "Y",
"marital_status": "N"
}
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Update a person's biographical info.
person_id | string -> | path | string | |
date_of_birth | string -> YYYY-MM-DD | query | string | |
date_of_death | string -> YYYY-MM-DD | query | string | |
birth_country | Birth country | query | string | |
citizenship_country | Country person is citizen of | query | string | |
gender | Gender | query | string , x ∈ { M , F } | |
marital_status | marital status | query | string , x ∈ { S , M , W , D } | |
religion | Religion | query | string | |
home_country | Home country | query | string | |
home_state | Home state | query | string | |
home_town | Home town | query | string | |
restricted | Is information restricted | query | string | |
ethnicity | Ethnicity | query | string | |
primary_ethnicity | Primary ethnicity | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Schema definitions
- WebService: object
-
- name: string
-
- operations: operations
-
- errors: errors
-
- httpStatusCodes: httpStatusCodes
-
- is_hispanic: boolean
-
- ethnicity_list: object[]
-
object - code: string
-
- is_set: boolean
-
- value: string
-
- home_country_code: string
-
- home_state_code: string
-
- home_town: string
-
- hometown_desc: string
-
- name: string
-
- description: string
-
- method: string
-
- path: string
-
- path_identifiers: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- query_attributes: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- required: string
-
- name: string
-
- net_id: string
-
- byu_id: string
-
- person_id: string
-
- student_role: string
-
- employee_role: string
-
- academic_record: boolean
-
- is_employee: boolean
-
- non_person_organization: boolean
-
- restricted: boolean
-
- deceased: boolean
-
- merge_pending: boolean
-
- registrar_warning: boolean
-
- date_of_birth: string
-
- date_of_death: string
-
- gender: string
-
- marital_status: string
-
- marital_status_description: string
-
- ward_lds_unit_code: string
-
- religion_code: string
-
- religion: string
-
- birth_country_code: string
-
- birth_country: string
-
- citizenship_country_code: string
-
- citizenship_country: string
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: integer
-
- statusMessage: string
-
- person_summary_line: person_summary_line
-
- update_field_set: update_field_set
-
- personal_info: personal_info
-
- home_town: home_town
-
- ethnicity_info: ethnicity_info
-