REST.Backend.EMSApi.TEMSClientAPI.RetrieveUserGroups
Delphi
function RetrieveUserGroups(const AUserID: string): TArray<string>;
C++
System::DynamicArray<System::UnicodeString> __fastcall RetrieveUserGroups(const System::UnicodeString AUserID);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Returns an array with the IDs of the groups where the user with the specified ID belongs.
Exceptions
| Exception | Message | Description |
|---|---|---|
|
JSON array expected |
RetrieveUserGroups expects a JSON array from the EMS server. The EMS server sent something else. | |
|
MasterSecret required |
Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string. | |
|
Session token required |
Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string. | |
|
User ID required |
The specified user ID is an empty string. |
See Also
- REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsFields
- REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
- REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsNames
- REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup