docs: [Zurück zur Übersicht](../README.md) in Alle in README für jeder Verzeichnis

This commit is contained in:
ISA
2025-06-24 08:22:48 +02:00
parent 82a1e11797
commit 0347ec9d98
243 changed files with 1425 additions and 283 deletions

View File

@@ -0,0 +1,7 @@
# 📄 Übersicht: docs/services/database
- [fetchDeviceNameByIdService](fetchDeviceNameByIdService.md)
- [fetchLocationDevicesService](fetchLocationDevicesService.md)
- [fetchPriorityConfigService](fetchPriorityConfigService.md)
- [getDeviceIdByNameService](getDeviceIdByNameService.md)
- [updateLocationInDatabaseService](updateLocationInDatabaseService.md)

View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/services/database/area
- [updateAreaService](updateAreaService.md)

View File

@@ -10,7 +10,7 @@ Service zur Aktualisierung der Koordinaten eines Bereichs (Area) in der Datenban
await updateAreaService({
idLocation: 4,
idMap: 1,
newCoords: { x: 53.219, y: 8.435 }
newCoords: { x: 53.219, y: 8.435 },
});
```
@@ -34,4 +34,8 @@ PUT /api/talas_v5_DB/area/updateArea
## Rückgabe
- Erfolgreich: JSON mit Erfolgsmeldung
- Fehler: `throw new Error(...)` bei nicht OK
- Fehler: `throw new Error(...)` bei nicht OK
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -19,4 +19,8 @@ const name = await fetchDeviceNameById(idLD);
## Rückgabe
- Erfolgreich: Gerätebezeichnung als `string`
- Fehler: `"Unbekannt"`
- Fehler: `"Unbekannt"`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -18,4 +18,8 @@ const result = await fetchLocationDevicesService();
## Rückgabe
- JSON-Array aller Geräte
- JSON-Array aller Geräte
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -14,4 +14,8 @@ const result = await fetchPriorityConfigService();
```
/api/talas_v5_DB/priorityConfig
```
```
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -19,4 +19,8 @@ const id = await getDeviceIdByNameService("CPL-V4");
## Rückgabe
- Erfolgreich: `idLD` (number)
- Fehler: Exception
- Fehler: Exception
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/services/database/locationDevice
- [fetchLocationDevicesService](fetchLocationDevicesService.md)

View File

@@ -18,4 +18,8 @@ const result = await fetchLocationDevicesService();
## Rückgabe
- JSON-Array aller Geräte
- JSON-Array aller Geräte
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -0,0 +1,10 @@
# 📄 Übersicht: docs/services/database/pois
- [addPoiService](addPoiService.md)
- [deletePoiService](deletePoiService.md)
- [fetchPoiDataByIdService](fetchPoiDataByIdService.md)
- [fetchPoiDataService](fetchPoiDataService.md)
- [fetchPoiIconsDataService](fetchPoiIconsDataService.md)
- [fetchPoiMarkersService](fetchPoiMarkersService.md)
- [fetchPoiTypService](fetchPoiTypService.md)
- [updatePoiService](updatePoiService.md)

View File

@@ -12,11 +12,15 @@ await addPoiService({
poiTypeId: 1,
idLD: 12,
latitude: 53.21,
longitude: 8.43
longitude: 8.43,
});
```
## API
- Endpoint: `POST /api/talas_v5_DB/pois/addPoi`
- Headers: `"Content-Type": "application/json"`
- Headers: `"Content-Type": "application/json"`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ await deletePoiService(id);
## API
- Endpoint: `DELETE /api/talas_v5_DB/pois/deletePoi?id=ID`
- Endpoint: `DELETE /api/talas_v5_DB/pois/deletePoi?id=ID`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ const poi = await fetchPoiDataService(idPoi);
## API
- Endpoint: `GET /api/talas_v5_DB/pois/getPoiById?idPoi=ID`
- Endpoint: `GET /api/talas_v5_DB/pois/getPoiById?idPoi=ID`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ const data = await fetchPoiDataService();
## API
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ const icons = await fetchPoiIconsDataService();
## API
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ const pois = await fetchPoiMarkersService();
## API
- Endpoint: `GET /api/talas_v5_DB/pois/readAllPOIs`
- Endpoint: `GET /api/talas_v5_DB/pois/readAllPOIs`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -12,4 +12,8 @@ const types = await fetchPoiTypService();
## API
- Endpoint: `GET /api/talas_v5_DB/poiTyp/readPoiTyp`
- Endpoint: `GET /api/talas_v5_DB/poiTyp/readPoiTyp`
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -11,11 +11,15 @@ await updatePoiService({
idPoi: 5,
description: "Neuer Text",
idLD: 3,
idPoiTyp: 1
idPoiTyp: 1,
});
```
## API
- Endpoint: `POST /api/talas_v5_DB/pois/updatePoi`
- Body: JSON mit den zu aktualisierenden Feldern
- Body: JSON mit den zu aktualisierenden Feldern
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -0,0 +1,4 @@
# 📄 Übersicht: docs/services/database/polylines
- [fetchGisLinesService](fetchGisLinesService.md)
- [updatePolylineCoordinatesService](updatePolylineCoordinatesService.md)

