# @datafire/weber_gesamtausgabe_de

> DataFire integration for WeGA API

Latest version **4.0.0** (published 2020-12-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @datafire/weber_gesamtausgabe_de
pnpm add @datafire/weber_gesamtausgabe_de
yarn add @datafire/weber_gesamtausgabe_de
bun add @datafire/weber_gesamtausgabe_de
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2020-12-21 |
| First published | 2018-06-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 26.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | DataFire |
| Maintainers | datafire |

## Links

- npm: https://www.npmjs.com/package/@datafire/weber_gesamtausgabe_de
- Repository: https://github.com/DataFire/integrations
- Homepage: https://github.com/DataFire/integrations#readme
- Issues: https://github.com/DataFire/integrations/issues
- npm.io page: https://npm.io/package/@datafire/weber_gesamtausgabe_de

## Dependencies (1)

- [datafire](https://npm.io/package/datafire.md) ^2.0.0

## Recent versions

- 4.0.0 (latest) — 2020-12-21
- 3.0.0 — 2018-06-12

## README

# @datafire/weber_gesamtausgabe_de

Client library for WeGA API

## Installation and Usage
```bash
npm install --save @datafire/weber_gesamtausgabe_de
```
```js
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. <br/> (No registration, authentication, or API key is required) <br/> 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


```js
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


```js
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


```js
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](#codesample)

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



```js
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](#document)

### documents.findByAuthor.authorID.get
This endpoint returns a list of documents by a given author – optionally filtered by document type 



```js
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](#document)

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



```js
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](#document)

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



```js
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](#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



```js
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](#document)

### facets.facet.get
Returns facets


```js
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](#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

---
_Source: https://npm.io/package/@datafire/weber_gesamtausgabe_de · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._