Carriers, Carrier Teams, and Carrier Users

Overview

In Orbit, carriers are organised in a hierarchical structure consisting of Carriers (companies), CarrierTeams (organisational units), and CarrierUsers (individual users). This structure enables efficient organisation and precise control over access rights and operational capabilities.

Carriers

A Carrier represents a company that provides vehicles and drivers to transport goods from one place to another. Carriers are the top-level entity and contain core company information such as:

• Company name and legal information (tax ID, VAT ID)

• Primary business address

• etc.

CarrierTeams

CarrierTeams are organisational units within a Carrier entity. Teams help organise users and manage access within the Carrier's organisation. Common uses for teams include:

• Regional divisions

• Dispatch teams

• Administrative groups

CarrierUsers

CarrierUsers are individual users who belong to a Carrier organisation and can be assigned to specific CarrierTeams. It's important to note that drivers are not a separate user type but rather CarrierUsers with a specific role assignment. Each user has:

• Personal information (name, contact details)

• Individual access rights and permissions

• Specific roles defining their capabilities within the system

• Personal notification preferences

A Note About Drivers

In Orbit, drivers are CarrierUsers with a specific role assignment. This unified approach simplifies user management while maintaining all necessary driver-specific functionalities through role-based permissions and access controls.

Partial Data Inheritance

Orbit implements a partial data inheritance concept between these entities, similar to the Shipper side of the platform. This means that certain data automatically flows from parent entities to their children, while allowing for customization at each level.

How Inheritance Works

• CarrierTeams inherit base company information from their parent Carrier, such as company address and general settings

• Teams can override certain inherited settings with team-specific configurations

• CarrierUsers inherit settings from both their Carrier and assigned CarrierTeam

• Properties and configurations can be set at any level, allowing for flexible customization

Benefits of Partial Inheritance

• Reduces redundant data entry

• Maintains consistency across the organization

• Enables local customization when needed

• Simplifies management of shared settings and documents

API Access

All these entities can be managed through Orbit's REST API, which provides endpoints for:

• Creating and updating Carriers, Teams, and Users

• Managing relationships between entities

• Configuring settings and properties at each level

• Retrieving entity information and hierarchical relationships