API-Dokumentation – BiPla Explorer

Übersicht

BiPla Explorer API

Eine einfache REST-API, die alle Bildungsplandaten im strukturierten JSON-Format bereitstellt. Ideal für Lehrpläne, externe Tools oder eigene Auswertungen.

Basis-URL /api/index.php?endpoint=

Protokoll

HTTP / HTTPS

Format

JSON

Methoden

GET

Authentifizierung

Keine

Version

1.0

Encoding

UTF-8

Grundlagen

Response-Format

Alle Antworten verwenden eine einheitliche Hülle mit success, data und optionalem error-Objekt.

✅ Erfolg

{
  "success": true,
  "data": /* Payload */
}

❌ Fehler

{
  "success": false,
  "error": {
    "code": 404,
    "message": "Beruf nicht gefunden"
  }
}

Endpunkte

Alle Berufe abrufen

Liefert eine Liste aller verfügbaren Berufe aus der Registry (registry.json).

GET /api/index.php?endpoint=berufe ▾

Antwort: Array von Beruf-Objekten

idstringEindeutiger Bezeichner (z. B. «medientechnologe»)

labelstringLesbare Bezeichnung des Berufs

fachrichtungenstring[]Liste der Fachrichtungen (leer wenn keine)

Live ausprobieren

Vollständige Berufs-Daten

Liefert alle Daten eines Berufs inkl. aller HKBs, HKs und Leistungsziele.

GET /api/index.php?endpoint=beruf&beruf={id} ▾

Parameter	Typ	Pflicht	Beschreibung
`beruf`	string	ja	Beruf-ID (z. B. `medientechnologe`)

Live ausprobieren

Handlungskompetenzbereiche (HKB)

Liefert alle HKBs eines Berufs mit Anzahl HKs und Leistungszielen — ohne die Lernziel-Texte.

GET /api/index.php?endpoint=hkb&beruf={id} ▾

Parameter	Typ	Pflicht	Beschreibung
`beruf`	string	ja	Beruf-ID

Live ausprobieren

Einzelne Handlungskompetenz (HK)

Liefert eine spezifische HK mit allen untergeordneten Leistungszielen und Lernort-Texten.

GET /api/index.php?endpoint=kompetenz&beruf={id}&id={hk_id} ▾

Parameter	Typ	Pflicht	Beschreibung
`beruf`	string	ja	Beruf-ID
`id`	string	ja	HK-ID (z. B. `e2`)

Live ausprobieren

Leistungsziele (gefiltert)

Gibt eine flache Liste aller Leistungsziele zurück. Unterstützt Filter nach HKB, HK, Taxonomie und Fachrichtung.

GET /api/index.php?endpoint=leistungsziele&beruf={id}&… ▾

Parameter	Typ	Pflicht	Beschreibung
`beruf`	string	ja	Beruf-ID
`hkb`	string	nein	Filter auf HKB (z. B. `e`)
`hk`	string	nein	Filter auf HK-ID (z. B. `e2`)
`taxonomie`	string	nein	Filter auf Taxonomiestufe (K1–K6)
`fachrichtung`	string	nein	Nur LZs dieser Fachrichtung
`limit`	integer	nein	Max. Anzahl Resultate (Standard: alle)

Live ausprobieren

API Meta-Informationen

Zeigt Version, verfügbare Endpunkte und den Serverstatus.

GET /api/index.php?endpoint=meta ▾

Live ausprobieren