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
Guides
API Reference
Changelog
Event Reference
Log In
API Reference
Log In
Guides
API Reference
Changelog
Event Reference
Workflows
SCALAR APIs
Introduction
Authentication
Authentication
Retrieves the access token
post
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 alarms
get
Retrieves alarms list of an asset
get
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 ID
get
Enables EBPMS for asset
post
Disables EBPMS for asset
post
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 subscription
post
List all webhook subscriptions
get
Get a specific webhook subscription
get
Update an existing webhook subscription
patch
Delete a webhook subscription
del
Deactivate a webhook subscription
post
Activate a webhook subscription
post
Feeds
Create a new feed subscription
post
List all feed subscriptions
get
Get a specific feed subscription
get
Update an existing feed subscription
patch
Delete a feed subscription
del
Activate a feed subscription
post
Deactivate a feed subscription
post
Data Sharing
Overview
Framework Agreements
Fetches framework agreements.
get
Creates framework agreement.
post
Fetches details of framework agreement.
get
Fetches integrator details.
get
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
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
Get the list of remaining times for the given driver(s)
get
Tacho live activities
Provides driver tacho activities
get
Provides asset tacho activities
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 data
get
Configures RF Sensors
post
Detects RF Sensors
post
Stops Diagnostics Session
post
Starts Diagnostics Session
post
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 list
get
Conversations
Get all conversations for organization
get
Get participants for a group conversation only
get
Messages
Retrieves messages from multiple conversations (org-scoped batch)
get
Retrieves attachment details
get
Sends a new message
post
Mark message as seen/read
post
Mark message as treated
post
People Mobility - Booking
Overview
Bookings
Return a list of paginated bookings
get
Retrieve information about a booking
get
Create a booking
post
Cancel a booking
post
Rides
Retrieve information about a vehicle associated to a ride
get
Quotes
Generate one or more quotes
post
Vehicles
Retrieve the details of one or more vehicles
get
PKI Certificate
Overview
CSR
Retrieves a list of CSRs.
get
Retrieves the certificate for the given CSR ID
get
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 definition
del
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 Place
put
Deletes a place by the ID.
del
Get place labels for the organization.
get
Create a place label
post
Delete a place label
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 route
post
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 missions
get
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 resume
patch
Deletes a subscription
del
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 subscription
del
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 archives
post
Teams
Overview
Teams
Retrieves a list of teams.
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 given team.
get
Assign asset groups to team.
post
Unssign asset groups from team.
post
Driver groups
Retrieves list of driver group ids assigned to given team.
get
Assign driver groups to team.
post
Unassign driver groups to team.
post
Place groups
Retrieves list of place group ids assigned to given team.
get
Assign place groups to team.
post
Unassign place groups to team.
post
Users
Retrieves users list of a team.
get
Assigns user(s) to a team
post
Unassigns user(s) from a team.
post
Integrators
Retrieves integrators list of a team.
get
Assign integrators to team.
post
Unassign integrators to 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
Workflow sessions
Retrieves a specific workflow feedback.
get
Powered by
Copy Page
Workflows
Updated 5 months ago
Overview
Workflow sessions
Did this page help you?
Yes
No
Updated 5 months ago
Overview
Workflow sessions
Did this page help you?
Yes
No
