REST.Backend.EMSApi.TEMSClientAPI.CreateGroup
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:
AGroupNameis the name of the new group.AGroupFieldsis an optional JSON object that contains additional data for the new group.AGroupis an instance of TGroup that represents the new group.
Exceptions
| Exception | Message | Description |
|---|---|---|
|
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
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsFields
- REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
- REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveGroupsNames
- REST.Backend.EMSApi.TEMSClientAPI.QueryGroups
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUserGroups
- REST.Backend.EMSApi.TEMSClientAPI.DeleteGroup