institutions

A record representing an Institution
type:object
Required:_collections

Properties: $schema, ICN, _bucket, _collections, _private_notes, addresses, control_number, core, deleted, deleted_records, external_system_identifiers, extra_words, historical_data, inactive, inspire_categories, institution_hierarchy, institution_type, legacy_ICN, legacy_creation_date, legacy_version, name_variants, new_record, public_notes, related_records, self, urls

$schema

type:string
format:uri
minLength:1

ICN

List of affiliation identifiers
MARC:110__t

HEP affiliation unique identifier following the general pattern institution name, city, department. This was called the “new ICN” on legacy.

Note

This is a list in case the ICN needs to be updated because of a mistake in its assignment. The current one is the first element of the list.

type:array
minItems:1
Every element of ICN is:
type:string
minLength:1

_bucket

Used by invenio-records-files to store information about the bucket attached to this record.

Note

This field is maintained by invenio-records-files and should not be edited manually.

type:string
minLength:1

_collections

Collections to which this record belongs
type:array
minItems:1
Every element of _collections is:
type:string
minLength:1

Allowed values:

  • Institutions

_private_notes

List of private notes
MARC:595, 667

These notes are only visible to privileged users, not regular users.

type:array
minItems:1
Every element of _private_notes is:
Reference:sourced_value

addresses

List of addresses
MARC:371 (secondary addresses contain an x subfield)

The primary address is the first in the list, the secondary addresses, if present, come next. This might happen for instance for institutions distributed on several campuses.

type:array
minItems:1
Every element of addresses is:
Reference:address

control_number

ID of current record
MARC:001

Read-only field. Also called record ID or recid.

type:integer

core

Whether this institution is CORE
MARC:980:CORE corresponds to true.
type:boolean

deleted

Whether this record has been deleted
MARC:980__a/c:deleted
type:boolean

deleted_records

MARC:981__a

List of records that were deleted because they were replaced by this one. This typically happens when merging two records: one of them gets enriched with the information of the other one, which is then superfluous and gets deleted.

For the opposite concept, see new_record.

type:array
minItems:1
Every element of deleted_records is:
Reference:institution

external_system_identifiers

MARC:035, 970

List of identifiers of this institution on external systems.

type:array
minItems:1
Every element of external_system_identifiers is:

May satisfy any of the following definitions:

GRID identifier

type:object
Required:schema, value

Properties: schema, value

schema

MARC:035__9:GRID
type:string
minLength:1

Allowed values:

  • GRID

value

MARC:035__a
type:string
pattern:^grid\.\d+\.\w+$
minLength:1

HAL identifier

type:object
Required:schema, value

Properties: schema, value

schema

MARC:035__9:HAL
type:string
minLength:1

Allowed values:

  • HAL

value

MARC:035__a
type:string
pattern:^\d+$
minLength:1

ROR identifier

type:object
Required:schema, value

Properties: schema, value

schema

MARC:035__9:ROR
type:string
minLength:1

Allowed values:

  • ROR

value

MARC:035__a
type:string
pattern:^https://ror\.org/0\w{6}\d{2}$
minLength:1

SPIRES identifier

type:object
Required:schema, value

Properties: schema, value

schema

type:string
minLength:1

Allowed values:

  • SPIRES

value

MARC:970__a
type:string
pattern:^INST-\d+$
minLength:1

extra_words

Extra words
MARC:410__g

Contains extra words that might be used when searching for this record, but that are not contained in the other visible metadata.

type:array
minItems:1
Every element of extra_words is:
type:string
minLength:1

historical_data

Historical information about institution
MARC:6781_a
type:array
minItems:1
Every element of historical_data is:
type:string
minLength:1

inactive

MARC:980:DEAD corresponds to true

Whether this institution is not active any more, and hence authors of recent articles cannot have it as an affiliation.

type:boolean

inspire_categories

List of Inspire categories
type:array
minItems:1
Every element of inspire_categories is:
Reference:inspire_field

institution_hierarchy

MARC:110__a/b

This record can represent a department, or a group within a department, as opposed to a complete institution. To represent that fact, this field contains the names and acronyms of the specific institution that this record represents, followed by its parents, from most specific to least specific.

example:
[
    {
        "name": "Stanford Synchrotron Radiation Lightsource",
        "acronym": "SSRL"
    },
    {
        "name": "SLAC National Accelerator Laboratory",
        "acronym": "SLAC"
    }
]
type:

array

minItems:

1

Every element of institution_hierarchy is:
type:object

Properties: acronym, name

acronym

MARC:in parenthesis at the end of 110_a/b
type:string
minLength:1

name

MARC:value in 110_a/b, excluding final parenthesis
type:string
minLength:1

institution_type

MARC:372__a
type:array
minItems:1
Every element of institution_type is:
type:string
minLength:1

Allowed values:

  • University
  • Research Center
  • Company
  • Other

legacy_ICN

MARC:110__u

This was called simply “ICN” on legacy.

type:string
minLength:1

legacy_creation_date

Date of record creation on legacy
MARC:961__x

Only present if the record already existed on legacy Inspire.

type:string
format:date
minLength:1

legacy_version

Last record update
MARC:005

Used to indicate the version of the record on legacy.

type:string
minLength:1

name_variants

MARC:410__a

Variants of the institution name. This is used when alternative names are in common use, possibly in English when the official name is not.

type:array
minItems:1
Every element of name_variants is:
Reference:sourced_value

new_record

Record replacing this one
MARC:970__d

Contains a reference to the record replacing the current one, if it is marked as deleted.

Reference:institution

public_notes

List of public notes
MARC:680

Any notes about the document that do not fit into another field. For arXiv eprints, also contains the contents of the comment field on arXiv.

Note

These notes are publicly visible. For notes not shown to regular users, see _private_notes.

type:array
minItems:1
Every element of public_notes is:
Reference:sourced_value

self

Reference:institution

urls

type:array
minItems:1
Every element of urls is:
Reference:url