View Source ROR.Status (ROR v0.1.0)

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

An Organization's status is one of three atoms: :active, :inactive and :withdrawn

By default only :active Organizations are returned by the ROR API.

Summary

Functions

Extracts the status from the decoded JSON of a ROR Organization record

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

Functions

extract(data)

@spec extract(data :: map()) :: atom()

Extracts the status 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.Status.extract(record)
:active

vocab()

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

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