# `Orcid`

A researcher's ORCID iD: `0000-0002-1825-0097`.

Use it to identify a researcher. For their paper, use [`Doi`](/docs/types/type-doi.md).

## Shape

One value, held as text in one set form, with no parts: `0000-0002-1694-233X`.

## Example

```jadpo
Orcid("0000-0002-1825-0097")
```

`Orcid(raw)` checks the text, and text that isn't one breaks the `format` rule.

`text.parse(raw, as: Orcid)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `0000-0002-1825-0098`, `0000000218250097` or `https://orcid.org/0000-0002-1825-0097`.

## Good to know

- It keeps its hyphens, and it checks its own last character.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.
- A field that holds one counts as personal data (`identifying`), so you don't mark it yourself.

## In JSON

A string, in a request, a response or `json.write`:

```json
"0000-0002-1825-0097"
"0000-0001-5109-3700"
"0000-0002-1694-233X"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`Orcid` is in the group Other with a published standard, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `0000-0002-1825-0097`, `0000-0001-5109-3700` and `0000-0002-1694-233X`.

### How it is stored

It is stored in one column named for the field, of type `text`. `0000-0001-5109-3700` is stored as `'0000-0001-5109-3700'`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `0000-0002-1825-0097` | `0000-0002-1825-0097` |
| `0000-0001-5109-3700` | `0000-0001-5109-3700` |
| `0000-0002-1694-233X` | `0000-0002-1694-233X` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>