IdentityPersonPROPersonNames

PersonNamesService

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id}* GET

Get person name

PUT

Update a person's names.

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Get person name

GET /{person_id}*

Tags: PersonNamesService

Get person name

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
{
"PersonNamesService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"official_name": {
"first_name": "John",
"middle_name": "Albert",
"rest_of_name": "John Albert",
"sort_name": "Doe, John Albert",
"surname": "Doe",
"surname_position": "L"
}
,
"preferred_name": {
"preferred_first_name": "John",
"use_preferred_name_on_id_card": false
}
}
}
}
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 names.

PUT /{person_id}*

Tags: PersonNamesService

Update a person's names.

person_id

string ->

path string
sort_name

Sort name

query string
rest_of_name

Rest of name

query string
surname

Surname

query string
surname_first

First surname

query string
suffix

Suffix

query string , x ∈ { Jr , Sr , II , III , IV , V , VI , VII }
preferred_first_name

Preferred first name

query string
use_preferred_on_id_card

Use your preferred ID card

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

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

PersonNamesService: object
request: request
response: response

official_name: object

sort_name: string
surname: string
rest_of_name: string
first_name: string
middle_name: string
surname_position: string

operations: object[]

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

preferred_name: object

preferred_first_name: string
use_preferred_name_on_id_card: boolean

request: object

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

response: object

official_name: official_name
preferred_name: preferred_name
Service Path: 
/domains/legacy/identity/person/PRO/personnames
Domain or University API: 
/domains/D/identity/person/PRO/personnames

Community

 

Don't see your question listed here? Ask!