Segments

Prototype: This resource is currently in a prototype development state. It may or may not be operational and the interface may change prior to release. Feedback is welcome.

Description

The names segments resource is used to read the various segments of a name.

Operations

GET - Segment a full name into its parts.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
fullName query A string representing the name to be parsed. Required.
lang query query parameter to indicate incoming name's language.
locale query query parameter can be used to override the Accept-Language header value if necessary.
Status Codes
  • 200  -  Upon a successful read.
  • 400  -  If there is a problem with the provided name.

POST - Compose a full name from its parts.

Produces - Specify a returned data format using the Accept header.
Consumes - Specify the incoming data format using the Content-Type header.
Parameters
Name Type Description
locale query query parameter can be used to override the Accept-Language header value if necessary.
body request-body The Gedcomx object containing the person with the name to be composed.
Status Codes
  • 200  -  If the name was successfully composed from the provided name parts.
  • 400  -  If there is a problem with the provided data about the name.

Example Requests

Parse Segments How to compose a full name from its parts.
Read name segments How to get a name's segments.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.