API

Parzellen-Endpunkt

🚧 In Vorbereitung — die hier beschriebenen Endpunkte existieren noch nicht. Siehe API-Übersicht.

#GET /api/v1/plots

Gibt alle Parzellen des Vereins zurück.

#Anfrage

 1GET /api/v1/plots
 2Authorization: Bearer {ihr-api-token}

#Antwort

 1{
 2  "data": [
 3    {
 4      "id": "uuid",
 5      "number": "42",
 6      "area": 44.70,
 7      "group": "Gruppe A",
 8      "path": "Hauptweg",
 9      "members": [
10        {
11          "id": "uuid",
12          "full_name": "Max Mustermann",
13          "email": "max@example.com",
14          "is_first_member": true
15        }
16      ],
17      "active_water_clock": {
18        "water_clock_number": "WZ-12345",
19        "expires_in": 2028
20      }
21    }
22  ],
23  "links": {...},
24  "meta": {...}
25}

#Parameter

Parameter Typ Beschreibung
page integer Seitennummer (Standard: 1)
per_page integer Einträge pro Seite (Standard: 25, Max: 100)

#GET /api/v1/plots/{id}

Gibt eine einzelne Parzelle mit allen Beziehungen zurück.

#Anfrage

 1GET /api/v1/plots/550e8400-e29b-41d4-a716-446655440000
 2Authorization: Bearer {ihr-api-token}

#Antwort

Gleiche Struktur wie ein einzelnes Objekt aus der Listantwort, aber mit zusätzlichen Details.

#Fehler

Status Beschreibung
404 Parzelle nicht gefunden oder gehört nicht zum Verein des Tokens