docs
This commit is contained in:
25
docs/pages/api/talas_v5_DB/pois/addPoi.md
Normal file
25
docs/pages/api/talas_v5_DB/pois/addPoi.md
Normal file
@@ -0,0 +1,25 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/addPoi.md -->
|
||||
|
||||
# ➕ addPoi.js
|
||||
|
||||
Fügt einen neuen POI (Point of Interest) zur Datenbank hinzu.
|
||||
|
||||
## Methode
|
||||
|
||||
- `POST`
|
||||
|
||||
## Request-Body
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "POI A",
|
||||
"poiTypeId": 1,
|
||||
"latitude": 53.2,
|
||||
"longitude": 8.1,
|
||||
"idLD": 27
|
||||
}
|
||||
```
|
||||
|
||||
## Besonderheiten
|
||||
|
||||
- Position wird als `POINT(longitude latitude)` gespeichert
|
||||
20
docs/pages/api/talas_v5_DB/pois/deletePoi.md
Normal file
20
docs/pages/api/talas_v5_DB/pois/deletePoi.md
Normal file
@@ -0,0 +1,20 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/deletePoi.md -->
|
||||
|
||||
# ❌ deletePoi.js
|
||||
|
||||
Löscht einen POI anhand seiner ID.
|
||||
|
||||
## Methode
|
||||
|
||||
- `DELETE`
|
||||
|
||||
## Query-Parameter
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
|-----------|---------------------|
|
||||
| `id` | ID des POI (`idPoi`) |
|
||||
|
||||
## Antwort
|
||||
|
||||
- 200: Erfolgreich gelöscht
|
||||
- 404: POI nicht gefunden
|
||||
21
docs/pages/api/talas_v5_DB/pois/getPoiById.md
Normal file
21
docs/pages/api/talas_v5_DB/pois/getPoiById.md
Normal file
@@ -0,0 +1,21 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/getPoiById.md -->
|
||||
|
||||
# 🔎 getPoiById.js
|
||||
|
||||
Gibt die Beschreibung eines POIs zurück.
|
||||
|
||||
## Methode
|
||||
|
||||
- `GET`
|
||||
|
||||
## Query-Parameter
|
||||
|
||||
| Parameter | Beschreibung |
|
||||
|-----------|--------------|
|
||||
| `idPoi` | POI-ID |
|
||||
|
||||
## Antwort
|
||||
|
||||
```json
|
||||
{ "description": "POI A" }
|
||||
```
|
||||
21
docs/pages/api/talas_v5_DB/pois/poi-icons.md
Normal file
21
docs/pages/api/talas_v5_DB/pois/poi-icons.md
Normal file
@@ -0,0 +1,21 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/poi-icons.md -->
|
||||
|
||||
# 🖼️ poi-icons.js
|
||||
|
||||
Gibt eine Liste aller POIs und ihrer zugehörigen Icon-Pfade zurück.
|
||||
|
||||
## Methode
|
||||
|
||||
- `GET`
|
||||
|
||||
## Datenquelle
|
||||
|
||||
- `poi` → `poiTyp` → `poiicons`
|
||||
|
||||
## Antwort
|
||||
|
||||
```json
|
||||
[
|
||||
{ "idPoi": 12, "path": "/icons/kue.svg" }
|
||||
]
|
||||
```
|
||||
17
docs/pages/api/talas_v5_DB/pois/readAllPOIs.md
Normal file
17
docs/pages/api/talas_v5_DB/pois/readAllPOIs.md
Normal file
@@ -0,0 +1,17 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/readAllPOIs.md -->
|
||||
|
||||
# 📋 readAllPOIs.js
|
||||
|
||||
Gibt alle POIs mit Positionen zurück.
|
||||
|
||||
## Methode
|
||||
|
||||
- `GET`
|
||||
|
||||
## Rückgabe
|
||||
|
||||
- JSON-Array mit `idPoi`, `description`, `idPoiTyp`, `idLD`, `position`
|
||||
|
||||
## Besonderheiten
|
||||
|
||||
- Position wird per `ST_AsText(...)` als String geliefert
|
||||
23
docs/pages/api/talas_v5_DB/pois/updateLocation.md
Normal file
23
docs/pages/api/talas_v5_DB/pois/updateLocation.md
Normal file
@@ -0,0 +1,23 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/updateLocation.md -->
|
||||
|
||||
# 🧭 updateLocation.js
|
||||
|
||||
Aktualisiert die Position (`POINT`) eines POIs.
|
||||
|
||||
## Methode
|
||||
|
||||
- `POST`
|
||||
|
||||
## Request-Body
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 12,
|
||||
"latitude": 53.2,
|
||||
"longitude": 8.1
|
||||
}
|
||||
```
|
||||
|
||||
## Antwort
|
||||
|
||||
- 200: `{ success: true }`
|
||||
25
docs/pages/api/talas_v5_DB/pois/updatePoi.md
Normal file
25
docs/pages/api/talas_v5_DB/pois/updatePoi.md
Normal file
@@ -0,0 +1,25 @@
|
||||
<!-- /docs/pages/api/talas_v5_DB/pois/updatePoi.md -->
|
||||
|
||||
# 📝 updatePoi.js
|
||||
|
||||
Aktualisiert Beschreibung, Typ und Gerät eines POIs.
|
||||
|
||||
## Methode
|
||||
|
||||
- `POST`
|
||||
|
||||
## Request-Body
|
||||
|
||||
```json
|
||||
{
|
||||
"idPoi": 12,
|
||||
"description": "POI A",
|
||||
"idPoiTyp": 2,
|
||||
"idLD": 27
|
||||
}
|
||||
```
|
||||
|
||||
## Antwort
|
||||
|
||||
- 200: Erfolgreich aktualisiert
|
||||
- 404: POI nicht gefunden
|
||||
Reference in New Issue
Block a user