Jump to Content
SCALAR
GuidesRecipesAPI ReferenceChangelogEvent Reference
Log InSCALAR
API Reference
Log In
GuidesRecipesAPI ReferenceChangelogEvent Reference
All
Pages
Start typing to search…

SCALAR APIs

  • Introduction

Authentication

  • Authentication
    • Retrieves the access token.post

Activity Definition Manager

  • Overview
  • ActivityDefinitions
    • Retrieves the activity definitions for the specified organization.get
  • Actions
    • Assigns assets to an activity definition profile.post
  • ActivityDefinitionProfiles
    • Get the activity definition profiles for the specified organization.get
    • Get an activity definition profile by ID.get

Alarm Center

  • Overview
  • Supported Alarms
  • Alarms
    • Retrieves a list of alarms.get

Alarms

  • Overview
  • Trailer Alarms
    • Retrieves a list of alarms.get
    • Retrieves alarms list of an asset.get

Assets

  • Overview
  • Assets
    • Retrieves a list of assets.get
    • Retrieves specific asset details.get
    • Creates an asset.post
    • Updates an asset.patch
  • AssetsSettings
    • Retrieves a list of asset settingsget
    • Creates an asset setting for an organization.post
    • Updates an asset setting.patch

Brake Performance

  • Overview
  • EBPMS State Change
    • Retrieves the current brake system state per fleet based on token organization ID.get
    • Retrieves the current brake system state per asset ID.get
    • Retrieves the current state of EBPMS from all the assets with the same state-change-ID.get
    • Enables or Disables EBPMS for asset.put

Data Sharing

  • Overview
  • FrameworkAgreements
    • Retrieves list of framework agreements.get
    • Retrieves framework agreement details by framework agreement ID.get
    • Retrieves integrator details by framework agreement ID.get
    • Creates framework agreement.post
  • Contracts
    • Retrieves list of contracts.get
    • Retrieves contract details by ID.get
    • Creates contract.post
  • Sessions
    • Retrieves list of sessions.get
    • Retrieves session details by ID.get
    • Create sessionpost
    • Updates session.patch
  • Actions
    • Stops framework agreement.post
    • Stops contractpost
    • Stops sessionpost
    • Starts session.post
    • Extends contract.post
    • Approves framework agreement.post
    • Rejects framework agreement.post
  • Profile
    • Retrieves profile details for an organization.get

Drivers

  • Overview
  • Drivers
    • Retrieves a list of drivers.get
    • Retrieves a driver by the ID.get
    • Creates a driver.post
    • Updates a driver by the ID.patch
    • Deletes a driver by the ID.delete

Driving and Resting Times

  • Overview
  • Remaining times
    • Retrieves a list of remaining times for the given driver(s)get

EBS

  • Overview
  • Trailer EBS
    • Retrieves a list of EBS.get
    • Retrieves EBS details of an asset.get

Eco Performance

  • Overview
  • Profiles
    • Retrieves a list of Eco profiles.get
    • Returns default Eco profile.get
    • Returns an Eco profile for the provided profileId.get
    • Creates an Eco profile.post
    • Updates the required Eco profile.patch
    • Deletes the required Eco profile.delete
  • Eco Performance
    • Retrieves the Eco performance.get
  • Reports
    • Retrieves a list of Eco monitor performance items.get

Fleet Installer

  • Overview
  • Fleet Installer
    • Retrieves health diagnostics data.get
    • Sets rf sensors configuration.post
    • Starts unit diagnostics session.post
    • Stops unit diagnostics session.post
    • Detects rf sensors.post

Groups

  • Overview
  • Assets
    • Retrieves asset groups of a specific organization.get
    • Retrieves detailed information of a specific asset group.get
    • Creates an asset group.post
    • Assigns assets to an asset group.post
    • Unssigns assets from an asset group.post
    • Deletes an asset group.delete
    • Updates an asset group.patch
  • Places
    • Retrieves place groups of a specific organization.get
    • Retrieves detailed information of a specific place group.get
    • Creates a place group.post
    • Assigns places to a place group.post
    • Unassigns places from a place group.post
    • Updates a place group.patch
    • Deletes a places group.delete
  • Drivers
    • Retrieves driver groups of a specific organization.get
    • Retrieves detailed information of a specific driver group.get
    • Creates a driver group.post
    • Assigns drivers to a driver group.post
    • Unassigns drivers from a driver group.post
    • Updates a driver group.patch
    • Deletes a driver group.delete

People Mobility - Booking

  • Overview
  • Bookings
    • Return a list of paginated bookingsget
    • Retrieve information about a bookingget
    • Create a bookingpost
    • Cancel a bookingpost
  • Rides
    • Retrieve information about a vehicle associated to a rideget
  • Quotes
    • Generate one or more quotespost
  • Vehicles
    • Retrieve the details of one or more vehiclesget

