Referenz: Barrierenprüfungen (/v1/barrier-checks)

Prüfergebnisse einzelner Barrieren. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

Schlüssel mit dem Recht barrier_checks:read bzw. barrier_checks:write Grundlagen aus „Erste Anfrage an die elyph API“

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/barrier-checks liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: barrier_checks:read.
curl
curl -sS "https://api.elyph.io/v1/barrier-checks?limit=50&barrier=1a77%E2%80%A6" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Antwort lesen

Die Antwort enthält `data` mit den Objekten, `page.next` als Fortsetzungsmarke und `rate` mit dem verbleibenden Abfragekontingent.

Antwort

{
  "data": [
    {
      "id": "5f1a3c9e-2f7b-4a11-9c2d-6d0f8b2a4e11",
      "barrier_id": "1a77c6e4-9d3b-4b0a-8f2e-71a6c4e93b02",
      "performed_at": "2026-01-20T08:00:00Z",
      "performed_by": {
        "name": "Marco List",
        "email": "marco.list@example.com"
      },
      "result": "failed",
      "effectiveness": 2,
      "method": "Funktionstest",
      "findings": "Rechter Taster prellt, Zweihandbedienung nicht sicher.",
      "next_review_at": "2026-02-20",
      "updated_at": "2026-01-20T08:14:31Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 50
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

3
Filter setzen
Verfügbare Filter: `barrier` — Kennung der Barriere (UUID), zu der die Prüfungen gehören. `result` — Prüfergebnis exakt wie im Feld `result`. `updated_since` — Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation. `limit` — Anzahl der Objekte je Seite, 1 bis 200. Standard 50. `page` — Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl. Mehrere Filter werden mit `&` verbunden und wirken zusammen.
4
Einzelnes Objekt holen
Der Pfad /v1/barrier-checks/{Kennung} liefert genau ein Objekt. Kennung ist `id` (UUID der Prüfung). Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/barrier-checks/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Objekt anlegen

POST /v1/barrier-checks — erforderliches Recht: barrier_checks:write. Die Barriere muss zum eigenen Mandanten gehören, sonst 404 `not_found`. `result` erwartet `passed`, `failed` oder `partial`. Ein nicht bestandenes Ergebnis löst das Ereignis `barrier_check.failed` aus.

curl

curl -sS "https://api.elyph.io/v1/barrier-checks" \
  -H "Authorization: Bearer $ELYPH_API_KEY" \
  -H "Content-Type: application/json" \
  -X POST \
  -d '{
  "barrier_id": "1a77c6e4-9d3b-4b0a-8f2e-71a6c4e93b02",
  "result": "failed",
  "performed_at": "2026-01-20T08:00:00Z",
  "method": "Funktionstest",
  "findings": "Rechter Taster prellt.",
  "effectiveness": 2
}'

Felder der Antwort

Feld	Typ	Bedeutung
id	string (UUID)	Kennung der Prüfung.
barrier_id	string (UUID)	Geprüfte Barriere.
performed_at	string	Zeitpunkt der Prüfung.
performed_by.name	string \| null	Prüfende Person, wenn sie ein Konto hat.
result	string	`passed`, `failed`, `partial`.
effectiveness	number \| null	Beobachtete Schutzwirkung (1–5).
method	string \| null	Prüfverfahren, etwa Sichtprüfung oder Funktionstest.
findings	string \| null	Feststellungen im Klartext.
next_review_at	string \| null	Nächste fällige Prüfung.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
barrier	Kennung der Barriere (UUID), zu der die Prüfungen gehören.	barrier=1a77…
result	Prüfergebnis exakt wie im Feld `result`.	result=failed
updated_since	Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.	updated_since=2026-01-01T00:00:00Z
limit	Anzahl der Objekte je Seite, 1 bis 200. Standard 50.	limit=100
page	Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.	page=eyJ1IjoiMjAy…

Rechte und Methoden

Angabe	Wert
Pfad	/v1/barrier-checks
Methoden	GET, POST
Rechte	barrier_checks:read, barrier_checks:write
Kennung	`id` (UUID der Prüfung)

API-Konsole

Anfrage zusammenstellen, Code kopieren und — angemeldet und mit eigenem Schlüssel — wirklich ausführen. Die Konsole führt ausschließlich lesende Aufrufe aus.

Ressource

Adresse

GET https://api.elyph.io/v1/barrier-checks?limit=10

barrier

Kennung der Barriere (UUID), zu der die Prüfungen gehören.

result

Prüfergebnis exakt wie im Feld `result`.

updated_since

Nur Objekte, die seit diesem Zeitpunkt geändert wurden (ISO 8601). Grundlage jeder Synchronisation.

limit

Anzahl der Objekte je Seite, 1 bis 200. Standard 50.

page

Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.

curl

curl -sS "https://api.elyph.io/v1/barrier-checks?limit=10" \
  -H "Authorization: Bearer $ELYPH_API_KEY"

Echttest

Nach der Anmeldung führen Sie dieselbe Anfrage hier mit Ihrem eigenen Schlüssel aus. So sieht eine echte Antwort aus:

Beispielantwort

{
  "data": [
    {
      "id": "5f1a3c9e-2f7b-4a11-9c2d-6d0f8b2a4e11",
      "barrier_id": "1a77c6e4-9d3b-4b0a-8f2e-71a6c4e93b02",
      "performed_at": "2026-01-20T08:00:00Z",
      "performed_by": {
        "name": "Marco List",
        "email": "marco.list@example.com"
      },
      "result": "failed",
      "effectiveness": 2,
      "method": "Funktionstest",
      "findings": "Rechter Taster prellt, Zweihandbedienung nicht sicher.",
      "next_review_at": "2026-02-20",
      "updated_at": "2026-01-20T08:14:31Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

Sie können barrierenprüfungen zuverlässig lesen und schreiben, filtern und mit Ihrem System abgleichen.

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `id` (UUID der Prüfung) als stabile Verknüpfung.
Alle Daten bei jedem Lauf neu laden: Mit `updated_since` holen Sie nur Änderungen.
Schreibrechte pauschal vergeben: Erteilen Sie barrier_checks:write nur dem System, das wirklich schreibt.

Hintergrund

Die Ressource ist streng auf den Mandanten des Schlüssels begrenzt. Ist der Zugang auf Standorte eingeschränkt, liefert die Liste nur Objekte dieser Standorte. Jede Anfrage wird mit Zeitpunkt, Pfad, Status und Trefferzahl protokolliert und ist in der Verwaltung einsehbar.