GET api/v1/organisations/{organisationKey}/users/{userKey}/students
Will get enabled users (students) who are in the same group(s) as the given user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| organisationKey | globally unique identifier |
Required |
|
| userKey | globally unique identifier |
Required |
|
| Select | Collection of string |
None. |
|
| OrderBy | Collection of TupleOfStringAndOrderDirection |
None. |
|
| Top | integer |
None. |
|
| Skip | integer |
None. |
|
| PageSize | integer |
None. |
|
| Page | integer |
None. |
|
| SearchText | string |
None. |
|
| Expand | Dictionary of string [key] and MooQueryOptions [value] |
None. |
|
| SearchParameters | Dictionary of string [key] and string [value] |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of User| Name | Description | Type | Additional information |
|---|---|---|---|
| PayingOrganisation |
Contains the primary/paying organisation for the user. Needs expansion to load more information than just the key. |
Organisation |
None. |
| FirstName |
Contains the first name (also called given name) of the user. |
string |
None. |
| MiddleName |
Contains the Dutch last name prefix or some other form of middle name of the user. |
string |
None. |
| LastName |
Contains the last name (also called surname) of the user. |
string |
None. |
| LoginName |
Contains the login name of the user |
string |
None. |
| Password |
Contains the password of the user. Cannot be read, only used during POST/PUT/PATCH. |
string |
None. |
| PasswordExpired |
Should the user's password be immediately expired |
boolean |
None. |
|
Contains the email adres of the user (doesn't need to be equal to the login name, since the user is free to register it's own favorite email address) |
string |
None. |
|
| PrivateEmail | string |
None. |
|
| Gender |
Contains the gender of the user (optional). |
Gender |
None. |
| UserType |
Contains the type of the user (personnel, student, groupstudent, external, DKN admin). |
UserType |
None. |
| Grade |
The grade of the user in case it's a student. |
integer |
None. |
| Status |
The status of the user (disabled, enabled, etc). |
UserStatus |
None. |
| BirthDate |
The birthdate of the user (optional). |
date |
None. |
| Groups |
The roles that user has. Needs expansion to load more information than just the key. |
Collection of Group |
None. |
| Roles |
The roles that user has. Needs expansion to load more information than just the key. |
Collection of Role |
None. |
| UserGroups |
The group memberships a user has. Needs expansion to load more information than just the key. |
Collection of UserGroupDto |
None. |
| Organisations |
The organisations the user is a member of |
Collection of Organisation |
None. |
| ResourceLockStatus |
Indicates whether the resource is locked for editing (e.g. by Basispoort). |
ResourceLockStatus |
None. |
| ResourceLockOwnerName |
Holds the name of the owner of the resource lock in case the ResourceLockStatus is Locked. |
string |
None. |
| AccountPngPictureBase64 |
Holds the base64 represenation of the users AccountPicture |
string |
None. |
| AccountPngPictureUrl |
Holds a URL where the Account Picture can be downloaded |
string |
None. |
| ActiveDirectoryId |
Holds a URL where the Account Picture can be downloaded |
string |
None. |
| InsertDate |
The date that the user entity was created in the database. |
date |
None. |
| ModifiedDate |
The last date that the user has been updated. |
date |
None. |
| DeleteDate |
The date that the user has been deleted. |
date |
None. |
| EckId |
Contains the ECK iD (Educatieve ContentKeten iDentifier) of the user |
string |
None. |
| AdImportSid |
Only used for migrating userdata from MOO 1 to MOO 2 |
string |
None. |
| RecoveryEmail |
Contains the recoveryemail adres of the user |
string |
None. |
| RecoveryPhoneNumber |
Contains the recoveryphonenumber of the user |
string |
None. |
| ExpiryDate |
Contains the expiry date of the user |
date |
None. |
| IsSubstituteTeacher |
Is the user a substitute teacher |
boolean |
None. |
| HasAccountPicture |
Does the user have an account picture |
boolean |
None. |
| ActionLinks | Collection of Link |
None. |
|
| Key | globally unique identifier |
None. |