Yoobic Groups API
Groups are used to manage users. This is VERY important as Groups are what make using the application much simpler. By adding Users to Groups, when you need to modify sets of Users, you just change the groups properties and all the Users in the Group inherit these properties (much better than changing each individual user manually). Moreover, Groups allow to restrict visibility when some entities are shared (Missions, News, Documents, ...) ### How do I structure my groups ? Each Group usually corresponds to a population of Users (ex: Admin, HQ, VM Managers, Retail Area Managers, Stores, etc.). ### General Group Usually there is a general group, which has the name of the tenant. This group will contain all of the other Groups and will give the Users access to shared information. Then you will usually find a Group for each type of user. These usually fall into one of these categories: * Admin * Area Managers * HQ * Itinerants * Store Users ### Fields | Field | Type | Required | Readonly | OrderBy | Description | |-----------------------------|:--------:|:--------:|:--------:|:-------:| -------------------------| |`group_id` | string | | x | | The group_id corresponds to the Group title in lowercase letters, with `_` instead of spaces, and without special characters | |`title` | string | x | | | Group Title | |`description` | string | | | | Group Description | |`group_ids` | array | | | x | group ids that belong to this group | |`user_ids` | array | | | x | user ids that belong to this group | |`created_date` | date | | x | | Created Date | |`updated_date` | date | | x | x | Updated Date | |`icon_url` | string | | | | Icon URL | ### Tip To summarise, remember that: * Users are organised in groups * Groups must be created prior to importing any users to the database * A user can belong to multiple groups * There can be sub-groups * Users inherit their level or rights from the group(s) they belong to