Ein einfaches Schema zur Lieferung von Daten zu Zeitschriftenartikeln an die VZG

Validate against: http://json-schema.org/draft-07/schema#

Schema ID: https://uri.gbv.de/schema/article/01/schema#

Type: object

Description

Dieses JSON-Schema (https://json-schema.org/) beschreibt ein JSON-Format zur Lieferung von bibliographischen Metadaten zu Zeitschriftenartikeln an die Verbundzentrale des GBV (VZG). HTML-Dokumentation: http://findex.gbv.de/articleformatdoc/schemas/article_schema.html

Schema Definitions

This schema defines the following subschemas for reuse:

  • Zeitschrift: journal

    Type: object

    Description

    Quellenangabe

    Required Properties

    • title
    • year

    Properties

    The following properties are defined for this object:

    • Titel: title

      Type: string

      Description

      Titel der Zeitschrift

      Minimum length: 1

    • IDs der Zeitschrift: journal_ids

      Type: array

      Description

      Identifier der Zeitschrift, z.B. E-ISSN, P-ISSN, ZDB-ID, publisher -ID usw.

      Items

      Each item in this array must adhere to the following schema:

      journal_ids

      Type: object

      Required Properties

      • type
      • id

      Properties

      The following properties are defined for this object:

      • ID: id

        Type: string

        Description

        Wert der ID

        Minimum length: 1

      • Typ: type

        Type: string

        Description

        Typ der ID, z.B. CODEN, eissn, pissn, zdbid, springerid usw. Falls unkbekannt: unknown

        Minimum length: 1

        Examples

        The following are example values for this schema:

        • "coden"
        • "eissn"
        • "pissn"
        • "zdbid"
    • Erscheinungsjahr: year

      Type: string

      Description

      Erscheinungsjahr als vierstellige Zahl

      Regular expression to match: ^[0-9]{4}$

    • Monat: month

      Type: string

      Description

      Monat des Erscheinens als zweistellige Zahl

      Regular expression to match: ^[0-9]{2}$

    • Tag: day

      Type: string

      Description

      Tag des Erscheinens als zweistellige Zahl

      Regular expression to match: ^[0-9]{2}$

    • Band: volume

      Type: string

      Minimum length: 1

    • Ausgabe: issue

      Type: string

      Minimum length: 1

    • Verlag: publisher

      Type: object

      Description

      Angaben zum Verlag, falls bekannt mit einem Identifier des Verlages (z.B. GND)

      Properties

      The following properties are defined for this object:

      • Name des Verlages: name

        Type: string

        Minimum length: 1

      • publisher_ids

        Type: array

        Items

        Each item in this array must adhere to the following schema:

        publisher_ids

        Type: object

        Required Properties

        • type
        • id

        Properties

        The following properties are defined for this object:

        • ID: id

          Type: string

          Description

          Wert der ID

          Minimum length: 1

        • Typ: type

          Type: string

          Description

          Typ der ID, z.B. gnd. Falls unkbekannt: unknown

          Minimum length: 1

          Examples

          The following are example values for this schema:

          • "gnd"
    • Erscheinungsort: place

      Type: string

      Minimum length: 1

    • Anfangsseite: start_page

      Type: string

      Minimum length: 1

    • Endseite: end_page

      Type: string

      Minimum length: 1

Required Properties

  • primary_id
  • title
  • lang_code
  • journal

Properties

The following properties are defined for this object:

  • primary_id

    Type: object

    Required Properties

    • id
    • type

    Properties

    The following properties are defined for this object:

    • Primäre ID: id

      Type: string

      Description

      primäre ID des Datensatzes in der Datenquelle

      Minimum length: 1

    • Typ: type

      Type: string

      Description

      Typ der ID. Der Typ der ID sollte so gewählt werden, dass nachvollziehbar ist, woher die Datensätze stammen. Die Katalogiserungsrichtlinie schlägt in den 20XX- und 21XX-Feldern Kürzel für einige Datenlieferanten vor, die auch hier genutzt werden sollten: http://swbtools.bsz-bw.de/cgi-bin/help.pl?cmd=index&regelwerk=RDA&verbund=GBV#titel . Falls unkbekannt: unknown

      Minimum length: 1

      Examples

      The following are example values for this schema:

      • "oai_id"
      • "https://kxp.k10plus.de/DB=2.1/"
      • "oclc"
  • weitere IDs: other_ids

    Type: array

    Description

    Weitere Identifier für den Artikel aus dem Quelldatensatz mit Angabe des Typs der ID, z.B. doi, urn, oai_id usw. (hier keine Identifier zu Zeitschriften, Personen usw.) Vergleiche http://swbtools.bsz-bw.de/cgi-bin/help.pl?cmd=kat&val=2113&regelwerk=RDA&verbund=GBV

    Items

    Each item in this array must adhere to the following schema:

    other_ids

    Type: object

    Required Properties

    • id
    • type

    Properties

    The following properties are defined for this object:

    • ID: id

      Type: string

      Description

      Wert der ID

      Minimum length: 1

    • Typ: type

      Type: string

      Description

      Typ der ID. Falls unkbekannt: unknown

      Minimum length: 1

      Examples

      The following are example values for this schema:

      • "doi"
      • "oclc"
      • "urn"
      • "oai_id"
  • Titel: title

    Type: string

    Description

    Der Haupttitel des Artikels

    Minimum length: 1

  • Titel: subTitle

    Type: string

    Description

    Eventuelle Ergänzung zum Haupttitel

    Minimum length: 1

  • Weitere Titel: otherTitles

    Type: array

    Description

    Weitere Titelformen

    Items

    Each item in this array must adhere to the following schema:

    otherTitles

    Type: string

    Minimum length: 1

  • Personen: persons

    Type: array

    Description

    alle am Artikel beteiligten Personen in der Reihenfolge der Nennung im Artikel

    Items

    Each item in this array must adhere to the following schema:

    persons

    Type: object

    Required Properties

    • fullname

    Properties

    The following properties are defined for this object:

    • Voller Name: fullname

      Type: string

      Description

      persönlicher Name, dieser wird auch verwendet, wenn eine Aufteilung in Nachname, Vorname nicht möglich ist. Verfassende Organisationen (Körperschaften) können bei Aufsätzen auch als „persönlicher Name“ angegeben werden

      Minimum length: 1

    • Vorname: firstname

      Type: string

      Description

      Vorname

      Minimum length: 1

    • Nachname: lastname

      Type: string

      Description

      Nachname

      Minimum length: 1

    • role: role

      Type: string

      Description

      Minimum length: 1

      Examples

      The following are example values for this schema:

      • "aut"
      • "edt"
      • "ill"
    • Zugehörigkeit: affiliation

      Type: object

      Description

      Zugehörigkeit einer Person zu einer Einrichtung (z.B. Universität, Firma, Forschungseinrichtung usw.)

      Properties

      The following properties are defined for this object:

      • Name der Einrichtung: name

        Type: string

        Description

        Name der Einrichtung

        Minimum length: 1

      • Identifier der Einrichtung: affiliation_ids

        Type: array

        Description

        Identifier, die die Einrichtung identifizieren

        Items

        Each item in this array must adhere to the following schema:

        affiliation_ids

        Type: object

        Required Properties

        • id
        • type

        Properties

        The following properties are defined for this object:

        • ID: id

          Type: string

          Description

          Wert der ID

          Minimum length: 1

        • type: type

          Type: string

          Description

          Typ der ID (z.B. gnd, viaf, ???). Falls unkbekannt: unknown

          Minimum length: 1

          Examples

          The following are example values for this schema:

          • "gnd"
          • "viaf"
    • IDs der Person: person_ids

      Type: array

      Description

      Identifier, die die Person identifizieren (z.B. GND, ORCID, …)

      Items

      Each item in this array must adhere to the following schema:

      person_ids

      Type: object

      Required Properties

      • id
      • type

      Properties

      The following properties are defined for this object:

      • ID: id

        Type: string

        Description

        Wert der ID

        Minimum length: 1

      • Typ: type

        Type: string

        Description

        Typ der ID (z.B. gnd, orcid, viaf, …). Falls unkbekannt: unknown

        Minimum length: 1

        Examples

        The following are example values for this schema:

        • "orcid"
        • "gnd"
  • journal

    Referenced Schema

    This item must validate against the following schema:

    #/definitions/journal

  • Weitere Veröffentlichungen: relatedWorks

    Type: array

    Description

    Hier können im gleichen Format zu ‘journal’ weitere Verknüpfungen untergebracht werden.

    Items

    Each item in this array must adhere to the following schema:

    relatedWorks

    Referenced Schema

    This item must validate against the following schema:

    #/definitions/journal

  • Sprache(n): lang_code

    Type: array

    Description

    Items

    Each item in this array must adhere to the following schema:

    lang_code

    Type: string

    Regular expression to match: ^[a-z]{3}$

  • URLs zum Artikel: urls

    Type: array

    Description

    URLs zum Artikel mit Angabe zum ‘Bezugswerk’ in ‘scope’ sowie zu Benutzungsbedingungen in ‘access_info’

    Items

    Each item in this array must adhere to the following schema:

    urls

    Type: object

    Required Properties

    • url
    • scope
    • access_info

    Properties

    The following properties are defined for this object:

  • Abstracts, Zusammenfassungen usw.: abstracts

    Type: array

    Description

    Text mit Angabe der Sprache als Sprachcode aus ISO 639-2

    Items

    Each item in this array must adhere to the following schema:

    abstracts

    Type: object

    Required Properties

    • text

    Properties

    The following properties are defined for this object:

  • Sacherschließung: subject_terms

    Type: array

    Description

    Mit Angabe des Sacherschließungssystems und der Sprache als Sprachcode aus ISO 639-2

    Items

    Each item in this array must adhere to the following schema:

    subject_terms

    Type: object

    Required Properties

    • scheme
    • terms

    Properties

    The following properties are defined for this object:

    • Sacherschließungsterme: terms

      Type: array

      Description

      Sacherschließungsterme als Array. Entweder jeder Term als eigenes String-Feld; oder als Objekt bestehend aus einer Bezeichnung und einer ID oder Notation (z.B. GND-ID)

      Items

      Each item in this array must adhere to the following schema:

      terms

      Type: string,object

      Minimum number of properties: 1

      Properties

      The following properties are defined for this object:

      • Term/Bezeichnung: term

        Type: string

        Minimum length: 1

      • Identifikator/Notation innerhalb des Sacherschließungssystems: id

        Type: string

        Minimum length: 1

      Minimum length: 1

    • Sacherschließungssystem: scheme

      Type: string

      Description

      Bezeichnung des Sacherschließungssystems

      Minimum length: 1

    • Sprachcode: lang_code

      Type: string

      Description

      Regular expression to match: ^[a-z]{3}$

  • Copyrightvermerk: copyright

    Type: string

    Minimum length: 1

  • Herstellungsdatum: dateOfProduction

    Type: string

    Description

    Herstellungsdatum (z.B. Datum der Digitalisierung). Das Datum kann als vierstelliges Jahr (YYYY), Jahr und Monat (YYYY-MM) oder Jahr, Monat und Tag (YYYY-MM-DD) angegeben werden. s.a. PICA 1108 $p: https://swbtools.bsz-bw.de/cgi-bin/k10plushelp.pl?cmd=kat&val=1108&katalog=Standard

    Regular expression to match: ^[0-9]{4}(-[0-9]{2}){0,2}$

  • Sonst noch was?: additional_data

    Type: object

    Description

    In den key ‘additional_data’ kann ein JSON-Objekt mit weiteren Daten geschrieben werden. Dieses Objekt muss mit einem JSON-Schema spezifiziert sein und es sollte ein Mapping des Objekts auf Picaplus-Felder mitgeliefert werden.