View source for REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources

{{#lst:API:REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|api}}
==Description==
{{#ifeq: {{PAGENAME}} | REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources | |{{InheritsFrom|REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources}}}}

<section begin=short />Queries the EMS server for a list of module resources.<section end=short />

[[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] receives the following parameters:
* {{Arg|AQuery}} is an array of [[System.UnicodeString|strings]] where each string must contain a key-value pair separated by an equal sign, such as "my_parameter=my_value". [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] adds those key-value pairs to the [[REST.Backend.EMSApi.TEMSClientAPI.Request|request]] as [[REST.Client.TCustomRESTRequest.AddParameter|parameters]].
* [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] fills {{Arg|AJSONArray}} with the results from the EMS server.

You may optionally provide an [[System.TArray|array]] of instances of [[REST.Backend.EMSApi.TEMSClientAPI.TModuleResource|TModuleResource]] ({{Arg|AModuleResources}}), so that [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] fills the array with the module resources that the EMS server returns.

=== Exceptions ===

{| class="wikitable"
! Exception
! Message
! Description
|- valign="top"
| rowspan="3" |
[[REST.Backend.EMSApi.EEMSClientAPIError|EEMSClientAPIError]]
|
JSON object expected
|
You passed [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] an [[System.TArray|array]] of instances of [[REST.Backend.EMSApi.TEMSClientAPI.TModuleResource|TModuleResource]] ({{Arg|AModuleResources}}), but [[REST.Backend.EMSApi.TEMSClientAPI.QueryModuleResources|QueryModuleResources]] 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 [[System.JSON.TJSONArray|JSON array]] of [[System.JSON.TJSONObject|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.
|- valign="top"
|
MasterSecret required
|
[[REST.Backend.EMSApi.TEMSClientAPI.Authentication|Authentication]] is [[REST.Backend.EMSApi.TEMSClientAPI.TAuthentication|TAuthentication.MasterSecret]] and [[REST.Backend.EMSApi.TEMSClientAPI.ConnectionInfo|ConnectionInfo]].[[REST.Backend.EMSApi.TEMSClientAPI.TConnectionInfo.MasterSecret|MasterSecret]] is an empty string.
|- valign="top"
|
Session token required
|
[[REST.Backend.EMSApi.TEMSClientAPI.Authentication|Authentication]] is [[REST.Backend.EMSApi.TEMSClientAPI.TAuthentication|TAuthentication.Session]] and you did not [[REST.Backend.EMSApi.TEMSClientAPI.Login|log in]] or the session authentication token that you provided to [[REST.Backend.EMSApi.TEMSClientAPI.Login|Login]] is an empty string.
|}

=== See Also ===

* [[REST.Backend.EMSApi.TEMSClientAPI.UnregisterModuleResource]]
* [[REST.Backend.EMSApi.TEMSClientAPI.UpdateModuleResource]]
* [[REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResource]]
* [[REST.Backend.EMSApi.TEMSClientAPI.RetrieveModuleResourcesFields]]

* [[REST.Backend.EMSApi.TEMSClientAPI.QueryUsers]]
* [[REST.Backend.EMSApi.TEMSClientAPI.QueryGroups]]
* [[REST.Backend.EMSApi.TEMSClientAPI.QueryModules]]
* [[REST.Backend.EMSApi.TEMSClientAPI.QueryInstallations]]

* [[REST.Backend.EMSApi.TEMSClientAPI.QueryResource]]

* [[REST.Backend.EMSServices.TEMSQueryAPI.Query]]


[[Category:API Documentation]]
[[Category:XE8]]