Winterthur: Adds open data description for mission reports

TYPE: Feature LINK: ogc-1908
OneGov · Nov 20, 2024 · 04d072f · 04d072f
1 parent c55eb56
commit 04d072f
Show file tree

Hide file tree

Showing 3 changed files with 124 additions and 1 deletion.
diff --git a/src/onegov/winterthur/static/docs/api/open_data_de.md b/src/onegov/winterthur/static/docs/api/open_data_de.md
@@ -0,0 +1,96 @@
+# Einsatzberichte der Feuerwehr Winterthur: Open Data
+
+## Nutzungsbedingungen
+
+Freie Nutzung. Quellenangabe ist Pflicht.
+
+- Sie dürfen diesen Datensatz für nicht kommerzielle Zwecke nutzen.
+- Sie dürfen diesen Datensatz für kommerzielle Zwecke nutzen.
+- Eine Quellenangabe ist Pflicht (Autor, Titel und Link zum Datensatz).
+
+## Einsatzberichte der Feuerwehr Winterthur
+Die Einsatzberichte der Feuerwehr Winterthur sind im JSON- und CSV-Format
+verfügbar.
+
+```
+URL /mission-reports/json
+URL /mission-reports/csv
+```
+
+### Datenfelder
+
+Datensatz:
+
+| Name                    | Typ           | Beschreibung                            |
+|-------------------------|---------------|-----------------------------------------|
+| `name`                  | string        | Name des Datensatzes `Mission Reports`   |
+| `report_count`          | int           | Anzahl der Einsatzberichte im Datensatz |
+| `reports`               | list[report] | Liste der Einsatzberichte               |
+
+
+Einsatzbericht (`report`):
+
+| Name                    | Typ          | Beschreibung                                            |
+|-------------------------|--------------|---------------------------------------------------------|
+| `date`                  | string       | Datum des Einsatzes                                     |
+| `alarm`                 | string       | Alarmzeit                                               |
+| `duration`              | string       | Dauer des Einsatzes im Format `1.2h`                    |
+| `nature`                | string       | Beschreibung des Einsatzes                              |
+| `mission_type`          | string       | Art des Einsatzes (`single`, `multiple`)                |
+| `mission_count`         | int          | Anzahl der Einsätze falls `mission_type==multi`         |
+| `vehicles`              | list[string] | Liste der eingesetzten Fahrzeuge                        |
+| `vehicle_icons`         | list[string] | Liste der Icons der Einsatzfahrzeuge im Einsatz als URL |
+| `location`              | string       | Einsatzort                                              |
+| `personnel_active`      | int          | Anzahl der aktiven Einsatzkräfte                        |
+| `personnel_backup`      | int          | Anzahl der Einsatzkräfte nicht im Einsatz (Backup)      |
+| `civil_defense_involved`| bool         | Zivilschutz involviert (true, false)                    |
+
+### Beispiel JSON
+```json
+{
+  "name": "Mission Reports",
+  "report_count": 1,
+  "reports": [
+    "date": "2021-01-01",
+    "alarm": "8:30",
+    "duration": "1.3h",
+    "nature": "Containerbrand",
+    "mission_type": "single",
+    "mission_count": 2,
+    "vehicles": ["Tanklöschfahrzeug TLF"],
+    "vehicle_icons": ["http://../storage/345e..db80"],
+    "location": "Museumsstrasse, Winterthur",
+    "personnel_active": 5,
+    "personnel_backup": 4,
+    "civil_defense_involved": false,
+  ]
+```
+
+### Beispiel CSV
+Die erste Zeile enthält die Spaltennamen. Die weiteren Zeilen enthalten die einzelnen Einsatzberichte.
+```
+date,alarm,duration,nature,mission_type,mission_count,vehicles,vehicles_icons,location,personnel_active,personnel_backup,civil_defence_involved
+12.11.2024,08:30,2.4h,Fehlalarm Rauchmelder,single,1,Drehleiter DL,http://../storage/345e..db80,Luzern,3,8,False
+31.10.2024,12:01,4h,Schwehlbrand im Dachgeschoss,multi,2,"Drehleiter DL, Drehleiter DL, Tanklöschfahrzeug TLF","http://../storage/345e..db80, http://. ./storage/345e..db80, http://../storage/15e6..0530","Pilatusstrasse 3, 6003 Luzern",6,2,False
+```
+
+### URL Parameter
+Mit den folgenden Parametern können die Einsatzberichte gefiltert werden.
+
+| Parameter | Typ  | Beschreibung                                                                                                    |
+|-----------|------|-----------------------------------------------------------------------------------------------------------------|
+| None      | -    | Wenn keine Parameter angegeben werden, werden alle Einsatzberichte des aktuellen Kalenderjahres zurückgegeben. |
+| `all`     | bool | Wenn `true`, werden alle Einsatzberichte zurückgegeben.                                                         |
+| `year`    | int  | Das Jahr, für welches die Einsatzberichte gefiltert werden sollen.                                              |
+
+URL Beispiele:
+```
+URL /mission-reports/json
+URL /mission-reports/json?all=true
+URL /mission-reports/json?year=2023
+
+URL /mission-reports/csv
+URL /mission-reports/csv?all=true
+URL /mission-reports/csv?year=2024
+```
+
diff --git a/src/onegov/winterthur/templates/mission_reports.pt b/src/onegov/winterthur/templates/mission_reports.pt
@@ -70,6 +70,32 @@
                 <h2 i18n:translate>Legend</h2>
                 <tal:b tal:replace="legend" />
             </div>
+
+            <div class="mission-report-open-data">
+                <h2>Open Data</h2>
+                <p>Die Rohdaten sind in den folgenden Formaten verfügbar:</p>
+                <ol>
+                    <li>
+                        <a href="mission-reports/json">JSON</a>
+                    </li>
+                    <li>
+                        <a href="mission-reports/csv">CSV</a>
+                    </li>
+                </ol>
+
+                <p>
+                    <span>Das Datenformat ist hier beschrieben:</span> <a href="https://github.com/OneGov/onegov-cloud/blob/master/src/onegov /winterthur/static/docs/api/open_data_de.md"><span>Formatbeschreibung</span></a>
+                </p>
+
+                <h3>Nutzungsbedingungen</h3>
+                <p>Freie Nutzung. Quellenangabe ist Pflicht.</p>
+                <ul>
+                    <li>Sie dürfen diesen Datensatz für nicht kommerzielle Zwecke nutzen. </li>
+                    <li>Sie dürfen diesen Datensatz für kommerzielle Zwecke nutzen. </li>
+                    <li> Eine Quellenangabe ist Pflicht (Autor, Titel und Link zum Datensatz). </li>
+                </ul>
+                <p><a href="https://opendata.swiss/de/terms-of-use"><img width="0100" height="80" src="https://wp.opendata.swiss/wp-content/uploads/2021/02/terms_by.png" alt="Nutzungsbedingungen"></a></p>
+            </div>
         </tal:b>
     </tal:b>
 </div>
diff --git a/src/onegov/winterthur/theme/styles/winterthur.scss b/src/onegov/winterthur/theme/styles/winterthur.scss
@@ -552,9 +552,10 @@ table.responsive {
 /*
     Mission reports legend
 */
-.mission-report-legend {
+.mission-report-legend, .mission-report-open-data {
     background: $gray-pastel;
     padding: 1rem 1rem .5rem;
+    margin-bottom: .5rem;
 
     * {
         font-size: .8rem;