For AI agents: visit https://developers.zf-scalar.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
SCALAR
GuidesAPI ReferenceChangelogEvent Reference
Log InSCALAR
API Reference
Log In
GuidesAPI ReferenceChangelogEvent Reference

SCALAR APIs

  • Introduction

Authentication

  • Authentication
    • Retrieves the access tokenpost

Activity Definition Manager

  • Overview
  • Activity definitions
    • Retrieves activity definitionsget
  • Actions
    • Assigns assets to an activity definition profilepost
  • Activity definition profiles
    • Retrieves activity definition profilesget
    • Retrieves an activity definition profile by IDget

Alarm Center

  • Overview
  • Alarms
    • Retrieves alarmsget
  • Supported alarms
  • Alarm triggers

Alarms

  • Overview
  • Trailer alarms
    • Retrieves a list of alarmsget
    • Retrieves alarms list of an assetget

Assets

  • Overview
  • Assets
    • Retrieves assets.get
    • Retrieves specific asset.get
    • Creates asset.post
    • Updates an asset.patch
  • Asset settings
    • Retrieves asset settings.get
    • Creates asset settings for organization.post
    • Updates an asset setting.patch
  • Asset configurations
    • Retrieves assets configurations.get

Brake Performance

  • Overview
  • EBPMS state change
    • Returns the current brake system state per fleet based on token organization ID.get
    • Returns the current brake system state per asset IDget
    • Enables EBPMS for assetpost
    • Disables EBPMS for assetpost
  • EBPMS performance data
    • Return the list of brake performance values per fleet based on token organization ID.get

Data Sharing

  • Overview
  • Framework agreements
    • Fetches list of framework agreements.get
    • Fetches framework agreement details by framework agreement ID.get
    • Fetches integrator details by framework agreement ID.get
    • Creates framework agreement.post
  • Contracts
    • Fetches list of contracts.get
    • Fetches contract details by ID.get
    • Creates contract.post
  • Sessions
    • Fetches list of sessions.get
    • Fetches 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
    • Fetches profile details for an organization.get

Diagnostic Trouble Code (DTC)

  • Overview
  • Assets
    • Retrieves DTC ledger entries for a single asset.get
    • Retrieves DTC ledger entries for multiple assets.get

Documents

  • Overview
  • Document
    • Retrieves a list of documents for an organization and a range.get
    • Retrieves a document.get
    • Retrieves file(s)get
    • Generates a pdf document.get

Drivers

  • Overview
  • Drivers
    • Retrieves a list of all drivers.get
    • Retrieves the driver for the provided ID.get
    • Creates a new driver.post
    • Updates the driver by the providedID.patch
    • Marks the driver as inactive by providing the ID.del

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.del
  • 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
    • Starts unit diagnostics session.post
    • Stops unit diagnostics session.post
    • Detects rf sensors.post
    • Sets rf sensors configuration.post

Groups

  • Overview
  • 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.del
  • 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
    • Unassigns assets from an asset group.post
    • Deletes an asset group.del
    • 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.del

Messaging

  • Overview
  • Contacts
    • Retrieves a contacts listget
  • Conversations
    • Get all conversations for organizationget
    • Get participants for a group conversation onlyget
  • Messages
    • Retrieves messages from multiple conversations (org-scoped batch)get
    • Retrieves attachment detailsget
    • Sends a new messagepost
    • Mark message as seen/readpost
    • Mark message as treatedpost

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 a list of places.get
    • Retrieves a place by ID.get
    • Creates a place.post
    • Updates a place.patch
    • Updates a place.put
    • Deletes a place.del
  • Subscription
    • Retrieves alarm definition (subscriptions).get
    • Creates an alarm definition (subscription).post
    • Updates an alarm definition (subscription).put
    • Deletes an alarm definition.del

Positions

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

Precomputed Route Service

  • Overview
  • Precomputed routes
    • Store a new precomputed routepost

Reseller Management

  • Overview
  • Organizations
    • 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.del

Scheduled Trips

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

Sensors

  • Overview
  • Supported sensor IDs
  • Subscriptions - Getting Started
  • Sensors
    • Retrieves all available sensorIDs.get
    • Retrieves all sensor data for a subscription ID between the last and current time.get
    • Retrieves last sensor value for given sensorIds and assetIds.get
    • Retrieves sensor data for the given sensor and asset IDs.get
    • Resets last feed call time for a subscriptionID.patch
  • Subscriptions
    • V1
      • Retrieves all subscriptions of the integrator calling the endpoint.get
      • Retrieves subscription details for subscriptionID.get
      • Creates a subscription.post
      • Updates subscription status to suspend or resumepatch
      • Deletes a subscriptiondel
    • V2
      • Retrieves all subscriptions of the integrator calling the endpoint.get
      • Retrieves subscription details for subscriptionID.get
      • Creates a subscription.post
      • Updates subscription settings replacing the sensorIds, assetIds, unitIds and status parameters.patch
      • Deletes a subscriptiondel

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 team.post
    • Deletes team for the team ID.del
    • Updates team for the team ID.patch
  • Asset groups
    • Retrieves list of asset group IDs assigned to a team.get
    • Assigns asset groups to a team.post
    • Unassigns 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 the team.get
    • Assigns place groups to a team.post
    • Unassigns place groups from a 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
  • Historical Activity Context Events
    • Retrieves all the activity-context-events for an asset or a driver 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.del
  • 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.del

Workflows

  • Overview
  • Workflows
    • Retrieves the workflows.get
  • Workflow sessions
    • Retrieves a specific workflow feedbackget
Powered by 

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

Updated about 1 year ago


What’s Next

  • Getting Started
Did this page help you?

Updated about 1 year ago


What’s Next

  • Getting Started
Did this page help you?
    • Quick Start
    • Basic Concepts