.. _institutions.json#/: institutions ============ .. container:: title A record representing an Institution :type: ``object`` :Required: :ref:`institutions.json#/properties/_collections` **Properties:** :ref:`institutions.json#/properties/$schema`, :ref:`institutions.json#/properties/ICN`, :ref:`institutions.json#/properties/_bucket`, :ref:`institutions.json#/properties/_collections`, :ref:`institutions.json#/properties/_private_notes`, :ref:`institutions.json#/properties/addresses`, :ref:`institutions.json#/properties/control_number`, :ref:`institutions.json#/properties/core`, :ref:`institutions.json#/properties/deleted`, :ref:`institutions.json#/properties/deleted_records`, :ref:`institutions.json#/properties/external_system_identifiers`, :ref:`institutions.json#/properties/extra_words`, :ref:`institutions.json#/properties/historical_data`, :ref:`institutions.json#/properties/inactive`, :ref:`institutions.json#/properties/inspire_categories`, :ref:`institutions.json#/properties/institution_hierarchy`, :ref:`institutions.json#/properties/institution_type`, :ref:`institutions.json#/properties/legacy_ICN`, :ref:`institutions.json#/properties/legacy_creation_date`, :ref:`institutions.json#/properties/legacy_version`, :ref:`institutions.json#/properties/name_variants`, :ref:`institutions.json#/properties/new_record`, :ref:`institutions.json#/properties/public_notes`, :ref:`institutions.json#/properties/related_records`, :ref:`institutions.json#/properties/self`, :ref:`institutions.json#/properties/urls` .. _institutions.json#/properties/$schema: $schema +++++++ :type: ``string`` :format: ``uri`` :minLength: ``1`` .. _institutions.json#/properties/ICN: ICN +++ .. container:: title 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`` .. container:: sub-title Every element of **ICN** is: :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/_bucket: _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`` .. _institutions.json#/properties/_collections: _collections ++++++++++++ .. container:: title Collections to which this record belongs :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_collections** is: :type: ``string`` :minLength: ``1`` **Allowed values:** - Institutions .. _institutions.json#/properties/_private_notes: _private_notes ++++++++++++++ .. container:: title List of private notes :MARC: ``595``, ``667`` These notes are only visible to privileged users, not regular users. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **_private_notes** is: :Reference: :ref:`sourced_value.json#/` .. _institutions.json#/properties/addresses: addresses +++++++++ .. container:: title 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`` .. container:: sub-title Every element of **addresses** is: :Reference: :ref:`address.json#/` .. _institutions.json#/properties/control_number: control_number ++++++++++++++ .. container:: title ID of current record :MARC: ``001`` Read-only field. Also called ``record ID`` or ``recid``. :type: ``integer`` .. _institutions.json#/properties/core: core ++++ .. container:: title Whether this institution is CORE :MARC: ``980:CORE`` corresponds to ``true``. :type: ``boolean`` .. _institutions.json#/properties/deleted: deleted +++++++ .. container:: title Whether this record has been deleted :MARC: ``980__a/c:deleted`` :type: ``boolean`` .. _institutions.json#/properties/deleted_records: 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 :ref:`institutions.json#/properties/new_record`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **deleted_records** is: :Reference: :ref:`institution.json#/` .. _institutions.json#/properties/external_system_identifiers: external_system_identifiers +++++++++++++++++++++++++++ :MARC: ``035``, ``970`` List of identifiers of this institution on external systems. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **external_system_identifiers** is: May satisfy *any* of the following definitions: .. _institutions.json#/properties/external_system_identifiers/items/anyOf/0: GRID identifier ############### :type: ``object`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/0/title: :Required: :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/value` **Properties:** :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/value` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/schema: schema >>>>>> :MARC: ``035__9:GRID`` :type: ``string`` :minLength: ``1`` **Allowed values:** - GRID .. _institutions.json#/properties/external_system_identifiers/items/anyOf/0/properties/value: value >>>>> :MARC: ``035__a`` :type: ``string`` :pattern: ``^grid\.\d+\.\w+$`` :minLength: ``1`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/1: HAL identifier ############## :type: ``object`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/1/title: :Required: :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/value` **Properties:** :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/value` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/schema: schema >>>>>> :MARC: ``035__9:HAL`` :type: ``string`` :minLength: ``1`` **Allowed values:** - HAL .. _institutions.json#/properties/external_system_identifiers/items/anyOf/1/properties/value: value >>>>> :MARC: ``035__a`` :type: ``string`` :pattern: ``^\d+$`` :minLength: ``1`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/2: ROR identifier ############## :type: ``object`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/2/title: :Required: :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/value` **Properties:** :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/value` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/schema: schema >>>>>> :MARC: ``035__9:ROR`` :type: ``string`` :minLength: ``1`` **Allowed values:** - ROR .. _institutions.json#/properties/external_system_identifiers/items/anyOf/2/properties/value: value >>>>> :MARC: ``035__a`` :type: ``string`` :pattern: ``^https://ror\.org/0\w{6}\d{2}$`` :minLength: ``1`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/3: SPIRES identifier ################# :type: ``object`` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/3/title: :Required: :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/value` **Properties:** :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/schema`, :ref:`institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/value` .. _institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/schema: schema >>>>>> :type: ``string`` :minLength: ``1`` **Allowed values:** - SPIRES .. _institutions.json#/properties/external_system_identifiers/items/anyOf/3/properties/value: value >>>>> :MARC: ``970__a`` :type: ``string`` :pattern: ``^INST-\d+$`` :minLength: ``1`` .. _institutions.json#/properties/extra_words: extra_words +++++++++++ .. container:: title 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`` .. container:: sub-title Every element of **extra_words** is: :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/historical_data: historical_data +++++++++++++++ .. container:: title Historical information about institution :MARC: ``6781_a`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **historical_data** is: :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/inactive: 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`` .. _institutions.json#/properties/inspire_categories: inspire_categories ++++++++++++++++++ .. container:: title List of Inspire categories :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **inspire_categories** is: :Reference: :ref:`inspire_field.json#/` .. _institutions.json#/properties/institution_hierarchy: 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: .. code-block:: json [ { "name": "Stanford Synchrotron Radiation Lightsource", "acronym": "SSRL" }, { "name": "SLAC National Accelerator Laboratory", "acronym": "SLAC" } ] :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **institution_hierarchy** is: :type: ``object`` **Properties:** :ref:`institutions.json#/properties/institution_hierarchy/items/properties/acronym`, :ref:`institutions.json#/properties/institution_hierarchy/items/properties/name` .. _institutions.json#/properties/institution_hierarchy/items/properties/acronym: acronym ####### :MARC: in parenthesis at the end of ``110_a/b`` :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/institution_hierarchy/items/properties/name: name #### :MARC: value in ``110_a/b``, excluding final parenthesis :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/institution_type: institution_type ++++++++++++++++ :MARC: ``372__a`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **institution_type** is: :type: ``string`` :minLength: ``1`` **Allowed values:** - University - Research Center - Company - Other .. _institutions.json#/properties/legacy_ICN: legacy_ICN ++++++++++ :MARC: ``110__u`` This was called simply "ICN" on legacy. :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/legacy_creation_date: legacy_creation_date ++++++++++++++++++++ .. container:: title 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`` .. _institutions.json#/properties/legacy_version: legacy_version ++++++++++++++ .. container:: title Last record update :MARC: ``005`` Used to indicate the version of the record on legacy. :type: ``string`` :minLength: ``1`` .. _institutions.json#/properties/name_variants: 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`` .. container:: sub-title Every element of **name_variants** is: :Reference: :ref:`sourced_value.json#/` .. _institutions.json#/properties/new_record: new_record ++++++++++ .. container:: title Record replacing this one :MARC: ``970__d`` Contains a reference to the record replacing the current one, if it is marked as :ref:`institutions.json#/properties/deleted`. :Reference: :ref:`institution.json#/` .. _institutions.json#/properties/public_notes: public_notes ++++++++++++ .. container:: title 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 :ref:`institutions.json#/properties/_private_notes`. :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **public_notes** is: :Reference: :ref:`sourced_value.json#/` .. _institutions.json#/properties/related_records: related_records +++++++++++++++ .. container:: title List of related records :MARC: ``510`` :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **related_records** is: :Reference: :ref:`related_record.json#/` .. _institutions.json#/properties/self: self ++++ :Reference: :ref:`institution.json#/` .. _institutions.json#/properties/urls: urls ++++ :type: ``array`` :minItems: ``1`` .. container:: sub-title Every element of **urls** is: :Reference: :ref:`url.json#/`