@datafire/weber_gesamtausgabe_de v4.0.0

@datafire/weber_gesamtausgabe_de

Client library for WeGA API

Installation and Usage

npm install --save @datafire/weber_gesamtausgabe_de

let weber_gesamtausgabe_de = require('@datafire/weber_gesamtausgabe_de').create();

.then(data => {
  console.log(data);
});

Description

The OpenAPI documentation for the RESTful interface of the Carl-Maria-von-Weber-Gesamtausgabe. (No registration, authentication, or API key is required) For feedback or requests about this API please contact stadler@weber-gesamtausgabe.de or start the discussion at https://github.com/Edirom/WeGA-WebApp

Actions

application.newID.get

Create a new WeGA ID

weber_gesamtausgabe_de.application.newID.get({
  "docType": []
}, context)

Input

• input object
  • docType required array: The WeGA document type

Output

• output object
  • docID string: The WeGA ID
  • docType string: The WeGA document type

application.status.get

Get status information about the running WeGA-WebApp

weber_gesamtausgabe_de.application.status.get(null, context)

Input

This action has no parameters

Output

• output object
  • deployment string: The datetime of the deployment of the WeGA-WebApp
  • status string (values: healthy, unhealthy): Status (healthy|unhealthy) of the currently running WeGA-WebApp
  • svnRevision integer: The Subversion revision of the currently installed WeGA-data
  • version string

code.findByElement.element.get

Finds code samples by XML element

weber_gesamtausgabe_de.code.findByElement.element.get({
  "element": ""
}, context)

Input

• input object
  • element required string: The XML element to search for
  • namespace string: The element namespace. Defaults to the TEI namespace
  • docType array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items CodeSample

documents.get

The Documents endpoint returns a list of all documents from the WeGA digital edition.

weber_gesamtausgabe_de.documents.get({}, context)

Input

• input object
  • docType array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items Document

documents.findByAuthor.authorID.get

This endpoint returns a list of documents by a given author – optionally filtered by document type

weber_gesamtausgabe_de.documents.findByAuthor.authorID.get({
  "authorID": ""
}, context)

Input

• input object
  • authorID required string: The author ID to search for. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or GND, e.g. http://d-nb.info/gnd/118629662
  • docType array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items Document

documents.findByDate.get

This endpoint returns a list of documents related to the given date – optionally filtered by document type.

weber_gesamtausgabe_de.documents.findByDate.get({
  "fromDate": ""
}, context)

Input

• input object
  • fromDate required string: The min date to search for
  • toDate string: The max date to search for
  • docType array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items Document

documents.findByMention.docID.get

This endpoint returns a list of documents that reference a particular docID – optionally filtered by document type.

weber_gesamtausgabe_de.documents.findByMention.docID.get({
  "docID": ""
}, context)

Input

• input object
  • docID required string: The document ID that is to be mentioned. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or GND, e.g. http://d-nb.info/gnd/118629662
  • docType array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items Document

documents.docID.get

This endpoint returns documents, indicated by an ID. Accepted ID formats are WeGA, e.g. A002068 or http://weber-gesamtausgabe.de/A002068, VIAF, e.g. http://viaf.org/viaf/14959938, or GND, e.g. http://d-nb.info/gnd/118629662

weber_gesamtausgabe_de.documents.docID.get({
  "docID": ""
}, context)

Input

• input object
  • docID required string: The document identifier to search for

Output

• output array
  • items Document

facets.facet.get

Returns facets

weber_gesamtausgabe_de.facets.facet.get({
  "facet": "",
  "scope": "",
  "docType": []
}, context)

Input

• input object
  • facet required string (values: sender, addressee): The facet to search for
  • scope required string: The scope of the result set, i.e. 'indices' or a WeGA ID
  • term string: The search term to be looked for in the facet's label
  • docType required array: The WeGA document type
  • offset integer: Position of first item to retrieve (starting from 1)
  • limit integer: Number of items to retrieve (200 max)

Output

• output array
  • items Facet

Definitions

CodeSample

• CodeSample object
  • codeSample string: The code snippet
  • docID string: The WeGA document identifier representing a specific document
  • uri string: Unique identifier representing a specific document

Document

• Document object
  • docID string: The WeGA document identifier representing a specific document
  • docType string: The WeGA document type
  • title string: The title of the document
  • uri string: Unique identifier representing a specific document

Error

• Error object
  • code integer
  • fields string
  • message string

Facet

• Facet object
  • frequency integer: The sum of occurences of the object for the current result set
  • label string: The name or title of the object
  • value string: the WeGA ID