PKI Certificate

  • Overview
  • CSR
    • Retrieves a list of CSRs.get
    • Retrieves the certificate for the given CSR IDget
    • Initiate Certificate Generation.post

Places

  • Overview
  • Place
    • Retrieves the information of the places.get
    • Returns the place details for an ID.get
    • Creates a place.post
    • Updates a place by the ID.patch
    • Updates a Place.put
    • Deletes a list of place by the Ids.delete
    • Deletes a place by the ID.delete
  • Subscription
    • Retrieves the alarm definition (subscriptions) for the place.get
    • Creates an alarm definition (subscription).post
    • Updates an alarm definition (subscription).put
    • Deletes an alarm definitiondelete

Positions

  • Overview
  • Trailer Positions
    • Retrieves a list of positions.get
    • Retrieves positions list of an asset.get

Reseller Management

  • Overview
  • Organization
    • Retrieves list of organizations.get
    • Retrieves detailed information for the requested organization.get
    • Creates a new organization.post
    • Updates the organization name.patch
  • Subscriptions
    • Retrieves subscriptions of an organization.get
    • Assigns packages to an organization.post
    • Update existing subscription of an organization.put
    • Delete subscription for an organization.delete

Scheduled Trips

  • Overview
  • Trip
    • Retrieves a scheduled trip.get
    • Creates a trip.post
    • Updates a trip.put
    • Deletes a scheduled trip.delete

Sensors

  • Overview
  • Supported Sensor IDs
  • Subscriptions - Getting Started
  • Sensors
    • Retrieves all available sensorIDs.get
    • Retrieves all sensor between last call time and current time.get
    • Retrieves last sensor value.get
    • Retrieves sensor data for specified interval.get
    • Resets last feed call time for a subscriptionID.patch
  • Subscriptions
    • Retrieves subscription details for subscriptionID.get
    • Retrieves subscription details for subscriptionID.get
    • Retrieves all subscriptions of the integrator calling the endpoint.get
    • Retrieves all subscriptions of the integrator calling the endpoint.get
    • Creates a subscription.post
    • Creates a subscription.post
    • Creates a subscription.patch
    • Updates the provided subscription settings replacing sensorIds and assetIds.patch
    • Deletes the provided subscriptionId.delete
    • Deletes the provided subscriptionId.delete

Spot Subcontracting

  • Overview
  • Planning
    • Retrieves a trip.get
    • Retrieves the file(s).get
    • Retrieves the signature(s).get
    • Creates a trip.post
    • Updates a Trip.put

Tacho Management

  • Overview
  • Archives
    • Retrieves the organization archives.get
    • Retrieves the archives for drivers.get
    • Retrieves the archives for assets.get

Teams

  • Overview
  • Teams
    • Retrieves all teams OR teams for the specific organization.get
    • Creates a new team.post
    • Deletes a team.delete
    • Updates a team.patch
  • Asset Groups
    • Retrieves list of asset group IDs assigned to a team.get
    • Assigns asset groups to a team.post
    • Unssigns asset groups from a team.post
  • Driver Groups
    • Retrieves list of driver group IDs assigned to given team.get
    • Assigns driver groups to a team.post
    • Unassigns driver groups from a team.post
  • Place Groups
    • Retrieves list of place group IDs assigned to a team.get
    • Assigns place groups to a team.post
    • Unassigns place groups to team.post
  • Users
    • Retrieves all users assigned to a team OR users of a specific team.get
    • Assigns user(s) to a teampost
    • Unassigns user(s) from a team.post
  • Integrators
    • Retrieves integrators list of a team.get
    • Assigns integrators to a team.post
    • Unassigns integrators from a team.post

tRACK & TRACE

  • Overview
  • Current Activities
    • Retrieves the open activities for the provided assets or drivers.get
  • Historical Activities
    • Retrieves all the activities for an asset or a driver for the given period.get
  • Current Positions
    • Retrieves the current positions for the provided assets.get
  • Historical Positions
    • Retrieves all positions for an asset for the given period.get

Users

  • Overview
  • M2M integrators
    • Retrieves a list of M2M integrators.get
    • Retrieves specific M2M details.get
    • Creates a new machine to machine (M2M) integrator.post
    • Updates specified M2M integrator.patch
    • Deletes specified M2M integrator.delete
  • Roles
    • Retrieves all roles for the specified organization.get
  • Users
    • Retrieves a list of users for a specific organization.get
    • Retrieves specific user details.get
    • Creates new user and assigns a role.post
    • Updates a user.patch
    • Deletes specified user.delete

Workflows

  • Overview
  • workflows
    • Retrieves the workflows.get
  • workflow-sessions
    • Retrieves a specific workflow feedbackget

Introduction

To learn the basics of using SCALAR APIs, please refer to the links below. /

Quick Start

Getting Started

Basic Concepts

  • Base URL
  • Authentication
  • Authorization
  • Pagination
  • Rate Limits
  • Versioning
  • Teams for Integrator
  • Table of Contents
    • Quick Start
    • Basic Concepts