REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
Delphi
procedure QueryUsers(const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string; const AJSONArray: TJSONArray; out AUsers: TArray<TUser>); overload;
C++
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryUsers(const System::UnicodeString *AQuery, const int AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TUser> &AUsers)/* 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 Benutzerliste ab.
QueryUsers ü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". QueryUsers fügt der Anforderung diese Schlüssel/Wertepaare als Parameter hinzu.- QueryUsers füllt
AJSONArray
mit den Ergebnissen vom EMS-Server.
Sie können optional ein Array mit TUser-Instanzen (AUsers
) angeben, damit QueryUsers das Array mit den vom EMS-Server zurückgegebenen Benutzern füllt.
Exceptions
Exception | Meldung | Beschreibung |
---|---|---|
JSON-Objekt erwartet |
Sie haben an QueryUsers ein Array mit TUser-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.AddUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.SignupUser
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser