Commit 0ee854f2 authored by Marius Wybrands's avatar Marius Wybrands

2nd try with readme.md

parent c3379d7c
# Genesis Online Wrapper
Node.js wrapper for the germany genesis online database provided by Statistisches Bundesamt.
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
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.
## Installation
Npm install command:
```
$ npm install genesis-online-wrapper
```
## Initialisation
```js
const genesis = require("genesis-online-wrapper");
genesis.initWebservice({kennung: 'KENNUNG', passwort: 'PASSWORT'});
```
## Example
Get all Bundesländer with code (Amtlicher Gemeindeschlüssel).
......@@ -29,19 +51,35 @@ var getBundeslaender = function () {
}
```
## Implemented Methods
- ExportService
-- TabellenExport
-- AuspraegungInformation
#### InitWebservice
- TestService
-- Whoami
- Parameter
passwort: '',
kennung: '',
baseUrl: optional -> Default: 'https://www-genesis.destatis.de/genesisWS/web'
sprace: optional -> Default: 'de'
timeout: optional -> Default: '10000'
```js
- initWebservice(
{
passwort: 'username',
kennung: 'pass',
baseUrl: 'https://www-genesis.destatis.de/genesisWS/web',
sprace: 'de',
timeout: '10000'
})
```
- RechercheService
-- MerkmalsKatalog
-- MerkmalAuspraegungenKatalog
#### ExportService TabellenExport
- exportService.TabellenExport(parameter)
- exportService.AuspraegungInformation(parameter)
- exportService.whoami(parameter)
- exportService.MerkmalsKatalog(parameter)
- exportService.MerkmalAuspraegungenKatalog(parameter)
## Genesis-Online Datenbank
- [Overview](https://www-genesis.destatis.de/genesis/online)
......
{
"name": "genesis-online-wrapper",
"version": "0.0.1",
"version": "0.0.2",
"description": "Node.js wrapper for the germany genesis online database provided by Statistisches Bundesamt",
"main": "index.js",
"scripts": {
......
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