Skip to content

Instantly share code, notes, and snippets.

@Romern

Romern/swagger-nina.yaml

Created February 3, 2021 14:41
Show Gist options
  • Save Romern/c3f7daf42533dd89003a1566d1f32faf to your computer and use it in GitHub Desktop.
Save Romern/c3f7daf42533dd89003a1566d1f32faf to your computer and use it in GitHub Desktop.
Download ZIP
Swaggerfile for some NINA API's
Raw
swagger-nina.yaml
swagger: "2.0"
info:
description: ""
version: "1.0.0"
title: "NINA Warnmeldungen"
license:
name: "Proprietary"
host: "warnung.bund.de"
basePath: "/api31"
schemes:
- "https"
paths:
/appdata/gsb/systemmeldungen/{prefix}/systemmeldungen_v1_android.json:
get:
summary: "Returns information about app versions"
produces:
- "application/json"
parameters:
- name: "prefix"
in: "path"
description: "Language code, e.g. DE or EN"
default: "DE"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
type: "object"
properties:
VERSIONNAME:
type: "object"
properties:
message:
type: "string"
example: "In der Version 2.3.0 für Android kommt es zu Problemen mit den standortbezogenen Warnungen. Es liegt bereits ein Update im PlayStore bereit. Vielen Dank für Ihr Verständnis."
lastModificationDate:
type: "string"
example: "+52833-11-04T03:06:40Z"
title:
type: "string"
example: "Information:"
/appdata/covid/covidmap/{prefix}/covidmap.json:
get:
summary: "Returns a map of the covid statistics in all regions"
produces:
- "application/json"
parameters:
- name: "prefix"
in: "path"
description: "Language code, e.g. DE or EN"
default: "DE"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
type: "object"
properties:
lastModificationDate:
type: "string"
example: "2021-02-03T07:55:54+01:00"
mapLegend:
type: "object"
properties:
label:
type: "string"
example: "keine Fälle übermittelt"
properties:
type: "object"
properties:
strokeOpacity:
type: "integer"
example: 1
strokeWeight:
type: "integer"
example: 1
strokeColor:
type: "string"
example: "#474747"
fillOpacity:
type: "number"
example: 0.5
fillColor:
type: "string"
example: "#04BB0A"
mapData:
type: "object"
properties:
properties:
type: "object"
properties:
strokeOpacity:
type: "integer"
example: 1
strokeWeight:
type: "integer"
example: 1
strokeColor:
type: "string"
example: "#474747"
fillOpacity:
type: "number"
example: 0.5
fillColor:
type: "string"
example: "#04BB0A"
rs:
type: "string"
example: "16077"
cases:
type: "integer"
example: 4413
cases_per_100k:
type: "number"
example: 4936.62814761782
cases7Per100k:
type: "number"
example: 200.239392346157
deaths:
type: "integer"
example: 146
ewz:
type: "integer"
example: 89393
lastUpdate:
type: "string"
example: "03.02.2021, 00:00 Uhr"
/dashboard/{id}.json:
get:
summary: "Returns general information"
produces:
- "application/json"
parameters:
- name: "id"
in: "path"
description: "Region ID (see channelsuche.json)"
default: "053340000000"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
type: "object"
properties:
id:
type: "string"
example: "mow.DE-NW-BN-SE030-20201014-30-000"
payload:
type: "object"
properties:
version:
type: "integer"
example: 2
type:
type: "string"
example: "mow.DE-NW-BN-SE030-20201014-30-000"
hash:
type: "string"
example: "d72526da941f98cb79f25dc3f9b56474a313e2161fda46e91f146139811eca4a"
data:
type: "object"
properties:
headline:
type: "string"
example: "Coronavirus: Informationen des Bundesministeriums für Gesundheit"
type:
type: "string"
example: "mow.DE-NW-BN-SE030-20201014-30-000"
provider:
type: "string"
example: "MOWAS"
severity:
type: "string"
example: "Minor"
msgType:
type: "string"
example: "Update"
transKeys:
type: "object"
properties:
event:
type: "string"
example: "BBK-EVC-040"
area:
type: "object"
properties:
type:
type: "string"
example: "ZGEM"
data:
type: "string"
example: "1+11057,100001"
i18nTitle:
type: "object"
properties:
de:
type: "string"
example: "Coronavirus: Informationen des Bundesministeriums für Gesundheit"
sent:
type: "string"
example: "2020-10-14T16:35:21+02:00"
onset:
type: "string"
example: "2020-10-14T16:35:21+02:00"
expires:
type: "string"
example: "2020-10-14T16:35:21+02:00"
effective:
type: "string"
example: "2020-10-14T16:35:21+02:00"
/warnings/{id}.json:
get:
summary: "Returns more information about a specific warning"
produces:
- "application/json"
parameters:
- name: "id"
in: "path"
description: "The ID of the warning message"
default: "mow.DE-NW-BN-SE030-20201014-30-000"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
type: "object"
properties:
identifier:
type: "string"
example: "mow.DE-NW-D-SE020-20210124-20-000"
sender:
type: "string"
example: "DE-NW-D-SE020"
sent:
type: "string"
example: "2021-01-24T12:00:20+01:00"
status:
type: "string"
example: "Actual"
msgType:
type: "string"
example: "Update"
scope:
type: "string"
example: "Public"
code:
type: "array"
items:
type: "string"
example: "DVN:3"
references:
type: "string"
example: "DE-NW-D-SE020-20210110-20-000 DE-NW-D-SE020-20201230-20-000 DE-NW-D-SE020-20201223-20-000 DE-NW-D-SE020-20201216,mow.DE-NW-D-SE020-20210110-20-000 mow.DE-NW-D-SE020-20201230-20-000 mow.DE-NW-D-SE020-20201223-20-000 mow.DE-NW-D-SE020-20201216-20-000,20--T00:00:00+00:00"
info:
type: "array"
items:
type: "object"
properties:
language:
type: "string"
example: "DE"
category:
type: "array"
items:
type: "string"
example: "Health"
event:
type: "string"
example: "Gefahreninformation"
urgency:
type: "string"
example: "Immediate"
severity:
type: "string"
example: "Minor"
certainty:
type: "string"
example: "Observed"
eventCode:
type: "array"
items:
type: "object"
properties:
valueName:
type: "string"
example: "profile:DE-BBK-EVENTCODE"
value:
type: "string"
example: "BBK-EVC-081"
headline:
type: "string"
example: "Coronavirus: Informationen des Landes Nordrhein-Westfalen"
description:
type: "string"
example: "Bis zunächst 14. Februar 2021 werden die geltenden Corona-Regelungen zur weiteren Eindämmung des Infektionsgeschehens in Nordrhein-Westfalen fortgeführt.<br/>Alle Regeln, den genauen Wortlaut der Coronaschutzverordnung und Antworten auf häufig gestellte Fragen finden Sie unter www.land.nrw/corona.<br/><br/>Neben den bislang gültigen Regelungen gelten ab Montag, 25. Januar 2021, zudem folgende Bestimmungen:<br/><br/>Änderungen bei der Maskenpflicht<br/><br/>Ab 25. Januar 2021 gilt an bestimmten Orten die Verpflichtung zum Tragen einer medizinischen Maske. Im Sinne der Coronaschutzverordnung sind das sogenannte OP-Masken oder Masken der Standards KN95/N95 oder FFP2.<br/><br/>Die Pflicht zum Tragen von medizinischen Masken gilt in Einzelhandelsgeschäften, Apotheken, Tankstellen, Banken etc. Auch in Arztpraxen und vergleichbaren medizinischen Einrichtungen sowie ÖPNV (einschließlich Bahnhöfen und Haltestellen) muss eine medizinische Maske getragen werden. Gleiches gilt während Gottesdiensten und anderen Versammlungen zur Religionsausübung, auch am Sitzplatz.<br/><br/>Das Tragen einer Alltagsmaske ist weiterhin ausreichend in geschlossenen Räumlichkeiten im öffentlichen Raum sowie auf Märkten."
instruction:
type: "string"
example: "Informieren Sie sich in den Medien, zum Beispiel im Lokalradio.<br/>Reduzieren Sie die Kontakte auf ein Minimum.<br/>Befolgen Sie die AHA-Regeln: Halten Sie Abstand. Waschen Sie regelmäßig Ihre Hände. Tragen Sie einen Mund-Nasen-Schutz.<br/>Benutzen Sie die Corona-Warn-App.<br/>Lüften Sie regelmäßig.<br/>Bitte verfolgen Sie die Informationen des Landes Nordrhein-Westfalen und der Behörden vor Ort, beispielsweise in der Presse, im Radio, im Fernsehen sowie die Auftritte des Landes auf Facebook, Twitter und Instagram.<br/>Den Text der Coronaschutzverordnung sowie weitere aktuelle Corona-Informationen finden Sie unter www.land.nrw/corona ."
web:
type: "string"
example: "www.land.nrw/corona"
contact:
type: "string"
example: "Bürgertelefon des Landes Nordrhein-Westfalen - 0211/9119-1001"
parameter:
type: "array"
items:
type: "object"
properties:
valueName:
type: "string"
example: "instructionText"
value:
type: "string"
example: "....."
area:
type: "array"
items:
type: "object"
properties:
areaDesc:
type: "string"
example: "Bundesland: Land Nordrhein-Westfalen"
geocode:
type: "array"
items:
type: "object"
properties:
valueName:
type: "string"
example: "Areald"
value:
type: "string"
example: "0"
/appdata/covid/covidrules/{prefix}/{id}.json:
get:
summary: ""
produces:
- "application/json"
parameters:
- name: "prefix"
in: "path"
description: "Language code, e.g. DE or EN"
default: "DE"
required: true
type: "string"
- name: "id"
in: "path"
description: "Region ID (see channelsuche.json)"
default: "053340000000"
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
type: "object"
properties:
key:
description: "same region ID"
type: "string"
example: "034580000000"
level:
type: "object"
properties:
headline:
type: "string"
example: "Infektionsgefahr Stufe 4"
range:
type: "string"
example: "51-100 Fälle pro 100.000 Einwohner"
backgroundColor:
type: "string"
example: "#D43624"
textColor:
type: "string"
example: "#FFFFFF"
generalInfo:
type: "string"
example: "<p>Grundsätzlich gilt:<br/>Abstand + Hygiene + Maske im Alltag + Corona-Warn-App + Lüften</p>"
rules:
type: "array"
items:
type: "object"
properties:
id:
type: string
example: "vaccinations"
caption:
type: string
example: "<p>Grundsätzlich gilt:<br/>Abstand + Hygiene + Maske im Alltag + Corona-Warn-App + Lüften</p>"
text:
type: string
example: "<p><span>Informationen zur Schutzimpfung gegen das Coronavirus erhalten Sie über die bundesweite Hotline 116117. </span></p><p><a class=\"RichTextExtLink ExternalLink\" data-gsb-doc-origin=\"2734dc2b-cd40-4d63-9a1d-68242cd9273f\" href=\"https://www.niedersachsen.de/Coronavirus/hinweise-zur-corona-schutz-impfung-195357.html\"><span>Hier finden Sie Informationen aus Ihrem Bundesland.</span></a></p>"
source:
type: string
example: "LAND"
icon:
type: object
properties:
src:
type: "string"
example: "https://warnung.bund.de/api31/appdata/covid/covidrules/assets/91760ea61c38f87127b6052c266820f9.png"
hash:
type: "string"
example: "91760ea61c38f87127b6052c266820f9"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment