REST.Backend.EMSServices.TEMSGroupsAPI.AddUsers

• Up to Parent: TEMSGroupsAPI

Delphi

procedure AddUsers(const AGroupName: string; const AUsers: TArray<string>; out AUpdatedObject: TBackendEntityValue);

C++

void __fastcall AddUsers(const System::UnicodeString AGroupName, const System::DynamicArray<System::UnicodeString> AUsers, /* out */ Rest::Backend::Metatypes::TBackendEntityValue &AUpdatedObject);

Properties

Type	Visibility	Source	Unit	Parent
procedure function	protected	REST.Backend.EMSServices.pas REST.Backend.EMSServices.hpp	REST.Backend.EMSServices	TEMSGroupsAPI

Description

Requests to add the specified users to the specified group. Returns True if the EMS server applies the requested change or False if the EMS server returns an error.

AddUsers receives the following parameters:

• AGroupName is the name of the target group.
• AUsers is an array of strings with the IDs of the users that you want to add to the target group.
• AUpdatedObject is an instance of TBackendEntityValue that AddUsers 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.
	Group not found: <specified group name>	The EMS server does not contain any group with the specified group name.
	MasterSecret required	The type of authentication is TAuthentication.MasterSecret and the MasterSecret property of the connection information of the underlying EMS backend service is an empty string.
	Session token required	The type of authentication is TAuthentication.Session you did not log in.

See Also

• REST.Backend.EMSServices.TEMSGroupsAPI.CreateGroup
• REST.Backend.EMSServices.TEMSGroupsAPI.FindGroup
• REST.Backend.EMSServices.TEMSGroupsAPI.UpdateGroup
• REST.Backend.EMSServices.TEMSGroupsAPI.RemoveUsers
• REST.Backend.EMSServices.TEMSGroupsAPI.DeleteGroup

• REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup