Starting from version 3.0 Data Trak Tracking server includes web API to access GPS tracking data from your own applications. Version 3.3 and all later versions are using REST API. Documentation for the API can be found in the swagger.json file and API Reference. There are a lot of tools available to automatically generate client from Swagger format. For more information about Swagger see official website – http://swagger.io/.

There are two authorization options:

• Using session cookies (see “session” URL path)
• Standard HTTP authorization header

View API documentation:

• API Reference

Access token

As an alternative to email and password login, there is an option to use account token for authorization. Token can be set in the corresponding field of the user model. Token can only be used to create a session. It can not be used for basic authorization option.

To create a token use “token” query parameter in session get request:

/api/session?token=USER_TOKEN

WebSocket API

In addition to Data Trak REST API, we provide access to a WebSocket endpoint for live location updates and events. URL for the connection:

/api/socket

Session cookie is the only authorization option for WebSocket connection.

Each message in WebSocket communication uses same universal JSON format:

{
  "devices": [...],
  "positions: [...],
  "events": [...]
}

Each array contains corresponding standard models:

• Device
• Position
• Event

If message does not contain objects of one of the types, the key would not be included in the JSON structure. Most of the time messages contain a single type of objects.

---

 

Tracking

Base URL: /api, Version: 4.2

Summary

Path	Operation	Description
/attributes/computed	GET	Fetch a list of Attributes
	POST	Create an Attribute
/attributes/computed/{id}	DELETE	Delete an Attribute
	PUT	Update an Attribute
/calendars	GET	Fetch a list of Calendars
	POST	Create a Calendar
/calendars/{id}	DELETE	Delete a Calendar
	PUT	Update a Calendar
/commands	GET	Fetch a list of Saved Commands
	POST	Create a Saved Command
/commands/send	GET	Fetch a list of Saved Commands supported by Device at the moment
	POST	Dispatch commands to device
/commands/types	GET	Fetch a list of available Commands for the Device or all possible Commands if Device ommited
/commands/{id}	DELETE	Delete a Saved Command
	PUT	Update a Saved Command
/devices	GET	Fetch a list of Devices
	POST	Create a Device
/devices/{id}	DELETE	Delete a Device
	PUT	Update a Device
/devices/{id}/accumulators	PUT	Update total distance and hours of the Device
/drivers	GET	Fetch a list of Drivers
	POST	Create a Driver
/drivers/{id}	DELETE	Delete a Driver
	PUT	Update a Driver
/events/{id}	GET
/geofences	GET	Fetch a list of Geofences
	POST	Create a Geofence
/geofences/{id}	DELETE	Delete a Geofence
	PUT	Update a Geofence
/groups	GET	Fetch a list of Groups
	POST	Create a Group
/groups/{id}	DELETE	Delete a Group
	PUT	Update a Group
/maintenance	GET	Fetch a list of Maintenance
	POST	Create a Maintenance
/maintenance/{id}	DELETE	Delete a Maintenance
	PUT	Update a Maintenance
/notifications	GET	Fetch a list of Notifications
	POST	Create a Notification
/notifications/test	POST	Send test notification to current user via Email and SMS
/notifications/types	GET	Fetch a list of available Notification types
/notifications/{id}	DELETE	Delete a Notification
	PUT	Update a Notification
/permissions	DELETE	Unlink an Object from another Object
	POST	Link an Object to another Object
/positions	GET	Fetches a list of Positions
/reports/events	GET	Fetch a list of Events within the time period for the Devices or Groups
/reports/route	GET	Fetch a list of Positions within the time period for the Devices or Groups
/reports/stops	GET	Fetch a list of ReportStops within the time period for the Devices or Groups
/reports/summary	GET	Fetch a list of ReportSummary within the time period for the Devices or Groups
/reports/trips	GET	Fetch a list of ReportTrips within the time period for the Devices or Groups
/server	GET	Fetch Server information
	PUT	Update Server information
/session	DELETE	Close the Session
	GET	Fetch Session information
	POST	Create a new Session
/statistics	GET	Fetch server Statistics
/users	GET	Fetch a list of Users
	POST	Create a User
/users/{id}	DELETE	Delete a User
	PUT	Update a User

Security

Paths

Parameter definitions

entityId	id		path	integer
all	all	Can only be used by admins or managers to fetch all entities	query	boolean
refresh	refresh		query	boolean
userId	userId	Standard users can use this only with their own userId	query	integer
deviceId	deviceId	Standard users can use this only with _deviceId_s, they have access to	query	integer
groupId	groupId	Standard users can use this only with _groupId_s, they have access to	query	integer
Device	body		body	object
Permission	body		body	object
Group	body		body	object
User	body		body	object
Geofence	body		body	object
Calendar	body		body	object
Attribute	body		body	object
Driver	body		body	object
Command	body		body	object
Notification	body		body	object
Maintenance	body		body	object
deviceIdArray	deviceId		query	integer[] , multiple parameters (deviceId=aaa&deviceId=bbb)
groupIdArray	groupId		query	integer[] , multiple parameters (groupId=aaa&groupId=bbb)
fromTime	from	in IS0 8601 format. eg. 1963-11-22T18:30:00Z	query	string (date-time)
toTime	to	in IS0 8601 format. eg. 1963-11-22T18:30:00Z	query	string (date-time)

Schema definitions