API Reference

Overview

Provides an overview of Groups module.

What is Groups

Use the Groups module in the Admin section to collectively manage and view groups in the organization. This functionality can help to define the organized structure of resource groups (assets, places, drivers). The required resource groups/sub-groups can be assigned to team(s) which can be followed by the user as WSW (Who Sees What).

The Groups module allows you to link resources such as assets, drivers, and places to their respective groups. Groups can be created with parent and child (sub-groups) hierarchy. This module also provides details of the teams assigned to the Asset, Place, and Driver groups.

📘

Note:

Groups can only be deleted if they do not have child (sub-groups) and resources.

Base URLhttps://groups.api.eu1.scalar.zf.com
AudienceTMAPI
Supported VersionsV1

Why use Groups

Purpose I: Manage Groups

SCALAR allows organizations to easily manage the assets, drivers, and places groups. The administrator can create various groups and add users and other. The administrator can add and remove entities from a team or remove permanently a team from the SCALAR platform.

Purpose I: Manage Asset Groups

SCALAR allows the administrator of an organization to manage asset groups. Asset groups can be linked to teams and/or assets or unlinked from teams and/or assets.

Purpose II: Manage Driver Groups

SCALAR allows the administrator of an organization to manage driver groups. Driver groups can be linked to drivers and/or teams or unlinked from drivers and/or teams.

Purpose III: Manage Place Groups

SCALAR allows the administrator of an organization to manage place groups. Place groups can be linked to places and/or teams and unlinked from places and/or teams.

Use Cases

Use case I: Manage resource groups

  • Create new asset, driver, and place groups.
  • Modify details of the existing resource groups.

Use case II: Link resource groups

If the organization wants a particular team to access and manage specific resources (assets, drivers, and places), it can create respective resource groups and link those specific resources. For example, asset groups can be linked with assets and teams.

Use case III: View resource group details

SCALAR allows you to retrieve:

  • a list of all the resource groups.
  • all the details of a particular resource group, such as assets and teams of asset group.