Group creategroup(group entity) – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 110

Advertising
background image

98

Group CreateGroup(Group entity)

Description
Creates a new

Group

instance with the specified name and settings. If successful, this method will return a Group

instance with all initialized properties. If an error occurs, the method will return Null.

Required Permissions
Group: Create Group

Parameters

[Group] entity: A Group object instance with an initialized name, device autorun version, firmware versions,
and debugging settings. Other property values will be ignored. If this parameter is set to Null, the method will
immediately return False without an error. A descriptive error will be returned if any of the following conditions
occur:

o The length of the specified Group [string] Name is greater than 50 characters.
o The specified Group [string] Name is already in use by another Group instance within the account.
o Creating the Group instance will cause the total number of Group instances to exceed the limit set on the

server.

bool DeleteGroup(int groupId, int reassignmentGroupId)

Description
Deletes the specified

Group

instance and assigns all devices within it to another specified Group instance. This

method only returns True if completely successful. Otherwise, it returns False.

Required Parameters
Group: Delete Group, Remove Device – Device: Change Target Group

Parameters

[int] groupId: The identifier of the Group instance to be deleted. If the [int] Id value is negative, the
method will immediately return False without an error. A descriptive error will be returned if the Group specified for

Advertising