Resource | Names |
---|---|
URL | /api/v2/names |
Supported Standard Operations |
|
Attributes
- See names for definitions of other attributes and elements
Attribute | Value | Required? |
---|---|---|
person_id | Person ID | One of person_id or external_identity_id is required |
external_identity_id | External Identity ID | One of person_id or external_identity_id is required |
honorific | Honorific component | |
given | Given name component | Yes |
middle | Middle name component | |
family | Family name component | |
suffix | Suffix component | |
display_name | Display version of this name | |
language | Language encoding for this name | |
primary_name | True if this is the Primary Name |
Sample Record
{ "type_id": 168, "person_id": 25, "external_identity_id": null, "source_name_id": null, "honorific": null, "given": "Test", "middle": "J", "family": "Testington", "suffix": "V", "language": null, "primary_name": true, "display_name": "TJ Testington" }
Supported Filters
Viewing all names without an additional filter is not supported.
View (all)
Additional filters:
external_id
person_id
Example: Obtain Names for the specified Person
GET /registry/api/v2/names?person_id=2400
Implementation Notes
- Permitted and required fields are governed by CO Settings.
- The record is read only if
source_name_id
is not null.