PersonName

A person's name: a given name and, if they have one, a family name.

Use it wherever you store or show what someone is called, such as a customer on an order or the person a letter is addressed to. It keeps the two parts apart, so text.format can write them in the order the reader's language expects. For the name someone signs in with, use Username. For one part on its own, use GivenName or FamilyName. Any of the three is personal data with no personal: on the field: it counts as PersonalData.identifying.

Shape

Write every field when you build one, and give a field that isn't required as none.

Example

PersonName { given: "Mary" family: "Somerville" }

Good to know

• Some people have only one name, as Sukarno did. Give it as given, with family: none.
• It has no single text form, so text.from won't take it. Show it with text.format(name, locale: locale), which gives "Mary Somerville" in English and puts the family name first in Japanese.
• == tells you whether two are the same. < and list.sort_by don't take it, so sort by one of its parts instead.
• A field that holds one counts as personal data (identifying), so you don't mark it yourself.

In JSON

An object of its parts, in a request, a response or json.write:

{"given":"Mary","family":"Somerville"}{"given":"Sukarno","family":null}

When you read one, a field that isn't required may be left out, or sent as null.

Details