REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
Delphi
procedure QueryGroups(const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryGroups(const AQuery: array of string; const AJSONArray: TJSONArray; out AGroups: TArray<TGroup>); overload;
C++
void __fastcall QueryGroups(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryGroups(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TGroup> &AGroups)/* overload */;
Inhaltsverzeichnis
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Beschreibung
Fragt den EMS-Server nach einer Gruppenliste ab.
QueryGroups übernimmt die folgenden Parameter:
AQuery
ist ein Array mit Strings, wobei jeder String ein durch ein Gleichheitszeichen getrenntes Schlüssel/Wertepaar enthält, z. B. "my_parameter=my_value". QueryGroups fügt der Anforderung diese Schlüssel/Wertepaare als Parameter hinzu.- QueryGroups füllt
AJSONArray
mit den Ergebnissen vom EMS-Server.
Sie können optional ein Array mit TGroup-Instanzen (AGroups
) angeben, damit QueryGroups das Array mit den vom EMS-Server zurückgegebenen Gruppen füllt.
Exceptions
Exception | Meldung | Beschreibung |
---|---|---|
JSON-Objekt erwartet |
Sie haben an QueryGroups ein Array mit TGroup-Instanzen ( Die erwartete Struktur der erhaltenen JSON-Daten ist ein JSON-Array mit JSON-Objekten. Jedes dieser Objekte repräsentiert einen Benutzer. Die tatsächliche Struktur der erhaltenen JSON-Daten ist ein JSON-Array, das mindestens einen Eintrag enthält, der kein JSON-Objekt ist. | |
MasterSecret erforderlich |
Authentication ist TAuthentication.MasterSecret und ConnectionInfo.MasterSecret ist ein leerer String. | |
Sitzungs-Token erforderlich |
Authentication ist TAuthentication.Session, und Sie haben sich nicht angemeldet oder das bei der Anmeldung (Login) angegebene Sitzungsauthentifizierungs-Token ist ein leerer String. |
Siehe auch
- 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.RetrieveUserGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup