Fields of the document

Last updated: 19-10-2022

The JSON codes, in order to interact via the API, are indicated in color.

Abstract

abstracts

Summary of the document.

Sub-fields

  • Value - value
  • Language - language

Additional materials

additionalMaterials

Accompanying material of the resource, for example "3 datasets".

Classification

classification

Sub-fields

  • Type: either DDC or UDC classification - type
  • Classification number - classificationPortion

Collection

specificCollections

Arbitrary group of documents, as decide by the institution, for example "Fonds Henry Dunant"

Contained in or submitted to (journal, book, proceedings)

partOf

Link to a parent document, for example the journal in which an article was published or submitted to, or the book in which a chapter was published.

Sub-fields

  • Year: publication year of the document within the host document - numberingYear
  • Volume: journal volume - numberingVolume
  • Issue: journal issue - numberingIssue
  • Pages: pages of the document within the host document, for example "23" or "23-35" - numberingPages
  • Document - document
    • Title: title of the host document - title
    • Identifier: - identifiedBy
      • Type: for example "ISSN" or "ISBN" - type
      • Value: the identifier itself - value
      • Note: optional complement about the identifier - note
      • Qualification: when the identifier references only a part of the document, for example "volume 1" for a book in two parts - qualifier
      • Acquisition terms: price of the document - acquisitionTerms
      • Source: source of the identifier if its type is not in the list, for example "PMID" - source
      • Status: only for invalid or cancelled ISBN - status
    • Publication - publication
      • Start date: publication date of the host document if it is a book - startDate
      • Statement: publication statement of the host document if it is a book, for example "Paris : PUF, 2016" - statement
    • Contribution: authors of the host document if it is a book - contribution

Content note

contentNote

Titles of the works or parts of the document, especially if it is published in multiple parts.

Contribution

contribution

Sub-fields

  • Agent - agent
    • Type: type of the agent, either person, corporate body or meeting - type
    • Preferred name: name of the agent - preferred_name
    • Identifier: usually used for ORCID - identifiedBy
      • Type: for example "Local identifier" for ORCID - type
      • Source: source of the identifier if its type is not in the list, for example "ORCID" - source
      • Value: the identifier itself - value
    • Date of birth: only for persons - date_of_birth
    • Date of death: only for persons - date_of_death
    • Place: only for meetings - place
    • Date: only for meetings - date
    • Number: only for meetings - number
  • Role: role of the person with regard to the document - role
  • Affiliation: university or institution for which the person works when publishing the document - affiliation
  • Controlled affiliation: controlled form of affiliation for facets and display. This field is automatically generated on the basis of this controlled list of forms variants. - controlledAffiliation

Dissertation (or thesis information)

dissertation

Sub-fields

  • Degree: academic degree, for example "Doctoral thesis" - degree
  • Jury note: evaluation given by the jury - jury_note
  • Granting institution: name of the university or institution that awarded the dissertation - grantingInstitution
  • Date: date in a controlled form, for example "2019" or "2019-02-28" - date

Document type

documentType

Type of the document (see complete list).

Edition statement

editionStatement

Sub-fields

  • Designation: for example "Third edition" - editionDesignation
  • Responsibility: responsibility statement related to the edition - responsibility

Extent

extent

A number and type of unit of a manifestation, for example "23 pages".

Format

formats

Format or dimensions of the document, for example "25 cm".

Identifier

identifiedBy

Identifier of the document. Local identifiers must contain the source system in the source sub-field.

Sub-fields

  • Type: for example "ISBN", "DOI" or "URI" - type
  • Value: the identifier itself - value
  • Note: optional complement about the identifier - note
  • Qualification: when the identifier references only a part of the document, for example "volume 1" for a book in two parts - qualifier
  • Acquisition terms: price of the document - acquisitionTerms
  • Source: source of the identifier if its type is not in the list, for example "PMID" - source
  • Status: only for invalid or cancelled ISBN - status

Language

language

Sub-field

  • Value - value

Note

notes

Unstructured information about the document

Open access status

oa_status

Open access status that can be defined manually in the document. Options: Gold, Green, Hybrid, Bronze, Closed.

Organisation, institution

organisation

SONAR organisation to which the document is attached.

Other electronic version

otherEdition

Other available edition, for example the published version of a preprint or the commercial edition of a thesis.

Sub-fields

  • Document - document
    • URL - electronicLocator
  • Public note: note that qualifies the edition, for example "Published version" - publicNote

Other material characteristics

otherMaterialCharacteristics

For example "illustrations", "black and white".

Publication, manufacture, distribution, production

provisionActivity

Sub-fields

  • Type: usually "Publication", can also be "Manufacture" to enter data for heritage resources - type
  • Statement: transcribed statement of publication or manufacture that can consist of one or many places, agents/publishers and dates. A complex publication statement can be entered as it appears on the source document, in a structured way - statements
    • Type: either place, agent or date - type
    • Label: part of the transcribed statement - label
      • Value - value
  • Date 1: date of publication or of printing in a controlled form, for example "2019" or "2019-02-28" - startDate
  • Date 2: date of the end of publication for serial in a controlled form, for example "2019" or "2019-02-28" - endDate

Example of a complex publication statement (ISBD equivalent would be: Genève : Slatkine ; Paris : Clairefontaine, [1987]) provisionActivity_complex_example.jpg

relatedTo

Relation to another document via a URL.

Sub-fields

  • Public note: note publicly displayed to qualify the relation - publicNote
  • Document: - document
    • URL: Uniform resource locator of the linked document - electronicLocator

Series / Series statement

series

Series statement transcribed.

Sub-fields

  • Title: title of the series - name
  • Numbering: numbering within the series - number

Subject

subjects

Sub-fields

  • Label - label
    • Language - language
    • Subject: value of the term - value
  • Source: source of the subjects, for example "MeSH" - source

System identifier

pid

Identifier generated automatically by SONAR. It appears in the URL of the document.

Title

title

Sub-fields

  • Title proper - mainTitle
  • Other title information - subtitle

Usage and access policy

usageAndAccessPolicy

Sub-fields

  • License: to choose according to the list; it is useful to indicate if the document is Open Access or not - license
  • Label: textual description of the eventual rights or rights holder, for example "Springer-Verlag Berlin Heidelberg, 2014" - label

Visibility

masked

One of these values:

  • Public(code not_masked): the document is displayed in the public interface
  • Private (code masked_for_all): the document is displayed only in the professional interface
  • Restricted to the organisation (code masked_for_external_ips): the document is displayed in the public interface, but only for users within the IP addresses as defined in the organisation settings

See also settings on the file access.