REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure UpdateGroup(const AGroupName: string;
const AGroupObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateGroup(const AGroup: TGroup; const AGroupObject: TJSONObject;
out AUpdatedAt: TUpdatedAt); overload;

C++

void __fastcall UpdateGroup(const System::UnicodeString AGroupName, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateGroup(const TGroup &AGroup, System::Json::TJSONObject* const AGroupObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;

Properties

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

Description

Replaces the existing information about the specified group with the specified information.

UpdateGroup receives the following parameters:

  • The target group, either as a string with the name of the group (AGroupName) or as an instance of TGroup (AGroup).
  • AGroupObject is a JSON object that contains the new data for the target group.
  • AUpdatedAt is an instance of TUpdatedAt that UpdateGroup fills with the date and time when the EMS Server applied the requested change.

Exceptions

Exception Message Description

EEMSClientAPIError

Group name required

The specified group name is an empty string.

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