REST.Backend.EMSServices.TEMSUsersAPI.QueryUsers

• Up to Parent: TEMSUsersAPI

Delphi

procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray); overload;
procedure QueryUsers(const AQuery: array of string;
const AJSONArray: TJSONArray;
out AMetaArray: TArray<TBackendEntityValue>); 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<Rest::Backend::Metatypes::TBackendEntityValue> &AMetaArray)/* overload */;

Properties

Type	Visibility	Source	Unit	Parent
procedure function	protected	REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp	REST.Backend.EMSServices	TEMSUsersAPI

Description

Queries the EMS server for a list of users.

QueryUsers receives the following parameters:

• AQuery is an array of strings where each string must contain a key-value pair separated by an equal sign, such as "my_parameter=my_value". QueryUsers adds those key-value pairs to the request as parameters.
• QueryUsers fills AJSONArray with the results from the EMS server.

You may optionally provide an array of instances of TBackendEntityValue (AMetaArray), so that QueryUsers fills the array with the users that the EMS server returns.

Exceptions

Exception	Message	Description
EEMSClientAPIError	JSON object expected	You passed QueryUsers an array of instances of TBackendEntityValue (AMetaArray), but QueryUsers cannot fill that array because the structure of the JSON data received from the EMS server is unexpected. The expected structure of the received JSON data is a JSON array of JSON objects. The actual structure of the received JSON data is a JSON array that contains one or more items that are not JSON objects.
	MasterSecret required	The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string.
	Session token required	The type of authentication is TAuthentication.Session you did not log in.

See Also

• REST.Backend.EMSServices.TEMSUsersAPI.DeleteUser
• REST.Backend.EMSServices.TEMSUsersAPI.FindUser
• REST.Backend.EMSServices.TEMSUsersAPI.UpdateUser
• REST.Backend.EMSServices.TEMSUsersAPI.QueryUserName

• REST.Backend.EMSApi.TEMSClientAPI.QueryUsers