Group getgroup(int groupid, bool loaddevices) – BrightSign Network Web API Reference Manual v.3.8 User Manual

Page 109

Advertising
background image

97

not positive, then the method will return the maximum allowed number of objects. Attempting to request more
objects than is allowed will lead to the same result, but without an error.

Group GetGroup (int presentationId, bool loadAssets)

Description
Retrieves a single

Group

instance with the specified

[int] Id. This method returns Null if he Group instance with the

specified identifier does not exist.

Required Permissions
Group: View Groups

Parameters

[int] groupId: The identifier and primary key of the Group instance to be retrieved.

[bool] loadDevices: A flag specifying whether the method should also initialize and return a list of all

Device

instances that are assigned to the specified Group.

Group GetGroupByName(string name, bool loadContent)

Description
Retrieves the

Group

instance with the specified

[string] Name. This method returns Null if the Group instance with

the specified name does not exist.

Required Permissions
Group: View Groups

Parameters

[string] name: The user-defined Name of the Group instance to be retrieved.

[bool] loadDevices: A flag specifying whether the method should also initialize and return a list of all

Device

instances that are assigned to the specified Group.

Advertising