REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations

• Up to Parent: TEMSClientAPI

Delphi

procedure QueryInstallations(const AQuery: array of string; const AJSONArray: TJSONArray); overload;
procedure QueryInstallations(const AQuery: array of string; const AJSONArray: TJSONArray; out AObjects: TArray<TInstallation>); overload;

C++

void __fastcall QueryInstallations(const System::UnicodeString *AQuery, const System::NativeInt AQuery_High, System::Json::TJSONArray* const AJSONArray)/* overload */;
void __fastcall QueryInstallations(const System::UnicodeString *AQuery, const System::NativeInt AQuery_High, System::Json::TJSONArray* const AJSONArray, /* out */ System::DynamicArray<TInstallation> &AObjects)/* overload */;

Properties

Type	Visibility	Source	Unit	Parent
procedure function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Description

Queries the EMS server for a list of installations.

QueryInstallations 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". QueryInstallations adds those key-value pairs to the request as parameters.
• QueryInstallations fills AJSONArray with the results from the EMS server.

You may optionally provide an array of instances of TInstallation (AObjects), so that QueryInstallations fills the array with the installations that the EMS server returns.

Exceptions

Exception	Message	Description
EEMSClientAPIError	JSON object expected	You passed QueryInstallations an array of instances of TInstallation (AObjects), but QueryInstallations 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. Each one of those objects represents a user. 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	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.

See Also

• REST.Backend.EMSApi.TEMSClientAPI.CreateAndroidInstallationObject
• REST.Backend.EMSApi.TEMSClientAPI.CreateIOSInstallationObject
• REST.Backend.EMSApi.TEMSClientAPI.UploadInstallation
• REST.Backend.EMSApi.TEMSClientAPI.UpdateInstallation
• REST.Backend.EMSApi.TEMSClientAPI.DeleteInstallation
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallation
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallationsChannelNames
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveInstallationsFields
• REST.Backend.EMSApi.TEMSClientAPI.PushBroadcast
• REST.Backend.EMSApi.TEMSClientAPI.PushToTarget
• REST.Backend.EMSApi.TEMSClientAPI.PushToChannels
• REST.Backend.EMSApi.TEMSClientAPI.PushWhere

• REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
• REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
• REST.Backend.EMSApi.TEMSClientAPI.QueryModules
• REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources

• REST.Backend.EMSServices.TEMSQueryAPI.Query

• REST.Backend.EMSApi.TEMSClientAPI.QueryResource