IdentityPersonPersonNames

PersonNamesService

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

Base URL: /domains/legacy/identity/person/personnames/v1

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id_net_id} GET

Retrieve a person's names.

PUT

Update a person's names.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Retrieve a person's names.

GET /{person_id_net_id}

Tags: PersonNamesService

Retrieve a person's names.

person_id_net_id

string -> person_id or net_id

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Names Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd",
"status": "200"
}
,
"resource": {
"URI": "/[personid|netid]",
"attributes": {
"preferred_first_name": {
"description": "A name of individual choice",
"required": false
}
,
"rest_of_name": {
"description": "Given name or names",
"required": false
}
,
"suffix": {
"conditions": "Must be a defined value in the provided suffix table set",
"description": "Name suffix such as Jr, Sr, II, etc...",
"required": false
}
,
"surname": {
"description": "Often the family name of the individual or last name",
"required": false
}
,
"surname_first": {
"description": "A boolean indicator. If true (any non null value) indicates that the surname is read first instead of last. A null value or false will indicate that the surname is to be read last. If omitted no change will be made to the surname position setting.",
"required": false
}
,
"use_preferred_on_id_card": {
"description": "A boolean indicator. If true (any non null value) indicates that the preferred first name is to be printed on the ID card of the individual. A null value or false will indicate that the given names, defined by the rest_of_name attribute, are to be printed on the ID card of the individual. If omitted no change will be made to the ID card name setting.",
"required": false
}
}
,
"examples": [
"/",
"/123456789",
"/byu999"
]
,
"identifiers": [
{
"personid": {
"default": "Identifier of authenticated individual",
"description": "Unique identifier of an individual",
"required": false
}
},
{
"netid": {
"description": "Online account or network identifier of an individual",
"required": false
}
}
]
,
"methods": {
"adaptations": [
{
"PUT": [
"Tunnel through a GET with attributes in the query string name value pairs",
"Tunnel through a POST with attributes in POST content name values pairs"
]
}
]
,
"options": [
"GET",
"PUT"
]
}
,
"note": "If an attribute is not present in the PUT request, the current value in the database will be retained. That is to say only the values that need changed need be present in the PUT request. Examples: /[personid]?surname=Young, /[personid/preferred_first_name=Brigham, /[personid]?surname=Young&rest_of_name=Brigham&preferred_first_name=Brigham&surname_first=true"
}
,
"response": {
"byu_id_card_name": "John Albert Doe",
"first_name": "John",
"middle_name": "Albert",
"preferred_first_name": "John",
"rest_of_name": "John Albert",
"sort_name": "Doe, John Albert",
"suffix": "",
"suffix_table": [
"",
"Jr",
"Sr",
"I",
"II",
"III",
"IV",
"V",
"VI",
"VII"
]
,
"surname": "Doe",
"surname_first": false,
"update_field_set": [
""
]
,
"warnings": [
"Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know",
"No update is allowed."
]
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Update a person's names.

PUT /{person_id_net_id}

Tags: PersonNamesService

Update a person's names.

person_id_net_id

string -> person_id or net_id

path string

Uses default content-types: application/json

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.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

documentation: object

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

errors: object[]

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

httpStatusCodes: object[]

object
code: integer
message: string

NamesService: object

Person Names Service: object
resource: resource
request: request
response: response

operations: object[]

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

request: object

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

resource: object

methods: object
options: string[]
string
adaptations: object[]
object
PUT: string[]
string
URI: string
examples: string[]
string
identifiers: object[]
object
personid: object
description: string
required: boolean
default: string
netid: object
description: string
required: boolean
attributes: object
surname: object
description: string
required: boolean
rest_of_name: object
description: string
required: boolean
surname_first: object
description: string
required: boolean
preferred_first_name: object
description: string
required: boolean
use_preferred_on_id_card: object
description: string
required: boolean
suffix: object
description: string
required: boolean
conditions: string
note: string

response: object

sort_name: string
surname: string
rest_of_name: string
first_name: string
middle_name: string
surname_first: boolean
suffix: string
suffix_table: string[]
string
preferred_first_name: string
byu_id_card_name: string
warnings: string[]
string
update_field_set: string[]
string
Service Path: 
/domains/legacy/identity/person/personnames/v1
Domain or University API: 
/domains/D/identity/person/personnames/v1

Community

 

Don't see your question listed here? Ask!