REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsNames

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function RetrieveGroupsNames: TArray<string>;

C++

System::DynamicArray<System::UnicodeString> __fastcall RetrieveGroupsNames();

Properties

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

Description

Returns an array with the names of groups that are registered in the EMS server.

Exceptions

Exception Message Description

EEMSClientAPIError

JSON object expected

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 group.

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