REST.Backend.EMSApi.TEMSClientAPI.CreateGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure CreateGroup(const AGroupName: string;
const AGroupFields: TJSONObject; out AGroup: TGroup);

C++

void __fastcall CreateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupFields, /* out */ TGroup &AGroup);

Properties

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

Description

Adds to the EMS server a group with the specified name and data.

CreateGroup receives the following parameters:

  • AGroupName is the name of the new group.
  • AGroupFields is an optional JSON object that contains additional data for the new group.
  • AGroup is an instance of TGroup that represents the new group.

Exceptions

Exception Message Description

EEMSClientAPIError

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