REST API Quick Reference

The frontend applications communicate with the backend over the REST API for the most part. Real-time event notifications and streaming PID values are sent over Websockets (or MQTT).

Base URL:https://api.vehiclemind.com/

All calls must be authenticated with an user access token. More about that procedeure will follow.

Device Related

Verb URL Function
GET /device/ Get a list of devices
GET /device/{device_id}/ Get single device information
POST /device/{device_id}/ Create a new device object
PUT /device/{device_id}/ Modify an existing device object
DELETE /device/{device_id}/ Delete a single device object

Tag Related

Verb URL Function
GET /tag/ Get a list of tags
GET /tag/{slug}/ Get a specific tag

Trip Related

Verb URL Function
GET /trip/ Get a list of trips
GET /trip/{id}/ Get a specific trip information
POST /trip/{id}/ Create a new trip object
PUT /trip/{id}/ Modify an existing trip object
DELETE /trip/{id}/ Delete an existing trip object
DELETE /trip/{trip_id}/tag/{tag}/ Remove tag from a trip
GET /trip/{trip_id}/tag/{tag}/ Get a tag associated with trip
POST /trip/{trip_id}/tag/ Tag a trip

User Related

Verb URL Function
GET /user/{id}/ Get user basic account information
GET /user/{user_id}/profile/ Get user profile information
GET /user/{user_id}/metadata/ Get user metatdata information
GET /user/{user_id}/device/ Get list of user devices
GET /user/{user_id}/device/{device_id}/ Get specific device information
POST /user/{id}/ Cretae user basic account information object
POST /user/{user_id}/profile/ Create user profile object
POST /user/{user_id}/metadata/ Create user metatdata object
POST /user/{user_id}/device/{device_id}/ Create specific device object

Vehicle Related

Verb URL Function
GET /vehicle/ Get list of user vehicles
GET /vehicle/{id}/ Get single vehicle information
GET /vehicle/{vehicle_id}/mil/ List of vehicles's MIL history