Zum Hauptinhalt springen

Erstellen einer Gruppenzugehörigkeit

POST 

/gruppen/:id/gruppenzugehoerigkeiten

Dieser Schnittstellenendpunkt erstellt eine Gruppenzugehörigkeit zur angegebenen Gruppe per ID gruppe.id.

Ein CREATE zum Erstellen von Gruppenzugehörigkeiten zu einer Gruppe muss mit HTTP-POST auf die API /gruppen/{gruppe.id}/gruppenzugehoerigkeiten erfolgen. Die Anfrage-Nutzdaten (Request Payload) beinhalten ein JSON-Objekt des Datentyps Gruppenzugehörigkeiten.

Siehe auch Datenmodell Gruppenzugehörigkeit.

Die folgende Tabelle listet die Attribute einer Gruppenzugehörigkeit auf, welche von einem Quellsystem oder Dienst nicht verändert werden können.

AttributIn den Anfrage-Nutzdaten erforderlich?Bemerkung
idneinID der Gruppenzugehörigkeit. Wird vom Schulconnex-Server vergeben und ist eindeutig. Dieses Attribut ist unveränderbar (immutable).
revisionneinRevision der Gruppenzugehörigkeit. Wird vom Schulconnex-Server mit der Erstellung des Datensatzes sowie Aktualisierung generiert. Dieser Wert kann nicht von Quellsystemen oder Diensten gesetzt werden.

Bei einer erfolgreichen Anforderung zum Erstellen einer Gruppenzugehörigkeit zu einer Gruppe wird diese Anforderung mit einer Repräsentation der Gruppenzugehörigkeit in den Antwort-Nutzdaten und dem HTTP-Statuscode 201 quittiert.

Request

Responses

OK