Abwassermonitoring für Berlin

API Dokumentation

Die offene getCovidOpenDataByDateRange-REST-API dient dazu, die Messergebnisse aus dem SARS-CoV-2-Abwassermonitoring aus Berlin anfragen zu können. Die Ergebnisdaten können mithilfe der Angabe eines Datumsbereiches eingeschränkt werden. Dabei kann zwischen Februar 2022 bis heute jegliche Datumskombination für die Anfrage genutzt werden. Die Schnittstelle ist ohne Verifizierung frei zugänglich. Die Schnittstellensprache ist Englisch.

Als Ausgabe werden die Probenummer, der Messpunkt, das Entnahmedatum und die Messergebnisse, unterteilt nach dem analysierten Zielgen (SARS-CoV-2 (N1), SARS-CoV-2 (N2), PMMoV, NGS Illumina), je Messung zurückgeliefert. Bei NGS Illumina handelt es sich um die Genomsequenzierung der gefundenen Virusrückstände. Es wird zu jeder ermittelten Virusvariante der Name, die pango lineage, das prozentuale Ergebnis bezogen auf die Gesamtprobe und die Einheit angegeben. Die Ergebnisse aus der Genomsequenzierung müssen nicht zusammen mit den anderen Ergebnissen veröffentlicht werden. Somit können Abfragen zu einem späteren Zeitpunkt eine andere Rückantwort erhalten.

Das verwendete JSON-Dateiformat entspricht regulären JSON-Regeln.
Unter der nachfolgenden URL steht die API zur Verfügung.

Strukturell enthält der Aufruf der Index-Methode folgende Eigenschaften:

                    
    Der Aufruf des Endpunktes erfolgt mit der POST-Methode.
    https://api.hygiene-monitor.de/openData/getCovidOpenDataByDateRange

    {
      "extraction_date_start": "YYYY-MM-DD", /* optional */
      "extraction_date_end": "YYYY-MM-DD"    /* optional */
    }

    Wenn ein leerer Body als Message geschickt wird, werden nur die letzten 3 Monate, vor dem Zeitpunkt des Aufrufes übermittelt.
  
                  

Strukturell enthält die Antwort folgende Eigenschaften:

                    
    {
      "body": [
        {
          "sample_number": "", /* Probennummer */
          "measuring_point": "", /* Messpunkt / Entnahmestelle */
          "extraction_date": "", /* Datum der Entnahme */
          "results": [
            {
              "name": "SARS-CoV-2 (N1)", /* Name des Zielgens für dreifach Untersuchung */
              "parameter": [
                {
                  "name": "copy_number_1", /* 1. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_2", /* 2. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_3", /* 3. Untersuchung - ab 24.03.2022 */
                  "result": "" /* Anzahl Genkopien */
                }
              ]
            },
            {
              "name": "SARS-CoV-2 (N2)", /* Name des Zielgens für dreifach Untersuchung */
              "parameter": [
                {
                  "name": "copy_number_1", /* 1. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_2", /* 2. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_3", /* 3. Untersuchung - ab 24.03.2022 */
                  "result": "" /* Anzahl Genkopien */
                }
              ]
            },
            {
              "name": "PMMoV", /* Name des Zielgens für dreifach Untersuchung - ab 01.04.2022 */
              "parameter": [
                {
                  "name": "copy_number_1", /* 1. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_2", /* 2. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                },
                {
                  "name": "copy_number_3", /* 3. Untersuchung */
                  "result": "" /* Anzahl Genkopien */
                }
              ]
            },
            {
              "name": "NGS Illumina", /* Sequenzierung / Bestimmung der Gene */
              "parameter": [
                {
                  "name": "", /* Name des Gen's */
                  "pango_linaege": "", /* Zugeordnete Pango Linaege */
                  "result_value": "", /* gemessener Anteil */
                  "unit": "%" /* Einheit: Prozent */
                }
              ]
            }
          ]
        }
      ]
    }