View File

@@ -16,4 +16,8 @@ const lines = await fetchGisLinesService();
## Rückgabe
- JSON-Array mit allen Linien und ihren Koordinaten
- JSON-Array mit allen Linien und ihren Koordinaten
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -10,7 +10,10 @@ Service zum Aktualisieren der Koordinaten einer Linie in der Datenbank.
await updatePolylineCoordinatesService({
idLD: 5,
idModul: 1,
newCoordinates: [[53.2, 8.4], [53.21, 8.45]]
newCoordinates: [
[53.2, 8.4],
[53.21, 8.45],
],
});
```
@@ -21,4 +24,8 @@ await updatePolylineCoordinatesService({
## Fehlerbehandlung
- Bei Fehler: `throw new Error(...)` mit Backend-Meldung
- Bei Fehler: `throw new Error(...)` mit Backend-Meldung
---
[Zurück zur Übersicht](../../../README.md)

View File

@@ -18,4 +18,8 @@ await updateLocationInDatabaseService(id, lat, lng);
## Methode
- `POST` mit JSON-Body: `{ id, latitude, longitude }`
- `POST` mit JSON-Body: `{ id, latitude, longitude }`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -0,0 +1,3 @@
# 📄 Übersicht: docs/services/utils
- [fetchWithTimeout](fetchWithTimeout.md)

View File

@@ -8,7 +8,8 @@ Hilfsfunktion zur Durchführung eines `fetch`-Requests mit einem Timeout.
## 💡 Zweck
Manche Serveranfragen können hängen bleiben. Diese Funktion sorgt dafür, dass eine Anfrage nach einer bestimmten Zeit abgebrochen wird, um UI-Blockierungen oder lange Wartezeiten zu vermeiden.
Manche Serveranfragen können hängen bleiben. Diese Funktion sorgt dafür, dass eine Anfrage nach
einer bestimmten Zeit abgebrochen wird, um UI-Blockierungen oder lange Wartezeiten zu vermeiden.
---
@@ -43,4 +44,8 @@ const response = await fetchWithTimeout("/api/data", {}, 3000);
```
/services/utils/fetchWithTimeout.js
```
```
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -0,0 +1,8 @@
# 📄 Übersicht: docs/services/webservice
- [fetchGisLinesStatusService](fetchGisLinesStatusService.md)
- [fetchGisStationsMeasurementsService](fetchGisStationsMeasurementsService.md)
- [fetchGisStationsStaticDistrictService](fetchGisStationsStaticDistrictService.md)
- [fetchGisStationsStatusDistrictService](fetchGisStationsStatusDistrictService.md)
- [fetchGisSystemStaticService](fetchGisSystemStaticService.md)
- [fetchUserRightsService](fetchUserRightsService.md)

View File

@@ -58,3 +58,7 @@ Lädt Linienstatus-Daten über den TALAS WebService.
| `fetchGisLinesStatusThunk.js` | Redux Thunk |
| `gisLinesStatusSlice.js` | Redux Slice |
| `store.js` | Integration des Slices |
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,4 +13,8 @@ const messwerte = await fetchGisStationsMeasurementsService();
## API-Aufruf
- Endpoint: `/ClientData/WebServiceMap.asmx/GisStationsMeasurements?idMap=...&idUser=...`
- Rückgabe: `Statis[]`
- Rückgabe: `Statis[]`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,4 +13,8 @@ const points = await fetchGisStationsStaticDistrictService();
## API-Aufruf
- Endpoint: `/ClientData/WebServiceMap.asmx/GisStationsStaticDistrict?idMap=...&idUser=...`
- Rückgabe: `Points[]`
- Rückgabe: `Points[]`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,4 +13,8 @@ const result = await fetchGisStationsStatusDistrictService();
## API-Aufruf
- Endpoint: `/ClientData/WebServiceMap.asmx/GisStationsStatusDistrict?idMap=...&idUser=...`
- Rückgabe: `Statis[]`
- Rückgabe: `Statis[]`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,4 +13,8 @@ const systems = await fetchGisSystemStaticService();
## API-Aufruf
- Endpoint: `/ClientData/WebServiceMap.asmx/GisSystemStatic?idMap=...&idUser=...`
- Rückgabe: `Systems[]`
- Rückgabe: `Systems[]`
---
[Zurück zur Übersicht](../../README.md)

View File

@@ -13,4 +13,8 @@ const rights = await fetchUserRightsService();
## API-Aufruf
- Endpoint: `/ClientData/WebServiceMap.asmx/GisSystemStatic?idMap=...&idUser=...`
- Rückgabe: `Rights[]` (Fallback: `[]`)
- Rückgabe: `Rights[]` (Fallback: `[]`)
---
[Zurück zur Übersicht](../../README.md)