View Source ROR.Admin (ROR v0.1.0)

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

The admin struct is not the same as the original ROR data: it's flatter, with only one level of fields.

Summary

Types

t()

Functions

extract(data)

Extracts an Admin struct from the decoded JSON of a ROR Organization record

Types

t()

@type t() :: %ROR.Admin{
  created_at: Date.t(),
  created_schema: binary(),
  updated_at: Date.t(),
  updated_schema: binary()
}

Functions

extract(data)

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

Extracts an Admin struct 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.Admin.extract(record)
%ROR.Admin{
  created_at: ~D[2020-04-25],
  created_schema: "1.0",
  updated_at: ~D[2022-10-18],
  updated_schema: "2.0"
}