Informationen der angemeldeten Person.

GET /person-info

Dieser Endpunkt bezieht sich nur auf die im Sicherheitskontext angemeldete Person und dient somit dem Abruf der Informationen der jeweiligen Person.

Die Anfrage muss als HTTP-GET gestellt werden. Die Antwort erfolgt mit einer pseudonymisierten ID, dem JSON-Objekt der betreffenden Person sowie einer Liste aller für die Sichtbarkeit freigegebenen Personenkontexte.

Bei der Auslieferung von Person-Info wird im HTTP-Header ein ETag mitgeliefert. Bei nachfolgenden Abrufen der Personen-Information vom Schulconnex-Service kann der Dienst ein „If-None-Match“ Tag mit diesem ETag in den Request-Header mit aufnehmen.

Hat sich der Datensatz seit Auslieferung des ETag-Headers nicht geändert, so antwortet der Server mit einem Status 304 (Not Modified) und sendet den Datensatz nicht erneut.

{
  "pid": <String>, // pseudonymisierte ID
  "person": <Objekt>, // Objekt vom Typ Person, siehe Datenmodell
  "personenkontexte": [ // Array mit Objekten
    {
      <Objekt>, // Objekt vom Typ Personenkontext, siehe Datenmodell
      "gruppen": [
        // Array von Gruppen und Gruppenzugehoerigkeiten eines Personenkontexts
        "gruppe": ": <Objekt>, // Objekt vom Typ Gruppe
      ],
      "beziehungen": {
        "hat_als_beziehungen": [ // Array von Beziehungen, welche vom Personenkontext ausgehen
          {
            "ktid": <Personenkontext-ID welche der Bezug in der angegebenen Rolle ist>
            "beziehung": <Art der Beziehung>
          },
          ...
        ],
        "ist_von beziehungen": [
          {
            "ktid": <Personenkontext-ID der den Bezug hat >,
            "beziehung": <Art der Beziehung>
          }
        ]
      }
    }
  ]
}

Die pseudonymisierte ID pid in der Rückgabe repräsentiert die id im aktuell ausgewählten Sicherheitskontext und folgt der gleichen Definition wie die id.

Im Sicherheitskontext einer angemeldeten nutzenden Person mit ausschließlichem Zugriff auf den Personenkontext, mit dem sie angemeldet ist, steht nur der ausgewählte und dadurch aktive Personenkontext in der Liste personenkontexte. Die pid entspricht in diesem Fall der id des einen angegebenen Personenkontexts.

Es ist möglich, dass zu einer angemeldeten Person mehrere Personenkontexte bereitgestellt werden. Im Sicherheitskontext einer angemeldeten nutzenden Person mit Zugriff auf mehrere Personenkontexte, die für den Dienst freigegeben sind, umfasst die Liste der Personenkontexte personenkontexte alle freigegebenen Personenkontexte. In diesem Fall entspricht die pid der Identität der Person und jeder Personenkontext hat die eigene id, welche bei Anmeldung im Sicherheitskontext mit ausschließlichem Zugriff auf diesen Personenkontext als pid ausgeliefert würde. Siehe auch die einzelnen Datenmodelle zu Person und Personenkontext.

Es ist weiterhin möglich, dass eine angemeldete Person mehreren Gruppen zugeordnet ist. In diesem Fall können, geregelt durch eine vertragliche Absprache zwischen Dienstanbieter und Betreiber des Schulconnex-Servers, neben der Gruppenzugehörigkeit im aktuellen Anmeldekontext auch andere Gruppenzugehörigkeiten durch /person-info geliefert werden.

Abhängig von einer vertraglichen Absprache zwischen Dienstanbieter und Betreiber des Schulconnex-Servers ist es möglich, bei der Gruppenzugehörigkeit gegebenenfalls auch die Personenkontext-IDs und Rollen anderer Mitglieder derselben Gruppe mit auszugeben. Die Personenkontext-IDs und Rollen werden dann in einem Array namens sonstige_gruppenzugehoerige, jeweils mit dem Namen „ID“ und „Rolle“ als Teil der Gruppenzugehörigkeit geliefert.

Typischerweise ist dieses eine Liste von Schüler und Schülerinnen in einer Gruppe, wenn sich eine Lehrkraft mit der Gruppenrolle Lehr anmeldet.

