Datenfelder

Viele Objekte im System (Nutzer, Veranstaltungen, Einrichtungen usw.) können zusätzliche, vom Standort definierte Datenfelder haben. Über die hier beschriebenen Routen können diese Datenfelder abgefragt werden.

Schema “datafields”

Dieses Schema beschreibt die Metadaten (Bezeichnung und Typ) des Datenfelds:

Attribute

Attribut	Beschreibung
name	Bezeichnung des Datenfelds
object-type	Art der Objekte, für die das Datenfeld verfügbar ist
priority	Anzeigereihenfolge
type	Datentyp des Datenfelds
typeparam	ggf. Liste der Ausprägungen
is-required	Pflichtangabe
default-value	Standardwert
mkdate	Erstellungsdatum
chdate	Änderungsdatum

Als object-type kommen verschiedene Typen von Ressourcen in Frage, zum Beispiel sem, inst, user, userinstrole, usersemdata oder roleinstdata.

Schema “datafield-entries”

Dieses Schema beschreibt den Wert eines Datenfelds für ein bestimmtes Objekt:

Attribute

Attribut	Beschreibung
content	Wert des Datenfelds
display-value	Anzeigetext für den Wert
mkdate	Erstellungsdatum
chdate	Änderungsdatum

Relationen

Relation	Beschreibung
datafield	Metadaten des Datenfelds
range	Objekt, auf das sich der Wert bezieht

Alle Datenfelder

Mit dieser Route können die Metadaten aller Datenfelder ausgelesen werden.

HTTP Request

GET /datafields

Parameter

Diese Route benötigt keine Parameter

Autorisierung

Jeder eingeloggte Nutzer kann diese Route verwenden.

curl --request GET \
    --url https://example.com/datafields \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"

Eine Datenfeld

Liest die Metadaten eines Datenfelds aus.

HTTP Request

GET /datafields/{id}

Parameter

Parameter	Beschreibung
id	ID des Datenfelds

Autorisierung

Jeder eingeloggte Nutzer kann diese Route verwenden.

curl --request GET \
    --url https://example.com/datafields/<id> \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"

Alle Datenfelder eines Nutzers

Gibt alle Datenfelder eines Nutzers zurück.

HTTP Request

GET /users/{id}/datafield-entries

Parameter

Parameter	Beschreibung
id	ID des Nutzers

Autorisierung

Datenfelder eines Nutzers dürfen ausgelesen werden, wenn man den Nutzer sowie das Datenfeld selbst sehen darf.

curl --request GET \
    --url https://example.com/users/<user-id>/datafield-entries \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"

Alle Datenfelder einer Veranstaltung

Gibt alle Datenfelder einer Veranstaltung zurück.

HTTP Request

GET /courses/{id}/datafield-entries

Parameter

Parameter	Beschreibung
id	ID der Veranstaltung

Autorisierung

Datenfelder einer Veranstaltung dürfen ausgelesen werden, wenn man die Veranstaltung sowie das Datenfeld selbst sehen darf.

curl --request GET \
    --url https://example.com/courses/<course-id>/datafield-entries \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"

Alle Datenfelder einer Einrichtung

Gibt alle Datenfelder einer Einrichtung zurück.

HTTP Request

GET /institutes/{id}/datafield-entries

Parameter

Parameter	Beschreibung
id	ID der Einrichtung

Autorisierung

Jeder eingeloggte Nutzer kann diese Route verwenden. Es werden aber nur für den Nutzer sichtbare Datenfelder angezeigt.

curl --request GET \
    --url https://example.com/institutes/<institute-id>/datafield-entries \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"

Alle Datenfelder einer Mitgliedschaft in einer Einrichtung

Gibt alle Datenfelder einer Mitgliedschaft in einer Einrichtung zurück, d.h. die Werte für einen Nutzer in einer Einrichtung.

HTTP Request

GET /institute-memberships/{id}/datafield-entries

Parameter

Parameter	Beschreibung
id	ID der Mitgliedschaft in der Einrichtung

Autorisierung

Datenfelder einer Mitgliedschaft in einer Einrichtung dürfen ausgelesen werden, wenn man die Mitgliedschaft sowie das Datenfeld selbst sehen darf.

curl --request GET \
    --url https://example.com/institute-memberships/<membership-id>/datafield-entries \
    --header "Authorization: Basic `echo -ne "test_autor:testing" | base64`"