View Source ROR.Organization (ROR v0.1.0)

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

Summary

Functions

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

Returns the full ID from an Organization

Returns the ID from an Organization

Types

t()

@type t() :: %ROR.Organization{
  admin: ROR.Admin.t(),
  domains: [binary()],
  established: integer(),
  external_ids: [ROR.ExternalID.t()],
  id: binary(),
  links: [ROR.Link.t()],
  locations: [ROR.Location.t()],
  names: [ROR.Name.t()],
  relationships: [ROR.Relationship.t()],
  status: atom(),
  types: [atom()]
}

Functions

extract(data)

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

Extracts an Organization 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(12)> ROR.Organization.extract(record)
%ROR.Organization{
  id: "https://ror.org/00pjdza24",
  admin: %ROR.Admin{
    created_at: ~D[2020-04-25],
    created_schema: "1.0",
    updated_at: ~D[2022-10-18],
    updated_schema: "2.0"
  },
  domains: ["universityofcalifornia.edu"],
  established: 1868,
  external_ids: [
    %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"]}
  ],
  links: [
    %ROR.Link{type: :website, value: "http://www.universityofcalifornia.edu/"},
    %ROR.Link{
      type: :wikipedia,
      value: "http://en.wikipedia.org/wiki/University_of_California"
    }
  ],
  locations: [
    %ROR.Location{
      type: :geonames,
      id: 5_378_538,
      continent_name: nil,
      continent_code: nil,
      country_code: "US",
      country_name: "United States",
      country_subdivision_code: nil,
      country_subdivision_name: nil,
      latitude: 37.802168,
      longitude: -122.271281,
      name: "Oakland"
    }
  ],
  names: [
    %ROR.Name{lang: "en", types: [:acronym], value: "UC"},
    %ROR.Name{lang: "en", types: [:alias], value: "UC System"},
    %ROR.Name{
      lang: "en",
      types: [:ror_display, :label],
      value: "University of California System"
    },
    %ROR.Name{lang: "fr", types: [:label], value: "Université de Californie"}
  ],
  relationships: [
    %ROR.Relationship{
      id: "https://ror.org/02jbv0t02",
      label: "Lawrence Berkeley National Laboratory",
      type: :related
    },
    %ROR.Relationship{
      id: "https://ror.org/03yrm5c26",
      label: "California Digital Library",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/00zv0wd17",
      label: "Center for Information Technology Research in the Interest of Society",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/03t0t6y08",
      label: "University of California Division of Agriculture and Natural Resources",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/01an7q238",
      label: "University of California, Berkeley",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/05rrcem69",
      label: "University of California, Davis",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/04gyf1771",
      label: "University of California, Irvine",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/046rm7j60",
      label: "University of California, Los Angeles",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/00d9ah105",
      label: "University of California, Merced",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/03nawhv43",
      label: "University of California, Riverside",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/0168r3w48",
      label: "University of California, San Diego",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/043mz5j54",
      label: "University of California, San Francisco",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/02t274463",
      label: "University of California, Santa Barbara",
      type: :child
    },
    %ROR.Relationship{
      id: "https://ror.org/03s65by71",
      label: "University of California, Santa Cruz",
      type: :child
    }
  ],
  status: :active,
  types: [:education]
}

full_id(org)

@spec full_id(org :: t()) :: binary()

Returns the full ID from an Organization

id(org)

@spec id(org :: t()) :: binary()

Returns the ID from an Organization