Bei der Ausgabe von Beziehungen zwischen Personenkontexten ist es abhängig vom Schulconnex-Server ob alle existierenden und als einsehbar freigegebenen Beziehungen unter beziehungen mit aufgeführt werden oder nur solche Beziehungen, zu denen der Personenkontext, mit dem eine Beziehung besteht, vorher schon von dem Dienst abgerufen wurde und damit dem Dienst bekannt ist.

{
  "pid": "df6588cf8dc649ef79fcc852e1064761442a32bf3496ecd9bde0f66a18685aaa",
  "person": {
    "stammorganisation": {
      "id": "fe963bff-e837-4799-91e2-5680222188a5",
      "kennung": "NI_54321",
      "name": "Otto Hahn Schule",
      "anschrift": {
        "postleitzahl": "29614",
        "ort": "Soltau",
        "ortsteil": "Ahlften"
      },
      "typ": "Schule"
    },
    "name": {
      "familienname": "Muster",
      "vorname": "Max"
    },
    "geburt": {
      "datum": "2010-01-01",
      "volljaehrig": "Ja"
    },
    "geschlecht": "m",
    "lokalisierung": "de",
    "vertrauensstufe": "Voll"
  },
  "personenkontexte": [
    {
      "id": "dd29cbf394a218a4637004f5789a210e9ec55b084a648e02a55fa3eb56475e3f",
      "organisation": {
        "id": "15685758-d18e-49c1-a644-f9996eb0bf08",
        "kennung": "NI_12345",
        "name": "Muster-Schule",
        "typ": "Schule"
      },
      "rolle": "Lern",
      "erreichbarkeiten": [
        {
          "typ": "E-Mail",
          "kennung": "Max.Muster@Muster-Schule.de"
        }
      ],
      "personenstatus": "Aktiv",
      "gruppen": [
        {
          "gruppe": {
            "id": "b3201d00-f21f-4986-a39d-02a09c8da26c",
            "orgid": "9b3f36ad-9d15-49f9-9660-6cf9746ba446",
            "bezeichnung": "Englisch 6b",
            "typ": "Kurs",
            "bereich": "Pflicht",
            "optionen": [
              ""
            ],
            "differenzierung": "E",
            "bildungsziele": [
              "RS"
            ],
            "jahrgangsstufen": [
              "03"
            ],
            "faecher": [
              {
                "kennung": "EN"
              },{
                "bezeichnung": "Erste Hilfe"
              }
            ],
            "laufzeit": {
              "von": "2026-01-01",
              "bis": "2028-12-31"
            }
          },
          "gruppenzugehoerigkeit": [
            {
              "rollen": [
                "Lern"
              ],
              "von": "2026-01-01",
              "bis": "2027-12-31"
            }
          ],
          "sonstige_gruppenzugehoerige": [
            {
              "ktid": "7168185a615d8a05a7330e7e5b84288c96783da6f734529760de13335f38016a",
              "rollen": [
                "Lern",
                "GMit"
              ]
            }
          ]
        }
      ]
    }
  ],
  "beziehungen": {
    "hat_als_beziehungen": [
      {
        "ktid": "1706e0e9cbc89ec256db8552955b981cf9590dffb71c2b586f9f9edae52f980b",
        "beziehung": "SchB"
      },
      {
        "ktid": "032b0499c3ff360791eb778adad23fa56039b26ad39b3f675e6f6ec6e17f280c",
        "beziehung": "SchB"
      }
    ],
    "ist_von_beziehungen": [
      {
        "ktid": "a91cb0d4fc25a551e909147cfc0e38ebe13462a898c0eda5219762bd96f6782e",
        "beziehung": "SorgBer"
      }
    ]
  }
}

Responses

application/json

Schema
Example (from schema)

Schema

pid stringrequired

Pseudonymisierte ID. Referenziert ein bestehendes Objekt des Schulconnex-Servers.

person

object

stammorganisation

object

Organisation.

id stringrequired

ID der Organisation.

kennung string

Die optionale Kennung (Identifikations-ID) einer Organisation.

name string

Offizieller Name einer Organisation.

anschrift

object

postleitzahl string

Postleitzahl.

ort string

Amtlicher Gemeindename.

ortsteil string

Teil eines Orts, falls genauere Untergliederung gewünscht.

typ components-code-Organisationstyp (string)

Possible values: [Schule, Anbieter, Sonstige]

Wie folgt:

Schule
Anbieter
Sonstige sonstige Organisationen / Einrichtungen

name

object

required

familienname stringrequired

