Jump to Content
Contact Us
CalAmp Status
Documentation
APIs
CalAmp EU Public
CalAmp EU Private
Contact Us
CalAmp Status
Log In
APIs
Log In
APIs
Smart Trailer API Guide
All
Pages
Start typing to search…
JUMP TO
GETTING STARTED
Introduction
API Authentication
CTC API Convention
CTC Message Streaming Integration
Using the Try It Button
USING THE APIS
DM API
Authentication
Retrieving Device Information
Jobs
Device Smart Search
Smart Search API
Deep Pagination
Data Pump (Real-Time Stream)
Retrieving Events with Data Pump
Results Services (Historical Data)
Retrieving All Event Data for a Single Device
Retrieving Automatic Vehicle Location (AVL) Event Data
Searching for Events
SCI Device Settings
iOn Vision
iOn Vision Prerequisites
Video Application Messages
Working with EDVR and DVR Videos
Video Status and Search Functions
iOn Tags
Retrieving iOn Tag Data with Data Pump
Retrieving iOn Tag Data with Results Services
CrashBoxx Services
CrashBoxx Prerequisites
CrashBoxx Supported Devices
CrashBoxx Installation Guide
CrashBoxx API Description
CrashBoxx Test Tips
Smart Trailer
Smart Trailer API Guide
DM API Gateway
Device Information
Devices Search
post
Device Smart Search
post
Device by ID
get
Device with Latest Event
get
Device Shipping Info
get
Device Manufacturing Info
get
Device Manufacturing Info By Device Id
get
MDT Device Manufacturing Info
get
Device File History
get
Current Device File
get
Current/Pending Filehistory
get
Device Manufacturing Search
post
Device File
DeviceTypes
get
File Upload (step 1)
post
File Upload (step 2)
post
FileMeta
get
Update File
put
File
del
Search Files
post
Download File
get
Download Release Notes
get
Download CSV File
get
Platform by ID
get
Platform by Type and Value
get
Platform by Type
get
Job
Create Job
post
Job
get
Cancel Job Device
put
Cancel Job Task
put
Devices by JobId and TaskIndex
get
Jobs Tasks Search
post
CommandResult by Device Job TaskIndex
get
Get OTA State
get
Get Diag code by code
get
Get Diag code by Type and Code
get
Job Search V3
post
Job Device Search V3
post
Get Job Task Devices V3
get
Event
Change Event Types
get
Change Event History
get
Datapump Services
events
(GET) Events
get
(GET) Event count
get
queue
(DELETE) Queue
del
(GET) Queue Status
get
(PUT) Queue status
put
Results Services
AEMPConstruction
Get the aemp event of user's account.
get
Events
Get all events for the devices in given account between two unique message IDS.
get
Get list of all the Events attached to the Device.
get
Get a list of latest events for all event types attached to the Device.
get
Get list of all the Events attached to the Device based on Unique Identifiers.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
Get a list of latest events for given message type attached to the Device.
get
VehicleBusCapabilities
Perform a search
post
Returns the properties that this resource can be searched on.
get
Get a list of the events attached to the Device.
get
Get a list of latest Vehicle Bus Capabilities Event events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
App
Perform a search
post
Returns the properties that this resource can be searched on.
get
Get a list of the App Messages attached to the Device.
get
Get the last known good position of a device.
get
Get a list of latest App messages attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Avl
Perform a search
post
Returns the properties that this resource can be searched on.
get
Get a list of the Events attached to the Device.
get
Get the last known good position of a device.
get
Get a list of latest Avl events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Aemp
Get a list of the aemp Events attached to the Device.
get
Get a list of latest AEMP events attached to the Device.
get
Get a list of aemp events attached to the Device based on Unique Identifier.
get
DeviceCommand
Get a list of the Events attached to the Device.
get
Get a list of latest Device Command events attached to the Device.
get
Get a list of the Events by Sequence Id.
get
Get a list of events attached to the Device based on Unique Identifier.
get
DTC
Get a list of the Events attached to the Device.
get
Get a list of latest DTC events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
DTC2Report
Get a list of the DTC 2 Reports attached to the Device.
get
Get a list of latest DTC2Report messages attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
ExtendedIdReport
Get a list of the ExtendedIDReport events attached to the Device.
get
Get a list of latest ExtendedIDReport events attached to the Device.
get
Get a list of ExtendedIDReport events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
IdReport
Get a list of the IdReport Events attached to the Device.
get
Get a list of latest IDReport events attached to the Device.
get
Get a list of IdReport events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusConstructionDailyReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Construction Daily Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusConstructionDailyUsageReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Construction Daily Usage Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusConstructionHourlyReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Construction Hourly Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusDailyReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Daily Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusDiscoveryReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Discovery Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusFaultReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Fault Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusHourlyReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Hourly Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JbusHydraulicReport
Get a list of the events attached to the Device.
get
Get a list of latest Jbus Hydraulic Report events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JBusDTC1708
Get a list of the Events attached to the Device.
get
Get a list of latest Jbus DTC 1708 events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
JBusDTC1939
Get a list of the Events attached to the Device.
get
Get a list of latest Jbus DTC 1939 events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
SelfDescribingJPODMessages
Get a list of the JPOD Messages attached to the Device.
get
Get the last known good position of a device.
get
Get a list of latest JPOD_SELF_DESCRIBING messages attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
MotionLog
Get a list of the Events attached to the Device.
get
Get a list of latest Motion Log events attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
User
Get a list of the User Messages attached to the Device.
get
Get the last known good position of a device.
get
Get a list of latest User messages attached to the Device.
get
Get a list of events attached to the Device based on Unique Identifier.
get
Perform a search
post
Returns the properties that this resource can be searched on.
get
Entity Services
accounts
Creates a new account.
post
Retrieve an account by name
get
Perform a search on account properties
post
Returns the properties that account resource can be searched on.
get
Retrieve an account by solomon id
get
Retrieve an Account by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an account.
put
Deletes an account.
del
Activate an existing account.
put
Get the list of all addresses attached to the Account.
get
Retrieve all AempPollerConfigurator for given account.
get
Add a specific airtime plan to the account.
post
Remove a specific airtime plan from the account.
del
Retrieve the list of airtime plans associated with an account.
get
Retrieve alerts for account.
get
Get all the ancestors that belong to the specified account till the user's account level.
get
Get all the ancestors alerts that belong to the specified account.
get
Get the custom message end points from the account and its ancestor. If the 'restrictToEnterprise' is set to true, the ancestor hierarchy stops at the first ancestor account that is an enterprise account.
get
Get all the applications that the specified account has access to.
get
Get all the assets that belong to the specified account.
get
Get a list of the BILLING addresses attached to the Account.
get
Retrieves account's existing collection of PointOfContacts.
get
Add a contact to an existing collection of PointOfContacts. Returning the list of contacts that an account has.
post
Removes all accounts's pointOfContacts.
del
Removes an account's contact with the given contactId from pointOfContacts.
del
Deactivate an existing account.
put
Get all the DeviceConfigurations that belong to the specified account.
get
Get all the devices that belong to the specified account.
get
Retrieves the Extended Attribute for the account denoted by account
get
Adds Extended Attribute for the Account denoted by acctId
post
Overrides the existent Extended Attribute for the Account denoted by acctId
put
Removes the Extended Attribute for the Account denoted by acctId
del
Get GeoMapper for this account
get
Add GeoMapper for this account
post
Dissociate GeoMapper from this account
del
Retrieve the geozones for specific accountId.
get
Retrieve all IOProfiles for given account.
get
Get the MAILING addresses attached to the Account.
get
Get the custom message endpoint for the account.
get
Create the custom message end point for the enterprise account
post
Update the custom message end point for the enterprise account
put
delete the custom message end point for the account.
del
Retrieve all Operators for account.
get
Retrieve all Peg Behaviors for account.
get
Retrieve all Peglabels for account.
get
Get all the roles that belong to the specified account.
get
Retrieve all Routes for given account.
get
Retrieve Service Profile that belong to the specified account.
get
Get SHIPPING addresses attached to the Account.
get
Get all the subaccounts that belong to the specified account.
get
Get all the assets that belong to the specified account and its sub accounts.
get
Get all the devices that belong to the specified account and its sub accounts.
get
Get Subscription level for this account
get
Get Applications for Subscription level of this account
get
Get Modules for Subscription level of this account
get
Get all the users that belong to the specified account.
get
aemppollerconfigurator
Create a AEMP poller configurator.
post
Perform a search on aemppollerconfigurator properties
post
Returns the properties that aemppollerconfigurator resource can be searched on.
get
Retrieve a AEMP Poller Configuration.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an AEMP poller configurator.
put
Delete an AEMP poller configurator.
del
airtimeplans
Retrieve all airtime plan.
get
Creates a new airtime plan.
post
Perform a search on airtimeplan properties
post
Returns the properties that airtimeplan resource can be searched on.
get
Retrieve an airtime plan by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Updates an airtime plan.
put
Delete a airtime plan. Returns the deleted airtime plan.
del
alerts
Retrieves all AlertConfigurations for the current user.
get
Create new AlertConfiguration
post
Lists all AlertActionTypes
get
Adds Extended Attribute for the specified AlertAction
post
Overrides the existent Extended Attribute for the specified AlertAction
put
Removes the Extended Attribute for the specified AlertAction
del
Retrieve AlertConfiguration by name.
get
Perform a search
post
Returns the properties that alertConfiguration resource can be searched on.
get
Retrieves the AlertTypes for the current user.
get
Create new AlertType.
post
Retrieves all AlertActions for the current user
get
Create new AlertAction.
post
Retrieve AlertAction for the given name
get
Perform a search
post
Returns the properties that alertAction resource can be searched on.
get
Retrieve AlertAction by AlertActionById.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an AlertAction.
put
Delete an AlertAction.
del
Retrieve all AlertActionTemplates
get
Create new AlertActionTemplate.
post
Retrieve AlertActionTemplates for the given AlertActionTemplate name
get
Retrieve AlertActionTemplate for the given alertActionTemplateId
get
Update an AlertActionTemplate.
put
Delete an AlertActionTemplate by Id
del
Retrieve AlertType for the given name
get
Perform a search
post
Returns the properties that alertType resource can be searched on.
get
Retrieves all AlertTriggers.
get
Create new AlertTrigger
post
Retrieves all AlertTriggerAttribute.
get
Create new AlertTriggerAttribute
post
Retrieve AlertTriggerAttribute for the given name
get
Retrieve AlertTriggerAttribute for the given alertTriggerAttribute Id
get
Update an AlertTriggerAttribute.
put
Delete an AlertTriggerAttribute.
del
Lists All TriggerConjunction Values.
get
Update an AlertTrigger.
put
Delete an AlertTrigger.
del
Retrieve AlertType by alertTypeId.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an AlertType.
put
Delete an AlertType.
del
Retrieve AlertActionTemplate for the given alertTypeId and templateId
get
Retrieves all AlertTriggers for the AlertType.
get
Retrieve AlertTriggers by alertTypeId and AlertTriggerId.
get
Retrieve AlertConfiguration by alertId.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update AlertConfiguration.
put
Delete an AlertConfiguration.
del
Retrieves the Extended Attribute for the specified AlertConfiguration
get
Adds Extended Attribute for the specified AlertConfiguration
post
Overrides the existent Extended Attribute for the specified AlertConfiguration
put
Removes the Extended Attribute for the specified AlertConfiguration
del
Retrieves the Extended Attribute for the specified AlertAction
get
applications
Create an Application.
post
Perform a search for Applications
post
Returns the properties that Application can be searched on.
get
Retrieve specified Application.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update specified Application.
put
Delete specified Application.
del
Retrieves the ExtendedAttribute for specified Application.
get
Add ExtendedAttribute for specified Application.
post
Update the existing ExtendedAttribute for the specified Application
put
Removes the ExtendedAttribute for the specified Application
del
List notification templates for the specified Application
get
Create a notification template for the specified Application
post
Update a notification template for the specified Application
put
Delete a notification template for the specified Application
del
assets
Create a new asset
post
Bulk API to create new assets
post
Updates multiple Assets.
put
Bulk API to delete assets
del
Create a new asset and associate LMU device and key fobs with it
post
Perform a search on asset properties
post
Returns the properties that asset resource can be searched on.
get
Replace the sensorlayout associated with asset, with the supplied sensorlayout.
put
Bulk API to delete sensorlayout from assets
del
Retrieve Asset by vin, optionally filtered by status.
get
Retrieve an Asset.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an Asset.
put
Delete an Asset.
del
Retrieves assets associated to an Asset.
get
Adds assets to an Asset
post
Replaces the set of assets currently associated with the asset, with the supplied set of assets.
put
Removes Asset's assets.
del
Removes an Asset's asset.
del
Retrieves devices associated to an Asset.
get
Adds Devices to the Asset denoted by assetId
post
Replaces the set of devices currently associated with the asset, with the supplied set of devices.
put
Removes Asset's devices.
del
Removes an Asset's device.
del
Retrieves the Extended Attribute for the Asset denoted by assetId
get
Adds Extended Attribute for the Asset denoted by assetId
post
Overrides the existing ExtendedAttribute for the Asset specified by id
put
Removes the Extended Attribute for the Asset denoted by assetId
del
Replace the extensions for the asset specified by id
put
Associate key fobs to asset
post
Retrieves operator associated to an Asset.
get
Adds Operators to the Asset denoted by assetId
post
Replaces the set of operators currently associated with the asset, with the supplied set of operators.
put
Removes Asset's operators.
del
Retrieve Routes for given asset.
get
Replaces the routes associated with asset, with the supplied routes.
put
Removes Asset's routes.
del
Retrieves schedules associated to an Asset.
get
Adds Schedules to the Asset denoted by assetId
post
Replaces the set of schedules currently associated with the asset, with the supplied set of schedules.
put
Removes Asset's schedules.
del
Retrieve SensorLayout for given asset.
get
Update asset with the supplied sensorlayout.
put
Dissociate sensorlayout from asset
del
autoassetcreate
Create auto asset for Device
post
Retrieve resource identified by the provided id.
get
Create auto asset
post
Automatically create asset from deviceId and vin lookup
post
contacts
Creates a new contact.
post
Retrieve an Contact by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a Contact.
put
Delete a contact.
del
devicecommands
Send Device commands to muliple device
post
Process ota download requests for the given device esn
post
Update the device command message Response status.
post
Create a Application Message Request
post
Create a GeoZone
post
Get information for the given Geozone Id
get
Send a UnitRequest message to the device to enable or disable the specified geozone
post
Create an Id Report Request
post
Create a Location Request
post
Create a Location Request
post
Create a Parameter Read Request By Param Id
get
Create a Parameter Write Request By Param Id
post
Create a Reboot Request
post
Create a unitrequest Request
post
Create a User Message Request
post
Get firmwares for the given architecture
get
Get a list of events by messageUuid
get
Get a list of events by messageUuid
head
Update the status to CANCELLED for given messageuuid
put
Update the status to CANCELLED for given deviceId
del
deviceconfigurations
Retreives the DeviceConfigurations for the current user.
get
Creates a new DeviceConfiguration.
post
Retrieve a DeviceConfiguration by name.
get
Perform a search on deviceconfiguration properties
post
Returns the properties that deviceconfigurations resource can be searched on.
get
Retrieve a DeviceConfiguration by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update DeviceConfiguration.
put
Delete a DeviceConfiguration by its id.
del
deviceresources
Creates a new deviceResource.
post
Retrieves a deviceResource list by device id.
get
Checks and updates deviceResource's apply completion.
put
Process A Router device's ID Report and return next OTA resource
post
Retrieves a resource list by deviceConfiguration ids list, resource type, and account id.
get
Retrieves a resource list by device ids or esns list, resource type, and account id.
get
Retrieves a resourceType list by deviceConfiguration ids.
get
Retrieves a resourceType list by device's ids or esns list.
get
Schedules deviceResources.
post
Perform a search on deviceresource properties
post
Returns the properties that deviceresource resource can be searched on.
get
Retrieves a deviceResource by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Updates a deviceResource.
put
Deletes a deviceResource by its id.
del
Updates deviceResource's status to 'In Progress'.
put
devices
Create a Device.
post
Get the Devices that have downloaded the given Resource File. Filter for the date range of the download. Filter for devices that are still in the download process
post
Retrieve the Device by airId
get
Bulk API to create new devices
post
Updates multiple Devices.
put
Bulk API to delete devices
del
Retrieve Devices by esn, optionally filtered by status.
get
Retrieve Alerts by device esn id.
get
Retrieve a Device by ESN and external ID (iccid, meid, etc.).
get
Perform a search on device properties
post
Returns the properties that device resource can be searched on.
get
Perform free-form, exact match & wild card search on Device properties
post
Returns the properties that SmartSearch Device resource can be searched on.
get
Send notification to provided routers.
post
Retrieve a Device.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a Device.
put
Delete a Device.
del
Add a specific airtime plan to the device.
post
Activate a specific airtime plan for the device.
put
Deactivate a specific airtime plan for the device.
del
List all airtime plans for the device, including the expired ones.
get
Retrieve Alerts by device id.
get
Retrieves an Asset by device's id.
get
Saves SMS Configuration for the Device represented by this id.
post
Retrieve a device and check if its configuration page is available.
get
Retrieves all commands for a device by the given device id.
get
Retrieves the Extended Attribute for the device denoted by deviceId
get
Adds Extended Attribute for the Device denoted by deviceId
post
Overrides the existent Extended Attribute for the device denoted by deviceId
put
Removes the Extended Attribute for the Device denoted by deviceId
del
Retrieves the features for the specified device
get
Updates the features for the specified device
put
Retrieve the geozones for a specific device.
get
Remove a geozone from a device.
del
Updates the ip and/or port for the specified device
put
Replace a Device. The replaced device is deleted. The new device is created with a link to the replaced device. The new device is returned in the response.
post
Retrieves schedules associated to a Device.
get
Adds Schedules to the Device denoted by deviceId
post
Replaces the set of schedules currently associated with the device, with the supplied set of schedules.
put
Removes Device's schedules.
del
Retrieves serviceProfile associated to a Device.
get
Associate serviceProfile to a Device.
put
devicetypes
Retrieves all the DeviceTypes available.
get
Creates a new deviceType.
post
Returns the architecture and category list.
get
Retrieve a DeviceType by name.
get
Perform a search on devicetype properties
post
Returns the properties that devicetype resource can be searched on.
get
Retrieves a DeviceType by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
deviceupdatetemplates
Create a new device update template
post
Retrieve the list of device update templates of an account
get
Perform a search on deviceupdatetemplate properties
post
Returns the properties that deviceupdatetemplate resource can be searched on.
get
Retrieve a device update tempalte by id
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a device update template
put
Delete a device update template
del
files
Create new FileMeta.
post
Perform a search on FileMeta properties
post
Returns the properties that FileMeta resource can be searched on.
get
Retrieve a FileMeta.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a FileMeta.
put
Delete a FileMeta.
del
Retrieves accounts associated to a FileMeta.
get
Associates list of accounts to the FileMeta denoted by filemetaId
post
Replaces the set of accounts currently associated with the filemeta, with the supplied set of accounts.
put
Disassociates Accounts to the FileMeta.
del
geomappers
Retrieves all the accesible geoMappers
get
create geoMapper
post
Perform a search
post
Returns the properties that this resource can be searched on.
get
Retrieve geoMapper by its id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
update geoMapper
put
delete geoMapper
del
geozones
Create a Geozone
post
Deploy one or more geozones to a device
post
Perform a search on geozone properties
post
Returns the properties that geozone resource can be searched on.
get
Get a Geozone by its id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a geozone.
put
Delete a geozone by its id.
del
groupmembers
Delete group members from all groups.
del
Retrieve group members.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Add members to a group.
post
Update group members.
put
Delete group members.
del
groups
Create new Group.
post
Create new groups.
post
Updates multiple groups.
put
Bulk API to delete groups
del
Perform a search on Group properties
post
Returns the properties that group resource can be searched on.
get
Retrieve a Group.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a Group.
put
Delete a Group.
del
Retrieves schedules associated to a Group.
get
Adds Schedules to the Group denoted by groupId
post
Replaces the set of schedules currently associated with the group, with the supplied set of schedules.
put
Removes Group's schedules.
del
ioprofiles
Create the IOProfile.
post
Perform a search on ioprofile properties
post
Returns the properties that ioprofile resource can be searched on.
get
Retrieve the IOProfile.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update the IOProfile.
put
Delete the IOProfile.
del
messagereplay
Retreives all the MessageFiles metadata.
get
Replay messages from given message file.
post
Retreives the MessageFile for given name.
get
Retreives the MessageFile for given name.
head
Uploads given messageFile.
post
Delete a given active message file.
del
operators
Create a new operator
post
Perform a search on operator properties
post
Returns the properties that operator resource can be searched on.
get
Retrieve an Operator.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update an Operator.
put
Delete an Operator.
del
Retrieves the Extended Attribute for the Operator denoted by operatorId
get
Adds Extended Attribute for the Operator denoted by operatorId
post
Overrides the existing ExtendedAttribute for the Operator specified by id
put
Removes the Extended Attribute for the operator denoted by operatorId
del
Retrieves schedules associated to an Operator.
get
Adds Schedules to the Operator denoted by operatorId
post
Replaces the set of schedules currently associated with the operator, with the supplied set of schedules.
put
Removes Operator's schedules.
del
pegbehaviors
Retreives all PegBehavior for the current user.
get
Creates an PegBehavior with specified model.
post
Retreives the PegBehavior for the current user.
get
Perform a search on pegbehavior properties
post
Returns the properties that pegbehavior resource can be searched on.
get
Retrieve a PegBehavior by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a PegBehavior.
put
Delete a pegBehavior. PegBehavior with status Enabled cannot be deleted.
del
Clones a PegBehavior with specified Id to the provided account Id
post
Retrieve a PegEvent for the given PegBehavior id and PegEvent code.
get
Create new PegEvent for the given PegBehavior id
post
Retrieve a PegEvent for the given PegBehavior id and PegEvent id.
get
Update a PegEvent.
put
Removes an pegbehavior's event with the given pegeventId from pegEvents.
del
Create new PegAccumulator for the given PegBehavior id and PegEvent id
post
Retrieve a PegAccumulator for the given PegBehavior id, PegEvent id and Peg Accumulator id.
get
Update a PegAccumulator.
put
Removes an pegevent's accumulator with the given pegaccumulatorId.
del
peglabels
Retreives the PegLabel for the current user.
get
Creates an PegLabel with specified model.
post
Retreives the PegLabel for the current user.
get
Perform a search on peglabel properties
post
Returns the properties that peglabel resource can be searched on.
get
Retrieve a PegLabel by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a PegLabel.
put
Delete a peglabel.
del
permissions
Retrieves the list of permission available in the FOCIS Instance.
get
Perform a search on account properties
post
Returns the properties that permission resource can be searched on.
get
Retrieve a Permission.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
resources
Creates a new resource.
post
Retrieves a resource list for the given account parameters.
post
Perform a search on resource properties
post
Returns the properties that resource can be searched on.
get
Retrieves a Resource by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Updates a resource.
put
Deletes a resource by its id.
del
Restore a deleted resource.
put
roles
Retrieve all roles for the current user's account hierarchy.
get
Create a new Role
post
Perform a search on role properties
post
Returns the properties that role resource can be searched on.
get
Retrieve a Role by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update the Role represented by this path
put
Delete a Role.
del
Retrieves the Extended Attribute for the roled denoted by roleId
get
Adds Extended Attribute for the Role denoted by roleId
post
Overrides the existent Extended Attribute for the Role denoted by roleId
put
Removes the Extended Attribute for the Role denoted by roleId
del
routes
Create a Route.
post
Perform a search on route properties
post
Returns the properties that route resource can be searched on.
get
Retrieve a Route.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update the Route.
put
Delete the Route.
del
Retrieves link of assets associated to a Route.
get
Adds Assets to the Route denoted by routesId
post
Replaces the set of assets currently associated with the route, with the supplied link of assets.
put
Removes Route assets.
del
Retrieves the Extended Attribute for the Route denoted by routesId
get
Adds Extended Attribute for the Route denoted by routesId
post
Overrides the existent Extended Attribute for the Route denoted by routesId
put
Removes the Extended Attribute for the Route denoted by routesId
del
schedules
Create new Schedule.
post
Perform a search
post
Returns the properties that schedule resource can be searched on.
get
Retrieve schedule by scheduleId.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a schedule.
put
Delete a schedule.
del
Retrieve entities associated with the schedule.
get
Associate entities to a schedule.
post
Associate entities to a schedule.
put
Delete entities associated with the schedule.
del
sensorlayouts
Creates a new sensorlayout.
post
Perform a search on sensorlayout properties
post
Returns the properties that sensorlayout resource can be searched on.
get
Retrieve an SensorLayout by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a SensorLayout.
put
Delete a SensorLayout.
del
Retrieve sensors for the given SensorLayout id
get
Create new Sensors for the given SensorLayout id
post
Update Sensors for the given SensorLayout id
put
Delete sensors for the given SensorLayout id
del
Retrieve a Sensor for the given SensorLayout id and Sensor id.
get
Update a Sensor.
put
Removes an sensorlayout's sensor with the given sensorId from sensors.
del
sensortags
Creates a new sensortag.
post
Perform a search
post
Returns the properties that this resource can be searched on.
get
Retrieve a SensorTag by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a SensorTag.
put
Delete a SensorTag.
del
Retrieve the SensorTagElements belonging to the specified SensorTag.
get
Add new SensorTagElements to the specified SensorTag.
post
serviceprofiles
Retrieves the Service Profile for the current user.
get
Create new Service Profile.
post
Perform a search on service profile properties
post
Returns the properties that service profile resource can be searched on.
get
Retrieve Service Profile by Service Profile Id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a Service Profile.
put
Delete a Service Profile.
del
subscriptions
Perform a search on subscriptions properties
post
Returns the properties that subscriptions resource can be searched on.
get
Retrieve a Subscription by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Retrieves modules associated to given subscription by subscription id.
get
systemofunits
Retrieve all SystemOfUnits
get
Retrieve a system unit by <code>name</code>.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
users
Retrieve a User by username using query parameter.
get
Create a user and send a notification to the provided email address.
post
A user has accepted the EULA for an application
post
Retrieve a User by CRM id.
get
Retrieves the list of permissions for the current user.
get
Retrieve User information for currently logged in User/application. Only attributes relevant to user for the application making request will be present.
get
Send an email to the user with a password reset link to change the user's password
get
Reset a user's password to a new one as specified in the request body
post
Perform a search on user properties
post
Returns the properties that user resource can be searched on.
get
Retrieve a User by username.
get
Delete a User by username. Deleting a User marks it 'disabled' and sets the 'terminationDate'
del
Retrieves the list of permisisons assigned to the specified user.
get
Retrieve a User by id.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update the User represented by this path
put
Delete a User. Returns the deleted user.
del
Retrieves auth activities for a User by user id.
get
Retrieves the Extended Attributes for the User
get
Create Extended Attributes for the User
post
Update the Extended Attribute for the User
put
Removes the Extended Attribute for the Role denoted by roleId
del
Changes the password for the specifid User.
put
Retrieves the Preference for the current User-Application pairing
get
Create new Preference for User-Application pairing
post
weather
Retrieve all weather info mappings
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
modbus
Create new Modbus Entity.
post
Retrieve a Modbus by CRC id.
get
Perform a search on modbus properties
post
Returns the properties that modbus resource can be searched on.
get
Retrieve the Modbus.
get
Check if user has access to the resource. This call behaves exactly like `GET` call, except no content is returned.
head
Update a Modbus.
put
Delete a Modbus.
del
Crashboxx Services
Accident Reconstruction
Get Accident Reconstruction for FNL id.
get
Get Acceleration Data for FNL id
get
Get First Notice of Loss and Accident Reconstruction Details for FNL id.
get
Get Speed data for FNL id.
get
Perform a Search
post
Searchable Properties
get
Get FNL counts
post
Devices
Get all deviceIdTypes supported.
get
Get Device Heartbeat Data
post
Search Device Heartbeat Details
post
First Notice of Loss
Get an FNL.
get
Get Raw Messages for FNL id.
get
Get Raw Data by CrashId Csv
get
Update Event Classification State for FNL id.
put
Perform a Search
post
Searchable Properties
get
Examine the Alerts.
post
Predictive Physical Damage
Get Acceleration Data for FNL id.
get
Get Bill of Materials for FNL id.
get
Get First Notice of Loss and Predictive Physical Damage Details for FNL id.
get
Get Speed Data for FNL id.
get
Perform a Dent Search
post
Perform a Dent V2 search
post
Get Image Data for FNL id
get
Retrieve Image Data
post
Searchable Properties
get
Platform
Register a Platform
post
Deregister a Platform.
post
Vas Summary
Search
post
Searchable Properties
get
Vas History
Search
post
Searchable Properties
get
Smart Trailer API
Sensors
Sensor Searchable properties
get
Sensor Search
post
SensorTypeSearch
post
Create TPMS Threshold
post
TPMS Threshold Searchable Properties
get
Search TPMS Threshold
post
TPMS Threshold BulkUpdate
post
Retrieve Volumetric Fill for Trailer
post
VIDEO APIS
Videos
DVR Upload Request
post
DVR Search
post
Search Video Events
post
DVR Requests by UploadRequestId
get
Video
get
Retrieve Video Events By Account ID
get
Retrieve DVR by Identifier
get
Retrieve Video Events by Identifier
get
Get Enriched Video Events by CTC Identifier
get
Harrier
Asset State
Current Asset State by Asset ID
get
Previous Asset State by Asset ID
get
Location Report
Tools by Account ID
get
Location Report by Asset ID
get
Tools by Asset ID
get
Tools by Esn
get
Search
post
Searchable Properties
get
SCI Device State
Get SCI Device State
get
Driving Analytics
Scores
Get Score Cards by Account ID
get
Create Score Card for Account
post
Update Score Card by Account ID and Score Card ID
put
Delete Score Card by Account ID and Score Card ID
del
Get Scores by Operator ID and Asset ID
get
Get Score Card VariableNames
get
Trips
Search
post
Searchable Properties
get
Tag Trips
put
Perform Bulk Business Update
put
Get Trip by Uuid
get
Alert Engine
Alerts Fired
Perform Bulk Acknowledge of Alerts Fired
post
Perform Bulk Delete of Alerts Fired
post
Get Device Identifier Types
get
Get Alert by Id
get
Search
post
Searchable Properties
get
Update Alert Fired by Alert Fired ID
put
Vehicle Engineering Service API
Vehicle Info
Vehicle Info By VIN
get
Vehicle Models
get
Vehicle Enum Table
get
Vehicle Versioned Profile
get
Vehicle Decoded Profile
get
Load YMME
post
Vehicle Capability
List Features By Vin
get
J1939
J1939 Code By PageSize Indexer
get
J1939 Code By Code
get
Diagnostic Test Code
Diagnostic Test Code By PageSize Indexer
get
Diagnostic Test Code by raw DTC code
post
Models
Models List
get
Vehicle
Vehicle By Vin
get
Load YMME
post
Vehicle Diagnostic History
Vbus Diagnostic V1
get
OBD Diagnostic
get
JPOD Diagnostic
get
Vbus Diagnostic V2
get
Vehicle Id History
Vehicle Id Report History V1
get
Vehicle Id Report History V2
get
Vehicle Profile
Vehicle Search
post
Get profile validation results by vin
get
Profile search
post
Get profile by id
get
Delete profile by id
del
Update profile by id
put
Create profile
post
Validation Rules
Retrieving validation rules by id
get
Search validation rules
post
Rule Validation
post
Update_Validation_rule
put
Vehicle Test Flag
Vehicle Test Flag
get
Vehicle Test Flag
put
Content Service API
Content Service API
Upload Content
post
Content by account Id
get
Content by entity Id
get
Content by entity type
get
Content by account Id and content Id
get
Content by content Id
get
Delete content by UUID
del
Inventory Manager
Provisioned Devices
Provisioned Devices
post
Task
Task status
get
Sub task status
get
Manufacturing Info
Manufacturing Info
get
Password Manager
Password Manager
Retrieve password for bulk devices.
post
Retrieve password based on identifier.
get
Carrier Service
Carrier service
Sim pre activation
post
Sim activation
post
Sim deactivation
post
Sim status
get
Bulk Activities
Bulk sim activate and deactivate
post
Bulk sim status
post
Powered by
Smart Trailer API Guide
Ask AI
