docs: [Zurück zur Übersicht](../README.md) in Alle in README für jeder Verzeichnis
This commit is contained in:
ISA
3
docs/pages/api/README.md
Normal file
3
docs/pages/api/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 📄 Übersicht: docs/pages/api
|
||||
|
||||
- [[...path]]([...path].md)
|
||||
3
docs/pages/api/talas_v5_DB/README.md
Normal file
3
docs/pages/api/talas_v5_DB/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB
|
||||
|
||||
- [priorityConfig](priorityConfig.md)
|
||||
4
docs/pages/api/talas_v5_DB/area/README.md
Normal file
4
docs/pages/api/talas_v5_DB/area/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/area
|
||||
|
||||
- [readArea](readArea.md)
|
||||
- [updateArea](updateArea.md)
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# 📥 readArea.js
|
||||
|
||||
Liest Bereichskoordinaten (`location_coordinates`) aus der Datenbank basierend auf `idMaps` (und optional `idLocation`).
|
||||
Liest Bereichskoordinaten (`location_coordinates`) aus der Datenbank basierend auf `idMaps` (und
|
||||
optional `idLocation`).
|
||||
|
||||
## Methode
|
||||
|
||||
@@ -10,9 +11,9 @@ Liest Bereichskoordinaten (`location_coordinates`) aus der Datenbank basierend a
|
||||
|
||||
## URL-Parameter
|
||||
|
||||
| Name | Beschreibung |
|
||||
|-------------|--------------------------------------|
|
||||
| `m` | Karten-ID (entspricht `idMaps`) |
|
||||
| Name | Beschreibung |
|
||||
| ------------ | --------------------------------------- |
|
||||
| `m` | Karten-ID (entspricht `idMaps`) |
|
||||
| `idLocation` | (optional) ID eines bestimmten Bereichs |
|
||||
|
||||
## Verhalten
|
||||
@@ -25,4 +26,8 @@ Liest Bereichskoordinaten (`location_coordinates`) aus der Datenbank basierend a
|
||||
|
||||
```http
|
||||
GET /api/talas_v5_DB/area/readArea?m=3
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -2,7 +2,8 @@
|
||||
|
||||
# 📤 updateArea.js
|
||||
|
||||
Aktualisiert die Koordinaten eines Bereichs (`location_coordinates`) basierend auf `idLocation` und `idMap`.
|
||||
Aktualisiert die Koordinaten eines Bereichs (`location_coordinates`) basierend auf `idLocation` und
|
||||
`idMap`.
|
||||
|
||||
## Methode
|
||||
|
||||
@@ -29,4 +30,8 @@ Aktualisiert die Koordinaten eines Bereichs (`location_coordinates`) basierend a
|
||||
|
||||
- 400: Fehlende Daten
|
||||
- 404: Kein Eintrag gefunden
|
||||
- 500: Interner Fehler
|
||||
- 500: Interner Fehler
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
4
docs/pages/api/talas_v5_DB/device/README.md
Normal file
4
docs/pages/api/talas_v5_DB/device/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/device
|
||||
|
||||
- [getAllStationsNames](getAllStationsNames.md)
|
||||
- [getDevices](getDevices.md)
|
||||
@@ -26,4 +26,8 @@ Liefert eine Zuordnungstabelle aller Geräte-IDs (`idLD`) zu ihren Namen (`name`
|
||||
|
||||
```bash
|
||||
/pages/api/talas_v5_DB/device/getAllStationsNames.js
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -31,4 +31,8 @@ API-Route zum Abrufen aller Geräteinformationen aus der `devices`-Tabelle.
|
||||
|
||||
```bash
|
||||
/pages/api/talas_v5_DB/device/getDevices.js
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
4
docs/pages/api/talas_v5_DB/gisLines/README.md
Normal file
4
docs/pages/api/talas_v5_DB/gisLines/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/gisLines
|
||||
|
||||
- [readGisLines](readGisLines.md)
|
||||
- [updateLineCoordinates](updateLineCoordinates.md)
|
||||
@@ -22,4 +22,8 @@ Liefert alle Linien aus der Tabelle `gis_lines`.
|
||||
|
||||
```http
|
||||
GET /api/talas_v5_DB/gisLines/readGisLines
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -14,7 +14,10 @@ Aktualisiert die `points`-Spalte einer Linie in der Tabelle `gis_lines`.
|
||||
{
|
||||
"idLD": 7,
|
||||
"idModul": 2,
|
||||
"newCoordinates": [[53.2151, 8.4522], [53.2165, 8.4531]]
|
||||
"newCoordinates": [
|
||||
[53.2151, 8.4522],
|
||||
[53.2165, 8.4531]
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
@@ -27,4 +30,8 @@ Aktualisiert die `points`-Spalte einer Linie in der Tabelle `gis_lines`.
|
||||
## Fehlerfälle
|
||||
|
||||
- 400: Ungültige oder fehlende Felder
|
||||
- 500: Datenbankfehler
|
||||
- 500: Datenbankfehler
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
5
docs/pages/api/talas_v5_DB/locationDevice/README.md
Normal file
5
docs/pages/api/talas_v5_DB/locationDevice/README.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/locationDevice
|
||||
|
||||
- [getDeviceId](getDeviceId.md)
|
||||
- [locationDeviceNameById](locationDeviceNameById.md)
|
||||
- [locationDevices](locationDevices.md)
|
||||
@@ -10,8 +10,8 @@ Gibt die Geräte-ID (`idLD`) zu einem übergebenen Gerätenamen zurück.
|
||||
|
||||
## Parameter
|
||||
|
||||
| Name | Beschreibung |
|
||||
|-------------|----------------------|
|
||||
| Name | Beschreibung |
|
||||
| ------------ | ------------------------------- |
|
||||
| `deviceName` | Der Gerätename (z. B. "Kue705") |
|
||||
|
||||
## Antwort
|
||||
@@ -23,4 +23,8 @@ Gibt die Geräte-ID (`idLD`) zu einem übergebenen Gerätenamen zurück.
|
||||
## Fehler
|
||||
|
||||
- 400: Wenn `deviceName` fehlt
|
||||
- 404: Gerät nicht gefunden
|
||||
- 404: Gerät nicht gefunden
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -10,9 +10,9 @@ Gibt den Namen eines Geräts anhand seiner ID zurück.
|
||||
|
||||
## Parameter
|
||||
|
||||
| Name | Beschreibung |
|
||||
|--------|------------------------|
|
||||
| `idLD` | Geräte-ID (z. B. 27) |
|
||||
| Name | Beschreibung |
|
||||
| ------ | -------------------- |
|
||||
| `idLD` | Geräte-ID (z. B. 27) |
|
||||
|
||||
## Antwort
|
||||
|
||||
@@ -23,4 +23,8 @@ Gibt den Namen eines Geräts anhand seiner ID zurück.
|
||||
## Fehler
|
||||
|
||||
- 400: Fehlender Parameter
|
||||
- 404: Gerät mit ID nicht gefunden
|
||||
- 404: Gerät mit ID nicht gefunden
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -24,4 +24,8 @@ Gibt eine vollständige Liste aller Geräte in der Tabelle `location_device` zur
|
||||
...
|
||||
}
|
||||
]
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
3
docs/pages/api/talas_v5_DB/poiTyp/README.md
Normal file
3
docs/pages/api/talas_v5_DB/poiTyp/README.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/poiTyp
|
||||
|
||||
- [readPoiTyp](readPoiTyp.md)
|
||||
@@ -33,4 +33,8 @@ GET /api/talas_v5_DB/poiTyp/readPoiTyp
|
||||
"icon": 12
|
||||
}
|
||||
]
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
9
docs/pages/api/talas_v5_DB/pois/README.md
Normal file
9
docs/pages/api/talas_v5_DB/pois/README.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/pois
|
||||
|
||||
- [addPoi](addPoi.md)
|
||||
- [deletePoi](deletePoi.md)
|
||||
- [getPoiById](getPoiById.md)
|
||||
- [poi-icons](poi-icons.md)
|
||||
- [readAllPOIs](readAllPOIs.md)
|
||||
- [updateLocation](updateLocation.md)
|
||||
- [updatePoi](updatePoi.md)
|
||||
@@ -22,4 +22,8 @@ Fügt einen neuen POI (Point of Interest) zur Datenbank hinzu.
|
||||
|
||||
## Besonderheiten
|
||||
|
||||
- Position wird als `POINT(longitude latitude)` gespeichert
|
||||
- Position wird als `POINT(longitude latitude)` gespeichert
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -10,11 +10,15 @@ Löscht einen POI anhand seiner ID.
|
||||
|
||||
## Query-Parameter
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
|-----------|---------------------|
|
||||
| Parameter | Beschreibung |
|
||||
| --------- | -------------------- |
|
||||
| `id` | ID des POI (`idPoi`) |
|
||||
|
||||
## Antwort
|
||||
|
||||
- 200: Erfolgreich gelöscht
|
||||
- 404: POI nicht gefunden
|
||||
- 404: POI nicht gefunden
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -11,11 +11,15 @@ Gibt die Beschreibung eines POIs zurück.
|
||||
## Query-Parameter
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
|-----------|--------------|
|
||||
| --------- | ------------ |
|
||||
| `idPoi` | POI-ID |
|
||||
|
||||
## Antwort
|
||||
|
||||
```json
|
||||
{ "description": "POI A" }
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -15,7 +15,9 @@ Gibt eine Liste aller POIs und ihrer zugehörigen Icon-Pfade zurück.
|
||||
## Antwort
|
||||
|
||||
```json
|
||||
[
|
||||
{ "idPoi": 12, "path": "/icons/kue.svg" }
|
||||
]
|
||||
```
|
||||
[{ "idPoi": 12, "path": "/icons/kue.svg" }]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -14,4 +14,8 @@ Gibt alle POIs mit Positionen zurück.
|
||||
|
||||
## Besonderheiten
|
||||
|
||||
- Position wird per `ST_AsText(...)` als String geliefert
|
||||
- Position wird per `ST_AsText(...)` als String geliefert
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -20,4 +20,8 @@ Aktualisiert die Position (`POINT`) eines POIs.
|
||||
|
||||
## Antwort
|
||||
|
||||
- 200: `{ success: true }`
|
||||
- 200: `{ success: true }`
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -22,4 +22,8 @@ Aktualisiert Beschreibung, Typ und Gerät eines POIs.
|
||||
## Antwort
|
||||
|
||||
- 200: Erfolgreich aktualisiert
|
||||
- 404: POI nicht gefunden
|
||||
- 404: POI nicht gefunden
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -2,14 +2,16 @@
|
||||
|
||||
# 📊 API: /api/talas_v5_DB/priorityConfig
|
||||
|
||||
Diese API liefert die Konfigurationsdaten für Prioritäten (z. B. „critical“, „minor“) aus der Tabelle `prio`.
|
||||
Diese API liefert die Konfigurationsdaten für Prioritäten (z. B. „critical“, „minor“) aus der
|
||||
Tabelle `prio`.
|
||||
Sie wird u. a. für Meldungsanzeigen, Filter und Leaflet-Marker-Priorisierung verwendet.
|
||||
|
||||
---
|
||||
|
||||
## 📍 Anwendung in Leaflet – Marker-Priorität bei Überlappung
|
||||
|
||||
Die `level`-Werte dieser Konfiguration steuern die **Darstellungsreihenfolge überlappender Marker** in Leaflet:
|
||||
Die `level`-Werte dieser Konfiguration steuern die **Darstellungsreihenfolge überlappender Marker**
|
||||
in Leaflet:
|
||||
|
||||
- Marker mit **höherer Priorität** (`level = 1`, z. B. `critical`) werden **oben** dargestellt
|
||||
- Marker mit **niedriger Priorität** (`level = 100`, `101`) werden **weiter hinten** gezeichnet
|
||||
@@ -29,7 +31,8 @@ Diese Sortierung wird z. B. bei OverlappingMarkerSpiderfier oder Clustern ange
|
||||
|
||||
## 🧾 Beispielantwort
|
||||
|
||||
**Test-URL:** [`/api/talas_v5_DB/priorityConfig`](http://10.10.0.70:3000/api/talas_v5_DB/priorityConfig)
|
||||
**Test-URL:**
|
||||
[`/api/talas_v5_DB/priorityConfig`](http://10.10.0.70:3000/api/talas_v5_DB/priorityConfig)
|
||||
|
||||
```json
|
||||
[
|
||||
@@ -43,15 +46,11 @@ Diese Sortierung wird z. B. bei OverlappingMarkerSpiderfier oder Clustern ange
|
||||
]
|
||||
```
|
||||
|
||||
📦 Datenstruktur
|
||||
Feld Typ Beschreibung
|
||||
idprio number Eindeutige ID der Priorität
|
||||
level number Prioritätsstufe (1 = hoch, 100 = niedrig)
|
||||
name string Bezeichnung (z. B. "minor", "system", "Stationsausfall")
|
||||
color string HEX-Farbcode (z. B. #FF0000) zur visuellen Darstellung
|
||||
📦 Datenstruktur Feld Typ Beschreibung idprio number Eindeutige ID der Priorität level number
|
||||
Prioritätsstufe (1 = hoch, 100 = niedrig) name string Bezeichnung (z. B. "minor", "system",
|
||||
"Stationsausfall") color string HEX-Farbcode (z. B. #FF0000) zur visuellen Darstellung
|
||||
|
||||
⚙️ Datenquelle
|
||||
Tabelle: prio
|
||||
⚙️ Datenquelle Tabelle: prio
|
||||
|
||||
SQL-Abfrage:
|
||||
|
||||
@@ -73,11 +72,10 @@ Backend: verwendet getPool() aus utils/mysqlPool.js
|
||||
| `useCreateAndSetDevices.js` | Hook zur Initialisierung von Geräten auf der Karte |
|
||||
| `useDynamicMarkerLayers.js` | Verwaltet Marker-Layer dynamisch (inkl. Z-Priorität) |
|
||||
|
||||
❌ Fehlerbehandlung
|
||||
Bei DB- oder Verbindungsfehlern:
|
||||
❌ Fehlerbehandlung Bei DB- oder Verbindungsfehlern:
|
||||
|
||||
json
|
||||
Copy
|
||||
Edit
|
||||
{ "error": "Fehler bei der Abfrage" }
|
||||
HTTP-Statuscode: 500
|
||||
json Copy Edit { "error": "Fehler bei der Abfrage" } HTTP-Statuscode: 500
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../README.md)
|
||||
|
||||
4
docs/pages/api/talas_v5_DB/station/README.md
Normal file
4
docs/pages/api/talas_v5_DB/station/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# 📄 Übersicht: docs/pages/api/talas_v5_DB/station
|
||||
|
||||
- [getAllStationsNames](getAllStationsNames.md)
|
||||
- [getDevices](getDevices.md)
|
||||
@@ -26,4 +26,8 @@ Liefert eine Mapping-Tabelle aus `idLD` → `name` aller Einträge in `location_
|
||||
## Fehler
|
||||
|
||||
- 404: Wenn keine Daten vorhanden
|
||||
- 500: Datenbankfehler
|
||||
- 500: Datenbankfehler
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
@@ -37,4 +37,8 @@ Gibt alle Geräte aus der `devices`-Tabelle zurück.
|
||||
## Fehler
|
||||
|
||||
- 404: Keine Ergebnisse
|
||||
- 500: Datenbankfehler
|
||||
- 500: Datenbankfehler
|
||||
|
||||
---
|
||||
|
||||
[Zurück zur Übersicht](../../../../README.md)
|
||||
|
||||
Reference in New Issue
Block a user