Familienname(n) der Person. Mehrere Familiennamen werden durch Leerzeichen separiert.

vorname stringrequired

Mehrere Vornamen werden durch Leerzeichen separiert.

initialenfamilienname string

Possible values: <= 8 characters

Initial oder Initialen des Familiennamens, maximal acht Zeichen.

initialenvorname string

Possible values: <= 8 characters

Initial oder Initialen des Vornamens, maximal acht Zeichen.

rufname string

Possible values: <= 32 characters

Bei mehreren Vornamen wird der täglich im Gebrauch genutzte Vorname geführt, maximal 32 Zeichen.

titel string

Possible values: <= 128 characters

Titel der Person (bspw. ein akademischer Grad, Dienst- und Amtsbezeichnungen oder militärische Ränge), maximal 128 Zeichen.

anrede string[]

Possible values: <= 64 characters

Liste (Array) von Namenszusätzen bei der Anrede. Jeder einzelne Namenszusatz hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenszusätze liegt bei 512 Zeichen.

namenssuffix string[]

Possible values: <= 64 characters

Liste (Array) von Namenssuffixen. Jeder einzelne Namenssuffix hat eine Maximallänge von 64 Zeichen, die Maximallänge für alle Namenssuffixe liegt bei 1024 Zeichen.

sortierindex string

Possible values: Value must match regular expression ^[0-9]+$

Index des Buchstabens des Nachnamens, nach dem sortiert werden soll. Der Index ist Null-basiert, d. h. ein Wert von „4“ zeigt an, dass die ersten vier Buchstaben ignoriert und ab dem fünften Buchstaben des Nachnamens sortiert werden soll. Ist kein Sortierindex angegeben, so ist der Nachname entsprechend dem ersten Buchstaben in Listen einzusortieren, äquivalent zum Sortierindex „0“.

geburt

object

datum date

Geburtsdatum einer Person.

volljaehrig components-code-Boolean (string)

Possible values: [Ja, Nein]

Gibt an, ob eine Person volljährig ist.

geburtsort string

Geburtsort einer Person, bestehend aus Ortsname und Land, beispielsweise „Eindhoven, Niederlande“. Wird kein Land angegeben, so wird als Land „Deutschland“ angenommen, d.h. der Geburtsort „Erfurt“ ist wie „Erfurt, Deutschland“ zu behandeln.

geschlecht components-code-Geschlecht (string)

Possible values: [m, w, d, x]

Geschlecht:

m männlich
w weiblich
d divers
x keine Angabe

lokalisierung string

Basierend auf RFC 5646. Mögliche Beispiele:

de deutsch
de-XX deutsch, Anrede du, einfache Sprache
en-GB englisch (Vereinigtes Königreich)

vertrauensstufe components-code-Vertrauensstufe (string)

Possible values: [Kein, Unbe, Teil, Voll]

Wie folgt:

Kein - kein - Der Schlüsselbesitzer ist nicht vertrauenswürdig.
Unbe - unbekannt - Der Schlüsselbesitzer ist unbekannt.
Teil - vertraut - Dem Schlüsselbesitzer wird vertraut.
Voll - verifiziert - Der Schlüsselbesitzer ist eindeutig und formal identifiziert.

personenkontexte

object[]

