View Source ROR.ExternalID (ROR v0.1.0)

Functions for extracting and using ExternalID data from a ROR Organization record

Summary

Types

t()

Functions

extract(data)

Extracts a list of ExternalID structs from the decoded JSON of a ROR Organization record

vocab()

Lists the allowed terms or types for this data structure, as atoms.

Types

t()

@type t() :: %ROR.ExternalID{all: [binary()], preferred: boolean(), type: atom()}

Functions

extract(data)

@spec extract(data :: map()) :: [t()]

Extracts a list of ExternalID structs from the decoded JSON of a ROR Organization record

If you are retrieving records via the ROR module and the REST API you will not need to use this function yourself.

Example

iex> record = File.read!("test/support/static/example_org.json") |> Jason.decode!()
...> ROR.ExternalID.extract(record)
[
  %ROR.ExternalID{
    type: :fundref,
    preferred: "100005595",
    all: ["100005595", "100009350", "100004802", "100010574", "100005188", "100005192"]
  },
  %ROR.ExternalID{
    type: :grid,
    preferred: "grid.30389.31",
    all: ["grid.30389.31"]
  },
  %ROR.ExternalID{type: :isni, preferred: nil, all: ["0000 0001 2348 0690"]}
]

vocab()

@spec vocab() :: [atom()]

Lists the allowed terms or types for this data structure, as atoms.