Names

This REST service is used to query and maintain your preferred name, the order you would like your name to appear in the university's system, and how you would like it to appear on your ID card.

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

Base URL: /domains/legacy/names

Version: v1

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

Summary

Path Operation Description
/{person-id_parms} GET

Get Or Update Names

Paths

Get Or Update Names

GET /{person-id_parms}

Tags: NamesService

Get Or Update Names

person-id_parms

personid

path string

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

200 OK

Service request is OK and a response has been generated.

204 No Content

No content. The service call has completed successfully. Empty response body.

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.

405 Method Not Allowed

The service method is not supported by the service.

415 Unsupported Media Type

Unsupported Media Type. Called with the wrong or missing a content-type HTTP header.

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

personId: object

personNameService: object
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
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
note: string
request: object
method: string
resource: string
attributes: string
status: string
response: object
sort_name: string
surname: string
rest_of_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/names
Domain or University API: 
/domains/D/names

Community

 

Don't see your question listed here? Ask!