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:
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