Zum Hauptinhalt springen

Personenkontexte zur angeforderten ID.

GET 
/personen/:id/personenkontexte

Dieser Schnittstellenendpunkt gibt die Personenkontexte zur angeforderten Person per ID personendatensatz.person.id zurück.

Ein READ muss mit einer HTTP-GET Anfrage erfolgen. Die Antwort-Nutzdaten (Response Payload) beinhalten ein Array von JSON-Objekten vom Datentyp Personenkontext, sofern Einträge (ggf. passend zu den optionalen Filtern) existieren.

Siehe auch Datenmodell Personenkontext.

Die Anfrage erfordert keine Nutzdaten (Request Payload).

Die Schnittstelle ermöglicht das Verwenden von Filterparametern zur Präzisierung der Anfrage bei HTTP-GET. Werden mehrere Filter angegeben, so müssen sie als mit „und“ verknüpft angesehen werden. Die mehrfache Nutzung des gleichen Filters in einer Anfrage darf nicht erfolgen. Entsprechen keine Werte den angegebenen Filtern, so wird als Resultat eine leere Liste geliefert.

Folgende Tabelle listet die zur Verfügung stehenden Filter:

FilterTypBeschreibung
referrerStringMöglichkeit, die Ergebnisliste der Anfrage nach dem Fremdschlüssel referrer zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters ohne Beachtung von Groß- und Kleinschreibung im Filter-Attribut beinhaltet ist (contains).
rolleString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut personenkontext.rolle zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filterparameters mit dem Wert des Filter-Attributs übereinstimmt (equals). Dem Filterparameter liegt die Codeliste Rolle zugrunde.
personenstatusString (Code)Möglichkeit, die Ergebnisliste der Anfrage nach dem Attribut „personenkontext.personenstatus” zu filtern. Der Schulconnex-Server überprüft, ob der Wert des Filter-parameters mit dem Wert des Filter-Attributs übereinstimmt (equals). Dem Filterparameter liegt eine Codeliste Personenstatus zugrunde.
sichtfreigabeStringerlaubt es Personen, abhängig davon aufzulisten, ob diese von einer anderen Organisation zum Lesen freigegeben wurden. Die möglichen Optionen sind sichtfreigabe=ja, um nur die durch externe Organisationen freigegebenen Personen beziehungsweise Personenkontexte aufzulisten, und sichtfreigabe=nein, um nur eigene Personen beziehungsweise Personenkontexte aufzulisten. Wird nicht nach Sichtfreigabe gefiltert, so werden alle lesbaren Personen, beziehungsweise Personenkontexte geliefert.

Die Organisation wurde beim Erstellen eines Personenkontexts vom Schulconnex-Server aus dem access_token übernommen und per personenkontext.organisation.id referenziert. Die Antwort-Nutzdaten umfassen standardmäßig für das Attribut personenkontext.organisation mit dem Datentyp Organisation alle nicht optionalen Attribute – nur die ID personenkontext.organisation.id.

Request​

Path Parameters

    id stringrequired

    Der Pfad-Parameter bezieht sich auf die vom Quellsystem vergebene ID der Person.

Query Parameters

    referrer string
    rolle string
    personenstatus string
    sichtfreigabe string

Responses​

OK

Schema

  • Array [

    • id stringrequired

    ID des Personenkontexts.

    mandant stringrequired

    ID des Mandanten, dem der Personenkontext zugeordnet ist.

    organisation

    object

    Organisation.

    id stringrequired

    ID der Organisation.

    referrer string

    ID des Personenkontexts im Quellsystem.

    erreichbarkeiten

    object[]

  • Array [

    • typ components-code-Erreichbarkeitstyp (string)required

    Possible values: [E-Mail]

    Wie folgt:

    • E-Mail E-Mail-Adressen müssen RFC 5322 (Internet Message Format) erfüllen
    kennung emailrequired

    Konkrete Angabe der zum Erreichen der Person oder Organisation notwendigen Information.

  • ]

    • personenstatus components-code-Personenstatus (string)

    Possible values: [Aktiv]

    Wie folgt:

    • Aktiv aktiv
    jahrgangsstufe components-code-Jahrgangsstufe (string)

    Possible values: [01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13]

    Wie folgt:

    • 01 Jahrgangsstufe 1
    • 02 Jahrgangsstufe 2
    • 03 Jahrgangsstufe 3
    • 04 Jahrgangsstufe 4
    • 05 Jahrgangsstufe 5
    • 06 Jahrgangsstufe 6
    • 07 Jahrgangsstufe 7
    • 08 Jahrgangsstufe 8
    • 09 Jahrgangsstufe 9
    • 10 Jahrgangsstufe 10
    • 11 Jahrgangsstufe 11
    • 12 Jahrgangsstufe 12
    • 13 Jahrgangsstufe 13
    rolle components-code-Rolle (string)required

    Possible values: [Lern, Lehr, SorgBer, Extern, OrgAdmin, Leit, SysAdmin, SchB, NLehr]

    Wie folgt:

    • Lern Lernende/-r
    • Lehr Lehrende/-r
    • SorgBer Sorgeberechtigte/-r
    • Extern externe Person
    • OrgAdmin Organisationsadministrator
    • Leit Organisationsleitung
    • SysAdmin Systemadministrator
    • Schulbegleiter/-in
    • Nicht-lehrendes Personal
    sichtfreigabe components-code-Boolean (string)

    Possible values: [Ja, Nein]

    Die Codeliste „Boolean“ regelt das Mapping der deutschen Wörter „ja“ und „nein“ auf die englischen Begriffe „true“ und „false“:

    • Ja true
    • Nein false

    loeschung

    object

    zeitpunkt date-time

    Datum und Uhrzeit der Löschung des Personenkontexts.

    revision stringrequired

    Revision des Personenkontexts.

  • ]

Loading...