docs
This commit is contained in:
37
docs/services/database/area/updateAreaService.md
Normal file
37
docs/services/database/area/updateAreaService.md
Normal file
@@ -0,0 +1,37 @@
|
||||
<!-- /docs/services/database/area/updateAreaService.md -->
|
||||
|
||||
# 🗺️ updateAreaService.js
|
||||
|
||||
Service zur Aktualisierung der Koordinaten eines Bereichs (Area) in der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await updateAreaService({
|
||||
idLocation: 4,
|
||||
idMap: 1,
|
||||
newCoords: { x: 53.219, y: 8.435 }
|
||||
});
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
PUT /api/talas_v5_DB/area/updateArea
|
||||
```
|
||||
|
||||
## Payload
|
||||
|
||||
```json
|
||||
{
|
||||
"idLocation": 4,
|
||||
"idMap": 1,
|
||||
"x": 53.219,
|
||||
"y": 8.435
|
||||
}
|
||||
```
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- Erfolgreich: JSON mit Erfolgsmeldung
|
||||
- Fehler: `throw new Error(...)` bei nicht OK
|
||||
@@ -1,5 +1,22 @@
|
||||
# fetchDeviceNameByIdService
|
||||
<!-- /docs/services/database/fetchDeviceNameByIdService.md -->
|
||||
|
||||
Liest Gerätenamen über die eigene Next.js-API.
|
||||
# 🆔 fetchDeviceNameByIdService.js
|
||||
|
||||
**Route:** `/api/talas_v5_DB/locationDevice/locationDeviceNameById?idLD={idLD}`
|
||||
Lädt den Gerätenamen (`name`) anhand der ID (`idLD`) von der API.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const name = await fetchDeviceNameById(idLD);
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/locationDevice/locationDeviceNameById?idLD=...
|
||||
```
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- Erfolgreich: Gerätebezeichnung als `string`
|
||||
- Fehler: `"Unbekannt"`
|
||||
@@ -1,65 +0,0 @@
|
||||
# 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 |
|
||||
21
docs/services/database/fetchLocationDevicesService.md
Normal file
21
docs/services/database/fetchLocationDevicesService.md
Normal file
@@ -0,0 +1,21 @@
|
||||
<!-- /docs/services/database/fetchLocationDevicesService.md -->
|
||||
|
||||
# 🧰 fetchLocationDevicesService.js
|
||||
|
||||
Service zum Abrufen aller Einträge aus der `location_device` Tabelle.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const result = await fetchLocationDevicesService();
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/locationDevice/locationDevices
|
||||
```
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- JSON-Array aller Geräte
|
||||
@@ -1,5 +0,0 @@
|
||||
# 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)
|
||||
17
docs/services/database/fetchPriorityConfigService.md
Normal file
17
docs/services/database/fetchPriorityConfigService.md
Normal file
@@ -0,0 +1,17 @@
|
||||
<!-- /docs/services/database/fetchPriorityConfigService.md -->
|
||||
|
||||
# 🎯 fetchPriorityConfigService.js
|
||||
|
||||
Service zum Abrufen der Prioritätskonfiguration für POIs oder Marker.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const result = await fetchPriorityConfigService();
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/priorityConfig
|
||||
```
|
||||
22
docs/services/database/getDeviceIdByNameService.md
Normal file
22
docs/services/database/getDeviceIdByNameService.md
Normal file
@@ -0,0 +1,22 @@
|
||||
<!-- /docs/services/database/getDeviceIdByNameService.md -->
|
||||
|
||||
# 🆔 getDeviceIdByNameService.js
|
||||
|
||||
Service zur Ermittlung der Geräte-ID (`idLD`) anhand eines Gerätenamens.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const id = await getDeviceIdByNameService("CPL-V4");
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/locationDevice/getDeviceId?deviceName=...
|
||||
```
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- Erfolgreich: `idLD` (number)
|
||||
- Fehler: Exception
|
||||
@@ -0,0 +1,21 @@
|
||||
<!-- /docs/services/database/fetchLocationDevicesService.md -->
|
||||
|
||||
# 🧰 fetchLocationDevicesService.js
|
||||
|
||||
Service zum Abrufen aller Einträge aus der `location_device` Tabelle.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const result = await fetchLocationDevicesService();
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/locationDevice/locationDevices
|
||||
```
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- JSON-Array aller Geräte
|
||||
22
docs/services/database/pois/addPoiService.md
Normal file
22
docs/services/database/pois/addPoiService.md
Normal file
@@ -0,0 +1,22 @@
|
||||
<!-- /docs/services/database/pois/addPoiService.md -->
|
||||
|
||||
# ➕ addPoiService.js
|
||||
|
||||
Service zum Hinzufügen eines neuen POIs in der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await addPoiService({
|
||||
name: "Beispiel",
|
||||
poiTypeId: 1,
|
||||
idLD: 12,
|
||||
latitude: 53.21,
|
||||
longitude: 8.43
|
||||
});
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `POST /api/talas_v5_DB/pois/addPoi`
|
||||
- Headers: `"Content-Type": "application/json"`
|
||||
15
docs/services/database/pois/deletePoiService.md
Normal file
15
docs/services/database/pois/deletePoiService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/deletePoiService.md -->
|
||||
|
||||
# ❌ deletePoiService.js
|
||||
|
||||
Service zum Löschen eines POIs aus der Datenbank per ID.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await deletePoiService(id);
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `DELETE /api/talas_v5_DB/pois/deletePoi?id=ID`
|
||||
15
docs/services/database/pois/fetchPoiDataByIdService.md
Normal file
15
docs/services/database/pois/fetchPoiDataByIdService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/fetchPoiDataByIdService.md -->
|
||||
|
||||
# 🔍 fetchPoiDataByIdService.js
|
||||
|
||||
Service zum Abrufen der POI-Daten anhand einer POI-ID.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const poi = await fetchPoiDataService(idPoi);
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/pois/getPoiById?idPoi=ID`
|
||||
15
docs/services/database/pois/fetchPoiDataService.md
Normal file
15
docs/services/database/pois/fetchPoiDataService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/fetchPoiDataService.md -->
|
||||
|
||||
# 📄 fetchPoiDataService.js
|
||||
|
||||
Lädt POI-Icons (alias `poiData`) aus dem Serververzeichnis.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const data = await fetchPoiDataService();
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
|
||||
15
docs/services/database/pois/fetchPoiIconsDataService.md
Normal file
15
docs/services/database/pois/fetchPoiIconsDataService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/fetchPoiIconsDataService.md -->
|
||||
|
||||
# 🖼️ fetchPoiIconsDataService.js
|
||||
|
||||
Service zum Abrufen der POI-Icon-Metadaten.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const icons = await fetchPoiIconsDataService();
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/pois/poi-icons`
|
||||
15
docs/services/database/pois/fetchPoiMarkersService.md
Normal file
15
docs/services/database/pois/fetchPoiMarkersService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/fetchPoiMarkersService.md -->
|
||||
|
||||
# 📍 fetchPoiMarkersService.js
|
||||
|
||||
Service zum Abrufen aller gespeicherten POI-Marker (Positionen).
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const pois = await fetchPoiMarkersService();
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/pois/readAllPOIs`
|
||||
15
docs/services/database/pois/fetchPoiTypService.md
Normal file
15
docs/services/database/pois/fetchPoiTypService.md
Normal file
@@ -0,0 +1,15 @@
|
||||
<!-- /docs/services/database/pois/fetchPoiTypService.md -->
|
||||
|
||||
# 🗂️ fetchPoiTypService.js
|
||||
|
||||
Service zum Abrufen aller verfügbaren POI-Typen aus der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const types = await fetchPoiTypService();
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/poiTyp/readPoiTyp`
|
||||
21
docs/services/database/pois/updatePoiService.md
Normal file
21
docs/services/database/pois/updatePoiService.md
Normal file
@@ -0,0 +1,21 @@
|
||||
<!-- /docs/services/database/pois/updatePoiService.md -->
|
||||
|
||||
# 📝 updatePoiService.js
|
||||
|
||||
Service zur Aktualisierung eines POIs mit neuen Informationen.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await updatePoiService({
|
||||
idPoi: 5,
|
||||
description: "Neuer Text",
|
||||
idLD: 3,
|
||||
idPoiTyp: 1
|
||||
});
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `POST /api/talas_v5_DB/pois/updatePoi`
|
||||
- Body: JSON mit den zu aktualisierenden Feldern
|
||||
19
docs/services/database/polylines/fetchGisLinesService.md
Normal file
19
docs/services/database/polylines/fetchGisLinesService.md
Normal file
@@ -0,0 +1,19 @@
|
||||
<!-- /docs/services/database/polylines/fetchGisLinesService.md -->
|
||||
|
||||
# 📡 fetchGisLinesService.js
|
||||
|
||||
Service zum Abrufen aller Linien aus der `gisLines`-Tabelle der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
const lines = await fetchGisLinesService();
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `GET /api/talas_v5_DB/gisLines/readGisLines`
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- JSON-Array mit allen Linien und ihren Koordinaten
|
||||
@@ -0,0 +1,24 @@
|
||||
<!-- /docs/services/database/polylines/updatePolylineCoordinatesService.md -->
|
||||
|
||||
# 🧭 updatePolylineCoordinatesService.js
|
||||
|
||||
Service zum Aktualisieren der Koordinaten einer Linie in der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await updatePolylineCoordinatesService({
|
||||
idLD: 5,
|
||||
idModul: 1,
|
||||
newCoordinates: [[53.2, 8.4], [53.21, 8.45]]
|
||||
});
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
- Endpoint: `POST /api/talas_v5_DB/gisLines/updateLineCoordinates`
|
||||
- Headers: `{ "Content-Type": "application/json" }`
|
||||
|
||||
## Fehlerbehandlung
|
||||
|
||||
- Bei Fehler: `throw new Error(...)` mit Backend-Meldung
|
||||
@@ -1,6 +1,21 @@
|
||||
# updateLocationInDatabaseService
|
||||
<!-- /docs/services/database/updateLocationInDatabaseService.md -->
|
||||
|
||||
Aktualisiert die Position eines POIs in der Datenbank.
|
||||
# 📍 updateLocationInDatabaseService.js
|
||||
|
||||
- Methode: `POST`
|
||||
- Route: `/api/talas_v5_DB/pois/updateLocation`
|
||||
Service zur Aktualisierung der Geokoordinaten eines POIs in der Datenbank.
|
||||
|
||||
## Verwendung
|
||||
|
||||
```js
|
||||
await updateLocationInDatabaseService(id, lat, lng);
|
||||
```
|
||||
|
||||
## API-Route
|
||||
|
||||
```
|
||||
/api/talas_v5_DB/pois/updateLocation
|
||||
```
|
||||
|
||||
## Methode
|
||||
|
||||
- `POST` mit JSON-Body: `{ id, latitude, longitude }`
|
||||
Reference in New Issue
Block a user