BrightSign Network Web API Reference Manual v.3.8 - Manual (Page 107)

95
Group Management Web Methods
• PagedList<Group> GetGroups(string marker, int pageSize)
• List<Group> GetSpecifiedGroups(int[] groupIds)
• PagedList<Group> FindGroups(string namePattern, string marker, int pageSize)
• Group GetGroup(int groupId, bool loadDevices)
• Group GetGroupByName(string name, bool loadDevices)
• Group CreateGroup(Group entity)
• bool DeleteGroup(int groupId, int reassignmentGroupId)
PagedList<Group> GetGroups(string marker, int pageSize)
Description
Retrieves the next page of the Group list, sorted by
[string] Name. The returned list will contain no more items than
the defined page size.
Required Permissions
Group: View Groups
Parameters
•
[string] marker: The [string] Name of the last Group instance on the previous page. If the value is Null,
then the method will retrieve the first page.
• [int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the
search criteria exceeds the
[int] pageSize limit, the returned list will indicate that it is truncated. If the integer is
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.