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. The Groups module allows you to link resources such as assets, drivers, and places to their respective groups. Assets, Places, and Drivers can be assigned to their groups. Groups can be created with parent and child (sub-groups) hierarchy.

📘

Note:

Groups can only be deleted if they are empty.

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

Why use Groups

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 a new asset, driver, and place groups.
  • Modify an existing resources’ group details.

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.
  • A group can also be deleted permanently from the SCALAR platform if it is empty.

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.