Commit d008d8d4 authored by Marius Wybrands's avatar Marius Wybrands

Added methods in readme.md

parent b1b225f6
# Genesis Online Wrapper
Node.js wrapper for the germany genesis online database provided by Statistisches Bundesamt.
Node.js wrapper for the germany genesis online databases (Version 4.1).
The wrapper is currently still in an alpha version.
This is not an official adapter of the Statistisches Bundesamt.
The wrapper is based on the structure of the original http interface. Therefore parameters and
The wrapper is structured like the original interface. Therefore parameters and
methods have not been translated into English. During the development it was terrible (e.g. addStrukturInformationen),
but the official [Manuel](https://www-genesis.destatis.de:443/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf) can be used for the wrapper as well.
The Genesis Online Databases, are maintained by the Statistical
Offices of the Federation and the Länder of Germany.
The aim is to establish a common data warehouse for statistical information.
However, the http interface of the Genesis online databases is very complicated and has its peculiarities. For example, all parameters must be specified in the exact order given. To simplify this, this wrapper is developed. For the R Community there is the R Package [Wiesbaden](https://github.com/sumtxt/wiesbaden).
Thus, various statistical offices of the Federation and the Länder use the "Genesis Online" system to make their data available:
Bund: https://www.destatis.de/DE/Startseite.html
Regionalstatistik: https://www.regionalstatistik.de/genesis/online/
Landesdatenbank NRW: https://www.landesdatenbank.nrw.de
Bildungsmonitoring: https://www.bildungsmonitoring.de/
## Installation
Npm install command:
......@@ -19,7 +34,7 @@ $ npm install genesis-online-wrapper
## Initialisation
```js
const genesis = require("genesis-online-wrapper");
const genesis = require('genesis-online-wrapper');
genesis.initWebservice({kennung: 'KENNUNG', passwort: 'PASSWORT'});
```
......@@ -53,25 +68,23 @@ var getBundeslaender = function () {
## Implemented Methods
- [Overview](https://www-genesis.destatis.de/genesis/online)
- [Manuel](https://www-genesis.destatis.de:443/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf)
The manual [Manuel](https://www-genesis.destatis.de:443/genesis/misc/GENESIS-Webservices_Einfuehrung.pdf)
for the original interface.
#### InitWebservice
| Parameter | Constraint | Default | Range |
| --- | --- |--- |--- |
| passwort | required | - | - |
| kennung | required | - | - |
| baseUrl | optinal | https://www-genesis.destatis.de/genesisWS/web | - |
| sprace | optinal | de | de, en |
| timeout | optinal | 10000 | - |
| baseUrl | optional | https://www-genesis.destatis.de/genesisWS/web | * |
| sprace | optional | de | de, en |
| timeout | optional | 10000 | - |
```js
initWebservice(
{
passwort: 'username',
kennung: 'pass',
kennung: 'kennung',
passwort: 'passwort',
baseUrl: 'https://www-genesis.destatis.de/genesisWS/web',
sprace: 'de',
timeout: '10000'
......@@ -79,17 +92,27 @@ initWebservice(
```
#### ExportService TabellenExport
\* Available databases (baseUrl):
* https://www.landesdatenbank.nrw.de/ldbnrwws/services
* https://www.regionalstatistik.de/genesisws/services
* https://www-genesis.destatis.de/genesisWS/web
* https://www.bildungsmonitoring.de/bildungws/services
#### ExportService
- exportService.TabellenExport(parameter)
- exportService.MerkmalInformation(parameter)
- exportService.AuspraegungInformation(parameter)
#### RechercheService
- rechercheService.MerkmalsKatalog(parameter)
- rechercheService.MerkmalAuspraegungenKatalog(parameter)
- rechercheService.AuftraegeKatalog(parameter)
#### testService
- exportService.whoami(parameter)
- exportService.MerkmalsKatalog(parameter)
- exportService.MerkmalAuspraegungenKatalog(parameter)
## Genesis-Online Datenbank
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment