For AI agents: the docs index is at https://developers.zf-scalar.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
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 - (All Versions)

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

Alarm Center

  • Overview
  • Alarms
    • Retrieves a list of alarms.get
  • 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

Datahub Subscription

  • Webhooks
    • Create a new webhook subscriptionpost
    • List all webhook subscriptionsget
    • Get a specific webhook subscriptionget
    • Update an existing webhook subscriptionpatch
    • Delete a webhook subscriptiondel
    • Deactivate a webhook subscriptionpost
    • Activate a webhook subscriptionpost
  • Feeds
    • Create a new feed subscriptionpost
    • List all feed subscriptionsget
    • Get a specific feed subscriptionget
    • Update an existing feed subscriptionpatch
    • Delete a feed subscriptiondel
    • Activate a feed subscriptionpost
    • Deactivate a feed subscriptionpost

Data Sharing

  • Overview
  • Contracts
    • Fetches contracts.get
    • Creates contract.post
    • Fetches contract details.get
  • Sessions
    • Fetches sessions.get
    • Creates session.post
    • Updates session.patch
    • Fetches session details.get
  • Actions
    • Stops framework agreement.post
    • Stops contract.post
    • Stops session.post
    • Starts session.post
    • Extends contract.post
    • Approves framework agreement.post
    • Rejects framework agreement.post
  • Profile
    • Fetches profile details for an organization.get
  • Framework Agreements
    • Fetches framework agreements.get
    • Creates framework agreement.post
    • Fetches details of framework agreement.get
    • Fetches integrator details.get
  • Value Propositions
    • Fetches value propositions.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
  • Reports
    • Retrieves a list of Eco monitor performance items.get
  • Eco Performance
    • Retrieves the Eco performance.get
  • 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

Fleet Installer

  • Overview
  • Fleet Installer
    • V1
      • Sets rf sensors configuration.post
      • Detects rf sensors.post
      • Stops unit diagnostics session.post
      • Starts unit diagnostics session.post
      • Retrieves health diagnostics data.get
    • V2
      • Retrieves unit health diagnostics dataget
      • Configures RF Sensorspost
      • Detects RF Sensorspost
      • Stops Diagnostics Sessionpost
      • Starts Diagnostics Sessionpost

Groups

  • Overview
  • Assets
    • Get asset groups of specific organization.get
    • Get asset group with detailed information.get
    • Create an asset group.post
    • Assign assets to asset group.post
    • Unssign assets from asset group.post
    • Delete an asset group.del
    • Update asset group.patch
  • Places
    • Get place groups of specific organization.get
    • Get details of a specific place group.get
    • Create place group.post
    • Assign places to place group.post
    • Unassign places from place group.post
    • Update place group.patch
    • Delete a places group.del
  • Drivers
    • Get driver groups of specific organization.get
    • Get specific driver group.get
    • Create driver group.post
    • Assign drivers to driver group.post
    • Unassign drivers from driver group.post
    • Update driver group.patch
    • Delete driver 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
  • Subscription
    • Retrieves the alarm definition (subscriptions) for the place.get
    • Creates an alarm definition (subscription).post
    • Updates an alarm definition (subscription)put
    • Delete an alarm definitiondel
  • Place
    • Creates a place.post
    • Retrieves the information of the places.get
    • Deletes a list of place by the Ids.del
    • Returns the place details for an ID.get
    • Updates a place by the ID.patch
    • Update a Placeput
    • Deletes a place by the ID.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
  • Mission
    • Creates a set of missions.post
    • Updates a set of missions.put
    • Gets a set of missionsget
    • Deletes a set of missions.del
    • Updates or adds a single mission.put
    • Retrieves a single mission from a mission set.get
    • Deletes a single mission from a mission set.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
    • Import archivespost

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 specified assets/drivers, or for all available assets (paginated) if none are provided.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, or for all available assets (paginated) if none are provided.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 over 1 year ago


What’s Next

  • Getting Started
Did this page help you?

Updated over 1 year ago


What’s Next

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