forked from bundesAPI/regionalatlas-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
121 lines (102 loc) · 6.33 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
openapi: '3.0.0'
info:
title: 'Regionalatlas-API'
description: |
API zum [Regionalatlas Deutschland](https://regionalatlas.statistikportal.de/#) der statistischen Ämter des Bundes und der Länder.
Der Regionalatlas Deutschland der Statistischen Ämter des Bundes und der Länder visualisiert aktuell laut [statistischem Bundesamt](https://www.destatis.de/DE/Service/Statistik-Visualisiert/_inhalt.html) mehr als 160 Indikatoren aus 20 Themenbereichen für Bundesländer, Regierungsbezirke, Kreisfreie Städte und Landkreise. Grundlage des Regionalatlas ist die Regionaldatenbank Deutschland.
version: '1.0.0'
servers:
- url: 'https://www.gis-idmz.nrw.de/arcgis/rest/services/stba/regionalatlas/MapServer/dynamicLayer'
paths:
/query:
get:
summary: query
description: |
Die gewünschten Daten lassen sich über GET-Parameter im Query-String spezifizieren.
operationId: query
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
parameters:
- in: query
name: layer
required: true
schema:
type: string
default: '%7B%22source%22%3A%7B%22dataSource%22%3A%7B%22geometryType%22%3A%22esriGeometryPolygon%22%2C%22workspaceId%22%3A%22gdb%22%2C%22query%22%3A%22SELECT%20*%20FROM%20verwaltungsgrenzen_gesamt%20LEFT%20OUTER%20JOIN%20ai002_1_5%20ON%20ags%20%3D%20ags2%20and%20jahr%20%3D%20jahr2%20WHERE%20typ%20%3D%201%20AND%20jahr%20%3D%202020%20AND%20(jahr2%20%3D%202020%20OR%20jahr2%20IS%20NULL)%22%2C%22oidFields%22%3A%22id%22%2C%22spatialReference%22%3A%7B%22wkid%22%3A25832%7D%2C%22type%22%3A%22queryTable%22%7D%2C%22type%22%3A%22dataLayer%22%7D%7D'
description: |
Komplexer Parameter, der im JSON-Format Details der Anfrage spezifiziert. In der Regel stellt enthält der layer-Parameter ein Objekt (in geschweiften Klammern), das seinerseits ein Objekt namens 'source' enthält. Das source-Objekt wiederum enthält ein Objekt, das zum einen das Objekt 'dataSource' und zum anderen ein Datum namens 'type' mit dem Wert 'dataLayer' enthält. In dataSource wird die gewünschte Tabelle spezifiziert (z.B. für Angaben zur Bevölkerungsdichte 'ai002_1_5') - im Folgenden mit dem Platzhalter *tableName* gekennzeichnet.
dataSource kann unterschiedlich aufgebaut sein und enthält entweder (a) Daten namens 'dataSourceName' (mit einem Wert wie z.B. 'regionalatlas.*tableName*'), 'workspaceId' (z.B. 'gdb') und 'type' (z.B. 'table') oder (b) Daten namens 'geometryType' (z.B. 'esriGeometryPolygon'), 'workspaceId' (z.B. 'gdb'), 'query' (mit einem SQL-Query, z.B. 'SELECT * FROM verwaltungsgrenzen_gesamt LEFT OUTER JOIN *tableName* ON ags = ags2 and jahr = jahr2 WHERE typ = 3 AND jahr = 2020 AND (jahr2 = 2020 OR jahr2 IS NULL)'), 'oidFields' (z.B. 'id'), 'spatialReference' (mit einem Objekt, das wiederum das Datum 'wkid' mit einem Wert wie 25832 umfasst), und 'type':'queryTable'.
Der SQL-Query dürfte für Nutzer*innen des Regionalatlas Deutschland weitgehend selbsterklärend sein, wobei man wissen muss dass die Variable *typ* die gewünschte regionale Ebene spezifiziert:
- 1=Bundesländer,
- 2=Regierungsbezirke und Statistische Regionen,
- 3=Kreise und kreisfreie Städte,
- 5=Gemeinden/Verbandsgemeinde.
Gültige Einträge für die *tableName* werden im Folgenden auszugsweise dargestellt (jeweils mit den enthaltenen Variablen/fields)
- Bevölkerungsdichte: ai002_1_5
- - ai0201: Bevölkerungsdichte (EW je qkm)
- - ai0202: Bevölkerungsentwicklung im Jahr je 10.000 EW
- - ai0208: Anteil der ausländischen Bevölkerung an der Gesamtbevölkerung
- - ai0209: Lebendgeborene je 10.000 EW
- - ai0210: Gestorbene je 10.000 EW
- - ai0211: Geburten-/Gestorbenenüberschuss je 10.000 EW
- - ai0212: Wanderungssaldo je 10.000 EW
- Altersdurchschnitt: ai002_4_5
- - ai0218: Durchschnittsalter der Bevölkerung
- - ai0219: das Durchschnittsalter der Mutter bei der Geburt des 1. Kindes)
- Arbeitslosenquote: ai008_1_5
- - ai0801: Arbeitslosenquote
- - ai0806: Anteil Arbeitslose 15-24 Jahre an Arbeitslosen insgesamt
- - ai0807: Anteil Arbeitslose 55-64 Jahre an Arbeitslosen insgesamt
- - ai0808: Anteil Langzeitarbeitslose an Arbeitslosen insgesamt
- - ai0809: Anteil der ausl. Arbeitslosen an Arbeitslosen insgesamt
- Verfügbares Einkommen je EW: ai_s_01
- SGB-II-Quote: ai_s_04
- BIP je Erwerbstätigem: ai017_1
- Wahlergebnisse Bundestagswahl: ai005'
- in: query
name: f
schema:
type: string
description: Output-Format (z.B. 'json' oder 'html').
example: 'json'
required: true
- in: query
name: outFields
schema:
type: string
description: Auszugebende Variablen/fields (z.B. '*').
example: '*'
required: false
- in: query
name: returnGeometry
schema:
type: boolean
description: Boolsche Angabe, ob Angaben zur Geometrie gesendet werden sollen (z.B. 'false').
example: false
required: true
- in: query
name: spatialRel
schema:
type: string
description: spational relation (z.B. 'esriSpatialRelIntersects').
example: 'esriSpatialRelIntersects'
required: true
- in: query
name: where
schema:
type: string
description: Spezifikation einer gewünschten Teilmenge der Daten (z.B.'1=1'' für alle Daten oder 'ags2 = 'DG' and jahr2 = 2020').
example: '1%3D1'
required: true
components:
schemas:
Response:
type: object
externalDocs:
description: "Weiterführende Dokumentation"
url: "https://github.com/AndreasFischer1985/regionalatlas-api"