Array [

id stringrequired

ID des Personenkontexts. Referenziert ein bestehendes Objekt des Schulconnex-Servers.

organisation

object

required

Organisation.

id stringrequired

ID der Organisation.

kennung string

Die optionale Kennung (Identifikations-ID) einer Organisation.

name string

Offizieller Name einer Organisation.

anschrift

object

postleitzahl string

Postleitzahl.

ort string

Amtlicher Gemeindename.

ortsteil string

Teil eines Orts, falls genauere Untergliederung gewünscht.

typ components-code-Organisationstyp (string)

Possible values: [Schule, Anbieter, Sonstige]

Wie folgt:

Schule
Anbieter
Sonstige sonstige Organisationen / Einrichtungen

gruppen

object[]

Array [

gruppe

object

required

id stringrequired

ID der Gruppe.

orgid string

ID der Organisation.

bezeichnung stringrequired

Bezeichnung der Gruppe.

thema string

Thema der Gruppe in Kurzform.

beschreibung string

Possible values: <= 1024 characters

Zusätzliche optionale Beschreibung der Gruppe.

typ components-code-Gruppentyp (string)required

Possible values: [Klasse, Kurs, Sonstig]

Wie folgt:

Klasse Schulklasse
Kurs Kurs/Unterricht
Sonstig Sonstige Gruppe

bereich components-code-Gruppenbereich (string)

Possible values: [Pflicht, Wahl, Wahlpflicht]

Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

Pflicht Pflichtunterricht
Wahl Wahlunterricht
Wahlpflicht Wahlpflichtunterricht

optionen components-code-Gruppenoption (string)[]

Possible values: [``]

differenzierung components-code-Gruppendifferenzierung (string)

Possible values: [G, E, Z, gA, eA]

Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

G G-Kurs
E E-Kurs
Z Z-Kurs
gA grundlegendes Anforderungsniveau
eA erhöhtes Anforderungsniveau

bildungsziele components-code-Bildungsziel (string)[]

Possible values: [GS, HS, RS, GY-SEK-I, GY-SEK-II]

jahrgangsstufen components-code-Jahrgangsstufe (string)[]

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

faecher

object[]

Array [

oneOf

components-Gruppe-faecher-kennung
components-Gruppe-faecher-bezeichnung
components-Gruppe-faecher-kennung-bezeichnung

kennung components-code-Fächerkanon (string)

Possible values: [BI, CH, CI, DE, DS, EK, EN, FR, GR, NL, IT, SN, KU, LA, RS, GE, PO, PW, RE, RI, RK, SP, SU, TE, TG, WE, WN, WS, DA, MA, HW, MU, PA, PH, IF, AW, GL, PWI, PTE, PGUS, NAT]

Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

BI Biologie
CH Chemie
CI Chinesisch
DE Deutsch
DS Darstellendes Spiel
EK Erdkunde
EN Englisch
FR Französisch
GR Griechisch
NL Niederländisch
IT Italienisch
SN Spanisch
KU Kunst
LA Latein
RS Russisch
GE Geschichte
PO Politik
PW Politik/Wirtschaft
RE Evangelische Religion
RI Islamische Religion
RK Katholische Religion
SP Sport
SU Sachunterricht
TE Technik
TG Textiles Gestalten
WE Gestaltendes Werken
WN Werte und Normen
WS Wirtschaft
DA Deutsch als Zweitsprache
MA Mathematik
HW Hauswirtschaft
MU Musik
PA Pädagogik
PH Physik
IF Informatik
AW Arbeit-Wirtschaft-Technik
GL Gesellschaftslehre
PWI Profil Wirtschaft
PTE Profil Technik
PGUS Profil Gesundheit und Soziales
NAT Naturwissenschaften

kennung components-code-Fächerkanon (string)

Diese Codeliste ist spezifisch für das Bundesland Niedersachsen:

BI Biologie
CH Chemie
CI Chinesisch
DE Deutsch
DS Darstellendes Spiel
EK Erdkunde
EN Englisch
FR Französisch
GR Griechisch
NL Niederländisch
IT Italienisch
SN Spanisch
KU Kunst
LA Latein
RS Russisch
GE Geschichte
PO Politik
PW Politik/Wirtschaft
RE Evangelische Religion
RI Islamische Religion
RK Katholische Religion
SP Sport
SU Sachunterricht
TE Technik
TG Textiles Gestalten
WE Gestaltendes Werken
WN Werte und Normen
WS Wirtschaft
DA Deutsch als Zweitsprache
MA Mathematik
HW Hauswirtschaft
MU Musik
PA Pädagogik
PH Physik
IF Informatik
AW Arbeit-Wirtschaft-Technik
GL Gesellschaftslehre
PWI Profil Wirtschaft
PTE Profil Technik
PGUS Profil Gesundheit und Soziales
NAT Naturwissenschaften

bezeichnung components-Gruppe-faecherbezeichnung (string)

Bezeichnung eines Fachs, wenn nicht im Fächerkanon vorhanden

]

laufzeit

object

oneOf

components-Laufzeit-von-bis
components-Laufzeit-vonlernperiode-bislernperiode
components-Laufzeit-von-bislernperiode
components-Laufzeit-vonlernperiode-bis
components-Laufzeit-von
components-Laufzeit-vonlernperiode
components-Laufzeit-bis
components-Laufzeit-bislernperiode

von date

Anfang des Gültigkeitszeitraums der Gruppe. Dieser Zeitpunkt kann auch in der Zukunft liegen.

bis date

Ende des Gültigkeitszeitraums der Gruppe.

vonlernperiode components-code-Lernperiode (string)