docs: Projektstruktur der Dokumentation an Quellcode angepasst
- Verzeichnisstruktur unter /docs spiegelt nun die tatsächliche Projektstruktur wider - frontend/server-Trennung entfernt zugunsten von /docs/pages, /docs/redux, /docs/utils etc. - Erhöht Wiederauffindbarkeit, Übersichtlichkeit und Entwicklerfreundlichkeit
This commit is contained in:
5
docs/services/database/fetchDeviceNameByIdService.md
Normal file
5
docs/services/database/fetchDeviceNameByIdService.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# fetchDeviceNameByIdService
|
||||
|
||||
Liest Gerätenamen über die eigene Next.js-API.
|
||||
|
||||
**Route:** `/api/talas_v5_DB/locationDevice/locationDeviceNameById?idLD={idLD}`
|
||||
65
docs/services/database/fetchGisLinesService.md
Normal file
65
docs/services/database/fetchGisLinesService.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# fetchGisLinesService
|
||||
|
||||
Lädt Linien-Geometriedaten über die interne Datenbank-API.
|
||||
|
||||
---
|
||||
|
||||
## 📁 URL-Aufbau
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/gisLines/readGisLines
|
||||
```
|
||||
|
||||
- Die Daten werden nicht über einen WebService geladen, sondern über einen internen Datenbank-Endpunkt im Backend (API Route).
|
||||
- Es handelt sich um Polyline-Daten (z. B. Kabelverbindungen).
|
||||
|
||||
---
|
||||
|
||||
## ✅ Rückgabe
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"idLD": 12345,
|
||||
"idModul": 6,
|
||||
"points": [
|
||||
{ "x": 8.123, "y": 53.456 },
|
||||
{ "x": 8.124, "y": 53.457 }
|
||||
]
|
||||
},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
- `points[]` enthält die Koordinaten der Liniensegmente
|
||||
- Die Struktur ist geeignet für Leaflet-Polyline-Rendering
|
||||
|
||||
---
|
||||
|
||||
## ❗ Unterschied zu `gisLinesStatusSlice` (WebService)
|
||||
|
||||
| Eigenschaft | `gisLines` (Datenbank) | `gisLinesStatus` (WebService) |
|
||||
| ----------- | -------------------------------- | ----------------------------------- |
|
||||
| Quelle | `/api/talas_v5_DB/gisLines` | `WebServiceMap.asmx/GisLinesStatus` |
|
||||
| Daten | Liniengeometrien (`points`) | Status, Meldungen, Farben, Werte |
|
||||
| Typ | Polyline-Rendering | Statusanzeige für Linien |
|
||||
| Nutzung | Anzeige der Linien auf der Karte | Visualisierung von Fehlern/Farben |
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Verwendung im Frontend
|
||||
|
||||
- Daten werden über `fetchGisLinesThunk` geladen.
|
||||
- Sie landen im Redux Slice `gisLinesSlice`.
|
||||
- Zugriff über: `selectGisLines(state)`
|
||||
|
||||
---
|
||||
|
||||
## 📁 Zugehörige Dateien
|
||||
|
||||
| Datei | Zweck |
|
||||
| ------------------------- | --------------------------- |
|
||||
| `fetchGisLinesService.js` | Datenbank-Aufruf für Linien |
|
||||
| `fetchGisLinesThunk.js` | Redux Thunk |
|
||||
| `gisLinesSlice.js` | Redux Slice |
|
||||
| `store.js` | Integration des Slices |
|
||||
5
docs/services/database/fetchPoiDataService.md
Normal file
5
docs/services/database/fetchPoiDataService.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# fetchPoiDataService
|
||||
|
||||
Lädt POI-Daten über API `/api/talas_v5_DB/pois/getPoiById?idPoi={idPoi}`
|
||||
|
||||
- Rückgabe: Objekt mit POI-Infos (id, name, description, idLD)
|
||||
@@ -0,0 +1,6 @@
|
||||
# updateLocationInDatabaseService
|
||||
|
||||
Aktualisiert die Position eines POIs in der Datenbank.
|
||||
|
||||
- Methode: `POST`
|
||||
- Route: `/api/talas_v5_DB/pois/updateLocation`
|
||||
6
docs/services/utils/fetchWithTimeout.md
Normal file
6
docs/services/utils/fetchWithTimeout.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# fetchWithTimeout
|
||||
|
||||
Hilfsfunktion für Fetch mit Abbruch bei Timeout.
|
||||
|
||||
- Parameter: URL, Optionen, Timeout (default: 5000ms)
|
||||
- Nutzt `AbortController`
|
||||
58
docs/services/webservice/fetchGisLinesStatusService.md
Normal file
58
docs/services/webservice/fetchGisLinesStatusService.md
Normal file
@@ -0,0 +1,58 @@
|
||||
# fetchGisLinesStatusService
|
||||
|
||||
Lädt Linienstatus-Daten über den TALAS WebService.
|
||||
|
||||
---
|
||||
|
||||
## 📁 URL-Aufbau
|
||||
|
||||
```
|
||||
/ClientData/WebServiceMap.asmx/GisLinesStatus?idMap={idMap}
|
||||
```
|
||||
|
||||
* Die `idMap` wird automatisch aus der URL (`?m=...`) gelesen.
|
||||
* Diese WebService-Antwort enthält ein Objekt mit dem Feld `Statis[]`.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Rückgabe
|
||||
|
||||
```json
|
||||
{
|
||||
"Name": "...",
|
||||
"Statis": [ ... ]
|
||||
}
|
||||
```
|
||||
|
||||
* `Statis[]` enthält Statusinformationen zu Linien (Farben, Meldungen, Werte).
|
||||
* Diese Daten sind **nicht identisch** mit `gisLines.data` aus der Datenbank.
|
||||
|
||||
---
|
||||
|
||||
## ❗ Unterschied zu `gisLinesSlice` (aus der Datenbank)
|
||||
|
||||
| Eigenschaft | `gisLines` (DB) | `gisLinesStatus` (WebService) |
|
||||
| ----------- | --------------------------- | ----------------------------------- |
|
||||
| Quelle | `api/talas_v5_DB/gisLines` | `WebServiceMap.asmx/GisLinesStatus` |
|
||||
| Daten | Liniengeometrien (`points`) | Status, Meldungen, Farben, Werte |
|
||||
| Typ | `PolyLine-Daten` | `Statusanzeige` für Linien |
|
||||
| Nutzung | Layer-Rendering | Farbliche Darstellung / Tooltip |
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Verwendung im Frontend
|
||||
|
||||
* Die Daten werden über `fetchGisLinesStatusThunk` geladen.
|
||||
* Sie landen im Redux Slice `gisLinesStatusSlice`.
|
||||
* Zugriff über: `selectGisLinesStatus(state)` → enthält `.data`, `.status`, `.error`
|
||||
|
||||
---
|
||||
|
||||
## 📁 Zugehörige Dateien
|
||||
|
||||
| Datei | Zweck |
|
||||
| ------------------------------- | ---------------------- |
|
||||
| `fetchGisLinesStatusService.js` | WebService-Aufruf |
|
||||
| `fetchGisLinesStatusThunk.js` | Redux Thunk |
|
||||
| `gisLinesStatusSlice.js` | Redux Slice |
|
||||
| `store.js` | Integration des Slices |
|
||||
@@ -0,0 +1,8 @@
|
||||
# fetchGisStationsMeasurementsService
|
||||
|
||||
Lädt GIS-Messwerte über den TALAS WebService.
|
||||
|
||||
**URL-Aufbau:** `/ClientData/WebServiceMap.asmx/GisStationsMeasurements?idMap={idMap}&idUser={idUser}`
|
||||
|
||||
- Holt Daten direkt basierend auf der URL (?m= & ?u=).
|
||||
- Rückgabewert: `Statis[]`
|
||||
@@ -0,0 +1,8 @@
|
||||
# fetchGisStationsStaticDistrictService
|
||||
|
||||
Lädt GIS-Stationen (statisch) für Bezirke.
|
||||
|
||||
**Rückgabe:** `Points[]`
|
||||
|
||||
- Holt `idMap` und `idUser` aus der URL.
|
||||
- WebService: `GisStationsStaticDistrict`
|
||||
@@ -0,0 +1,7 @@
|
||||
# fetchGisStationsStatusDistrictService
|
||||
|
||||
Lädt den Status der GIS-Bezirksstationen.
|
||||
|
||||
**Rückgabe:** `Statis[]`
|
||||
|
||||
- Nutzt die WebService-URL `GisStationsStatusDistrict`.
|
||||
6
docs/services/webservice/fetchGisSystemStaticService.md
Normal file
6
docs/services/webservice/fetchGisSystemStaticService.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# fetchGisSystemStaticService
|
||||
|
||||
Lädt Systemübersicht vom GIS WebService.
|
||||
|
||||
- Rückgabe: `Systems[]`
|
||||
- Liest `?m` und `?u` aus der URL.
|
||||
6
docs/services/webservice/fetchUserRightsService.md
Normal file
6
docs/services/webservice/fetchUserRightsService.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# fetchUserRightsService
|
||||
|
||||
Lädt Benutzerrechte über WebService.
|
||||
|
||||
- Falls `USE_MOCK_API` gesetzt ist → werden Fake-Daten zurückgegeben.
|
||||
- Rückgabe: Liste von `IdRight`
|
||||
Reference in New Issue
Block a user