Skip to Content
IDMGroups and People

Synced Groups and their Members

Eduplaces API

GET /schools/:id/groups

PathAuthenticationRequired Scope
/idm/ep/v1/schools/:id/groupsAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:groups:read

Provides a list of groups of a specific school that should be synced with the app.

HTTP/1.1 200 Content-Type: application/json [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" }, { "id": "efe66258-dd48-49eb-a37d-37709e98f755", "name": "Klasse 5b" }, { "id": "d54b95b8-7966-4a5e-a261-432e591dde77", "name": "Klasse 8b" } ]

GET /groups/:id

PathAuthenticationRequired Scope
/idm/ep/v1/groups/:idAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:groups:read

Gets a specific group with a list of all its members by its ID.

HTTP/1.1 200 Content-Type: application/json { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a", "members": [ { "id": "83bc4846-4ff5-4de7-8ce2-2afa2bd51fb3", "role": "TEACHER", "name": { "firstFull": "Stephanie", "firstCall": "Stephanie", "last": "Schuster" } }, { "id": "b8512fb2-096d-439d-ba9b-9d7fb6840c73", "role": "STUDENT", "name": { "firstFull": "Wilma Johanna Sophie", "firstCall": "Johanna", "last": "Becker" } }, { "id": "e1ea6ab3-ae66-4ff1-b1a9-9192fe50ee3a", "role": "STUDENT", "name": null }, { "id": "564e70c5-e2c7-429b-9b6a-a024c2271bea", "role": "STUDENT", "name": null } ] }

GET /schools/:id/people

PathAuthenticationRequired Scope
/idm/ep/v1/schools/:id/peopleAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:people:read

Gets a list of all people (students, teachers, etc.) of a specific school. Only people that are members of a group that is synced with the app are returned.

HTTP/1.1 200 Content-Type: application/json [ { "id": "83bc4846-4ff5-4de7-8ce2-2afa2bd51fb3", "role": "TEACHER", "name": { "firstFull": "Stephanie", "firstCall": "Stephanie", "last": "Schuster" }, "sourceSystemIdentifier": "123xyz", "groups": [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" }, { "id": "efe66258-dd48-49eb-a37d-37709e98f755", "name": "Klasse 5b" } ] }, { "id": "b8512fb2-096d-439d-ba9b-9d7fb6840c73", "role": "STUDENT", "name": { "firstFull": "Wilma Johanna Sophie", "firstCall": "Johanna", "last": "Becker" }, "sourceSystemIdentifier": "456abc", "groups": [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" } ] }, { "id": "e1ea6ab3-ae66-4ff1-b1a9-9192fe50ee3a", "role": "STUDENT", "name": null, "sourceSystemIdentifier": null, "groups": [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" } ] }, { "id": "564e70c5-e2c7-429b-9b6a-a024c2271bea", "role": "STUDENT", "name": null, "sourceSystemIdentifier": null, "groups": [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" } ] }, { "id": "83bc4846-4ff5-4de7-8ce2-2afa2bd51fb3", "role": "TEACHER", "name": { "firstFull": "Norbert Dieter", "firstCall": "Norbert", "last": "Graf" }, "sourceSystemIdentifier": null, "groups": [ { "id": "d54b95b8-7966-4a5e-a261-432e591dde77", "name": "Klasse 8b" } ] } ]

GET /people/:id

PathAuthenticationRequired Scope
/idm/ep/v1/people/:idAccess Token in the apps context (Client Credentials)urn:eduplaces:idm:v1:people:read

Gets a specific person and its information.

HTTP/1.1 200 Content-Type: application/json { "id": "83bc4846-4ff5-4de7-8ce2-2afa2bd51fb3", "role": "TEACHER", "name": { "firstFull": "Stephanie", "firstCall": "Stephanie", "last": "Schuster" }, "sourceSystemIdentifier": "123xyz", "groups": [ { "id": "8d9c7b63-bf8d-43f4-9b66-64fd2b9757a9", "name": "Klasse 5a" }, { "id": "efe66258-dd48-49eb-a37d-37709e98f755", "name": "Klasse 5b" } ] }

SchulConneX

Synced groups and their members will also be available via an SchulConneX API. The specified endpoints /personen-info and /person-info are implemented as specified by SchulConneX. We will provide further information as soon as possible.