API

Stolen Vehicle Recovery Systems

Overview

To send a command, make an HTTP POST or GET request to the appropriate URL. The URL's begin with http://guidepointsystems.com/api2 and end with value next to the get or post. If the command has parameters, include it in the url with ?Name Of PARAMETER.

Example:

To get vehicle information using the VIN use http://guidepointsystems.com/api2/vehicle/vin?vin=ENTER VIN HERE.


Response Format

The surpported API response format is JSON.

Sample JSON result:

{
      "make":"Dodge",
      "model":"Durango",
      "year":"2002",
      "color":"purple",
      "license_plate":"",
      "insurance_holder_name":",
      "insurance_company":",
      "insurance_company_phone":",
      "insurance_policy_number":",
      "insurance_type":",
      "insurance_expiration_date":",
      "features":[
         "OPENDOORS",
         "STARTENGINE",
         "CARFIND"
      ],
   } 

Authentication

You must provide some form of authentication with any API request that requires it. It's safe to assume that most, if not all, API requests will require authentication. To do so, include the token(see /token/create in Methods to create token) parameter with your API request.

So, for example, if your request was normally `/api2/vehicle/vin?vin=1234`, you would need to have: `/api2/vehicle/vin?vin=12344&token=123456789`

Parameters

username (required)
string — User's Username.
password (required)
string — User's Password.
token (required)
string — User's token.

Device Verification

Before a token can be requested, the device you are requesting it from must be verified. This requires the use of the verification requests.

Attempts to retrieve or create a token without a verified device will return an error code of 2100. Valid protocols will be returned along with the request.

There are three steps to take in order to verify your device.

  1. Request a device id by calling `/api2/verification/device-id`
    • The response will look like this:
      {"device_id":"123456789"}

  2. Using this device id, make a request to `/api2/verification/login-code`
    • For example, `/api2/verification/login-code?username=user&password=pass&device_id=123456789&protocol=sms` will request that a verification code be sent to the cell phone number tied to the account.

  3. After retrieving the verification code, make a request to `/api2/verification/login`
    • For example, if the code `123456` is sent to your device, the request would look like `/api2/verification/login?username=user&password=pass&device_id=123456789&verification_code=123456`

After your device is verified, request a token using one of the two token requests and your verified device_id.


Login

To access the website use the login page http://guidepointsystems.com/laravel/login. Enter your username and password into the form and click on the login button.

post: /login
Login
Description Logging into the Website
Using your username and pasword OR token to login into the website and redirect page.\n

Parameters

username (required)
string — User's Username.
password (required)
string — User's Password.
token (required)
string — User's token.
page (optional)
string — Specify page to redirect "mapping", "dashboard", "reports". The default is dashboard.
mapType (optional)
string — Specify the map type for the mapping page "HYBRID", "SATELLITE", "TERRAIN", "ROADMAP". The default is HYBRID.

Methods

post: /token/create
Token
Description Create Token
Creates a token for the User's Account.
Note: read the notes above on device verification before using this route.

Parameters

username (required)
string — User's Username.
password (required)
string — User's Password.
device_id (required)
Query Parameter — User's Device ID.

Return type


get: /token/tokens
Token
Description Retrieves User's Token.
Retrieves all the User's Token.
Note: read the notes above on device verification before using this route.

Parameters

username (required)
Query Parameter — User's Username.
password (required)
Query Parameter — User's Password.
device_id (required)
Query Parameter — User's Device ID.

Return type


get: /verification/device-id
Verification
Description Create a device id
Creates a device id for the User's device.

Return type


post: /verification/login-code
Verification
Description Request a verification code
Requests a verification code via the given protocol for the given device.

Parameters

username (required)
Query Parameter — User's Username.
password (required)
Query Parameter — User's Password.
device_id (required)
Query Parameter — User's Device ID.
protocol (required)
Query Parameter — The protocol to receive the code through. Protocols are: {"sms", "email"}.

post: /verification/login
Verification
Description Request a verification code
Attempts to submit a verification code for the given device.

Parameters

username (required)
Query Parameter — User's Username.
password (required)
Query Parameter — User's Password.
device_id (required)
Query Parameter — User's Device ID.
verification_code (required)
Query Parameter — The verification code to check.

post: /admin/Alert
Admin
Description Add or Edit Alert
Add or Edit Speeding, Low Battery, Power Disconnect, Geofence, or Inactive Alert.

Parameters

buttonType (required)
Query Parameter — If adding a Alert use "add" or if editing user "edit".
alertType (required)
Query Parameter — The alert being add/edit. It can be speeding for Speeding, powerdis for PowerDisconnect, lowbat for Low Battery, inactive for Inactive, geofence for Geofence.
email (required)
Query Parameter — Email to be sent when there is an alert.
unitid (required)
Query Parameter — UnitID.
name (required)
Query Parameter — Name of the alert.
duration (optional)
Query Parameter — Duration of seconds when speed limit is reach or pass to send an alert. Required for adding/editing speed alert.
limit (optional)
Query Parameter — Speed limit.
days (optional)
Query Parameter — Days the vehicle is inactive. Required for inactive alert.
landmark (optional)
Query Parameter — LandmarkID.
start (optional)
Query Parameter — Start time of geofenece alert. Required for geofence alert.
end (optional)
Query Parameter — End time of geofence alert. Required for geofence alert.
arriveDepart (optional)
Query Parameter — Arrival of a vehicle into a landmark use "Arrival" or departure of a vehicle from a landmark use "Departure".

post: /admin/remove-alert
Admin
Description Remove Speeding, Low Battery, Power Disconnect, Geofence, or Inactive Alert.
Delete a Speeding, Low Battery, Power Disconnect, Geofence, or Inactive Alert.

Parameters

id (required)
Query Parameter — ID of alert.
alertType (required)
Query Parameter — The alert type. It can be "speeding" for Speeding, "powerdis" for PowerDisconnect, "lowbat" for Low Battery, "inactive" for Inactive, "geofence" for Geofence.

get: /admin/batdis
Admin
Description Scheduled Battery Disconnect Alert
Retrieves all scheduled battery disconnect alerts.

Parameters


get: /admin/speeding
Admin
Description Scheduled Speeding Alerts
Retrieves all scheduled speeding alerts.

Parameters


post: /admin/updatevehicle
Admin
Description Update Vehicle Information
Update the vehicle's name, make, model, color, year, miles, VIN, license plate, and loaner status.

Parameters

id (required)
string — VehicleID (exactly 22 alphanumeric characters).
vName (required)
string — Vehicle name.
make (required)
string — Vehicle make.
model (required)
string — Vehicle model.
year (required)
integer — Vehicle year.
color (required)
string — Vehicle color.
vin (required)
string — Vehicle VIN.
plate (required)
string — Vehicle license plate.
miles (required)
integer — Vehicle miles.
loaner (required)
string — If the vehicle is a loaner than "true" else "false".
landmarkId (optional)
string — If the vehicle is a loaner it will need a landmarkid (exactly 22 alphanumeric characters)set as it's home.
features (optional)
string — Array of vehicle features.The features are "DISABLE", "WARNINGON", "WARNINGOFF", "OPENDOORS", "STARTENGINE", "CARFIND"

Sample JSON result:

{
      "id":"vehc-55617d52-f78256a1",
      "user_id":"user-547c8b76-2505e8a9",
      "unit_id":null,
      "name":"2F215607",
      "phone":"",
      "miles":null,
      "make":"Dodge",
      "model":"Durango",
      "year":"2002",
      "color":"purple",
      "license_plate":",
      "insurance_holder_name":",
      "insurance_company":",
      "insurance_company_phone":",
      "insurance_policy_number":",
      "insurance_type":",
      "insurance_expiration_date":",
      "features":[
         "OPENDOORS",
         "STARTENGINE",
         "CARFIND",
         "DISABLE"
      ],
      "notes":"",
      "status":"ACTIVE",
      "trim":"SLT",
      "engine":"Engine",
      "unit":{
         "is_loaner":"0",
         "landmark_id":"",
         "id":"unit-4dc2bc25-df5332ca",
         "esn":"637970357509",
         "user_id":"user-547c8b76-2505e8a9",
         "vehicle_id":"vehc-55617d52-f78256a1",
      },
   },
    

post: /removevehicles/remove-vehicles
Unit
Description Remove Vehicle
Removes a vehicle with a unit attached from the user's account.

Parameters

vehicles (required)
array — Array of VehicleID.
firstname (required)
string — User First Name.
lastname (required)
string — User Last Name.
email (required)
string — User email.
type (optional)
string — Reason for removing the vehicle.The Commands are "sold", "removed", "trade".

post: /unit/activate
Unit
Description Add Vehicle
Add a vehicle with a unit attached to a user's account.

Parameters

esn (required)
string — Unit ESN.
vehicleName (optional)
string — Vehicle name.
make (required)
string — Vehicle make.
model (required)
string — Vehicle model.
year (required)
integer — Vehicle year.
color (required)
string — Vehicle color.
vin (required)
string — Vehicle VIN.
licensePlate (optional)
string — Vehicle license plate.
trim (optional)
string — Vehicle trim.
engine (optional)
string — Vehicle engine.
vehicleNotes (optional)
string — Vehicle notes.
firstName (required)
string — User First Name. Only required for Surepay accounts.
lastName (required)
string — User Last Name. Only required for Surepay accounts.
city (required)
string — User City. Only required for Surepay accounts.
state (required)
string — User state. Only required for Surepay accounts.
zip (required)
string — User zipcode. Only required for Surepay accounts.
email (required)
string — User email. Only required for Surepay accounts.
phone (optional)
string — User phone number. Only required for Surepay accounts.

get: /admin/vehicleinfo
Admin
Description Vehicle Info
Retrieves the vehicle and unit information for a given VehicleID.
http://guidepointsystems.com/api2/admin/vehicleinfo?id=VehicleID

Parameters

id (required)
string — The VehicleID (exactly 22 alphanumeric characters)

get: /geofence/landmarks
Geofence
Description Lists landmarks
Retrieves a list of all the users landmarks.

Parameters


post: /admin/geofences
Geofences
Description Save a landmark
Saves a landmark with the given parameters

Parameters

name
Form Data — Landmarks name
description
Form Data — Landmarks description
latitude
Form Data — Latitude of radius (required if type is "Point")
longitude
Form Data — Longitude of radius (required if type is "Point")
radius
Form Data — Radius of geofence in miles (required if type is "Point")
coordinates
Form Data — A two dimensional array of coordinate pairs used for the border of the landmark (required if type is "Polygon")
For example,
coordinates[0][]:32.96949953291243
coordinates[0][]:-97.93899536132812
coordinates[1][]:32.93262346411481
coordinates[1][]:-97.9486083984375
coordinates[2][]:32.98447604071901
coordinates[2][]:-97.82913208007812
creates a triangular landmark using those coordinate pairs.
type
Form Data — Type of landmark. Values are ("Point", and "Polygon")
emails[]
Form Data — An array of emails for landmark alerts. Note that multiple emails need to be passed in as a separate value for the emails[] parameter.
For example,
emails[]: test@guidepointsystems.com
emails[]: test2@guidepointsystems.com
sends an email to these two email addresses.
arrival
Form Data — Send alerts for arrivals to this landmark. Possible values are 1 or 0.
departure
Form Data — Send alerts for departures from this landmark. Possible values are 1 or 0.
dealerLot
Form Data — Mark this landmark as a dealer lot. Possible values are 1 or 0.
isGlobal
Form Data — Mark this landmark as applying to all vehicles.
vehicles
Form Data — Comma separated list of vehicle ids that are associated with this landmark.
render_type
Form Data — The render type to use when display the landmark on the map. Possible values are ("fill", "outline", and "hide")
scheduled_time_start
Form Data — Optional. When the scheduled landmark should become active.
scheduled_time_end
Form Data — Optional. When the scheduled landmark should deactivate.

put: /admin/geofences/{id}
Geofences
Description
Edits a geofence with the given id. Replace {id} with the id of the landmark to edit. Note that landmark IDs are in the following format: land-xxxxxxxx-xxxxxxxx

Parameters

name
Form Data — Landmarks name
description
Form Data — Landmarks description
latitude
Form Data — Latitude of radius (required if type is "Point")
longitude
Form Data — Longitude of radius (required if type is "Point")
radius
Form Data — Radius of geofence in miles (required if type is "Point")
coordinates
Form Data — A two dimensional array of coordinate pairs used for the border of the landmark (required if type is "Polygon")
For example,
coordinates[0][]:32.96949953291243
coordinates[0][]:-97.93899536132812
coordinates[1][]:32.93262346411481
coordinates[1][]:-97.9486083984375
coordinates[2][]:32.98447604071901
coordinates[2][]:-97.82913208007812
creates a triangular landmark using those coordinate pairs.
type
Form Data — Type of landmark. Values are ("Point", and "Polygon")
emails[]
Form Data — An array of emails for landmark alerts. Note that multiple emails need to be passed in as a separate value for the emails[] parameter.
For example,
emails[]: test@guidepointsystems.com
emails[]: test2@guidepointsystems.com
sends an email to these two email addresses.
arrival
Form Data — Send alerts for arrivals to this landmark. Possible values are 1 or 0.
departure
Form Data — Send alerts for departures from this landmark. Possible values are 1 or 0.
dealerLot
Form Data — Mark this landmark as a dealer lot. Possible values are 1 or 0.
isGlobal
Form Data — Mark this landmark as applying to all vehicles.
vehicles
Form Data — Comma separated list of vehicle ids that are associated with this landmark.
render_type
Form Data — The render type to use when display the landmark on the map. Possible values are ("fill", "outline", and "hide")
scheduled_time_start
Form Data — Optional. When the scheduled landmark should become active.
scheduled_time_end
Form Data — Optional. When the scheduled landmark should deactivate.

delete: /admin/geofences/{id}
Geofences
Description Delete a landmark
Deletes a geofence with the given id. Replace {id} with the id of the landmark to edit. Note that landmark IDs are in the following format: land-xxxxxxxx-xxxxxxxx

get: /unit/command
Unit
Description Send Unit Command
Attempts to execute the given command for the unit.
http://guidepointsystems.com/api2/unit/command?esn=72A141910152&command=LocateUnit

Parameters

esn (required)
string — Unit's ESN.
command (required)
string — Unit Command. Example - LocateUnit', 'EnableStarter', 'DisableStarter', 'WarningOn', 'WarningOff', 'OpenDoors', 'StartEngine', 'CarFind', 'ActivateUnit', 'VIPOn', 'VIPOff'.

Sample JSON result:

{
    "success":"default.commandSuccess",
    "result":{
      "Latitude":"32.759470",
      "City":"Fort Worth",
      "State": "TX",
      "ZIP": "76107",
      "Address":"2910-2998 White Settlement Road",
      "Result":1,
      "Longitude":"-97.359370",
      "Country":"US",
      "Speed":"80",
      "Direction":"N"
    }
  }
  

get: /unit/info
Unit
DescriptionUnit Information
Retrieves the unit and the vehicle(if vehicle attached to unit) information.
http://guidepointsystems.com/api2/unit/info?esn=123456789

Parameters

esn (required)
string — Unit's ESN.

Sample JSON result:

    {
      "id":"unit-547fe5be-ba4664cc",
      "esn":"60A143350004",
      "vehicle_id":"vehc-54873524-86919ee5",
      "vehicle":{
        "id":"vehc-54873524-86919ee5",
        "unit_id":"unit-547fe5be-ba4664cc",
        "name":"60A143350004",
        "phone":"",
        "miles":"2500",
        "make":"Cadillac",
        "model":"STS",
        "year":"2007",
        "color":"Black",
        "vin":"",
        "expiration_date":"2015-01-09 00:00:00",
        "term":"M",
        "status":"ACTIVE",
        "trim":null,
        "engine":""
      }
    },
    

get: /unit/inventory-list
Unit
DescriptionESN list
Retrieves all the ESN in the user's inventory.
http://guidepointsystems.com/api2/unit/inventory-list

Sample JSON result:

    [
      "123456789",
      "987654321"
    ]
    

get: /unit/most-recent
Unit
Description Retrieves Recent Location
Retrieves the most recent location for the unit.
http://guidepointsystems.com/api2/unit/most-recent?esn=123456789

Parameters

esn (required)
string — Unit's ESN.

Sample JSON result:

{
    "success":"default.commandSuccess",
    "result":{
      "Latitude":"32.759470",
      "City":"Fort Worth",
      "State": "TX",
      "ZIP": "76107",
      "Address":"2910-2998 White Settlement Road",
      "Result":1,
      "Longitude":"-97.359370",
      "Country":"US",
      "Speed":"80",
      "Direction":"N"
    }
  }
  

get: /unit/sent-messages
Unit
Description Messages Sent to a Unit
Retrieves messages that has been sent to a unit.
http://guidepointsystems.com/api2/unit/sent-messages?esn=ESN

Parameters

esn (required)
string — Unit's ESN.

post: /unit/unit-transfer
Unit
Description Tranfer Unit
Tranfer units to another user account. If the unit doesn't have a vehicle atttached to it then the unit will be transfer to the user's inventory.

Parameters

esns (required)
array — Unit's ESN.
account (required)
string— Username of the account to transfer the units.

get: /unit/units
Unit
Description Retrieve All Unit
Retrieves all units inactive or active information in the account.
http://guidepointsystems.com/api2/unit/units

Sample JSON result:

    {
      "id":"unit-547fe5be-ba4664cc",
      "esn":"60A143350004",
      "user_id":"user-547c8b76-2505e8a9",
      "vehicle_id":"vehc-54873524-86919ee5",
      "vehicle":{
         "id":"vehc-54873524-86919ee5",
         "unit_id":"unit-547fe5be-ba4664cc",
         "maintenance_id":null,
         "name":"60A143350004",
         "miles":"2500",
         "make":"Cadillac",
         "model":"STS",
         "year":"2007",
         "color":"Black",
         "vin":"",
         "expiration_date":"2015-01-09 00:00:00",
         "status":"ACTIVE",
         "trim":null,
         "engine":""
      }
    },
    


post: /user/create
User
Description Create User Account
Create a user account and an inventory account.

Parameters

first_name (required)
string — User's first name.
last_name (required)
string — User's last name.
address (required)
string — User's street address.
city (required)
string — User's city.
state (required)
integer — User's state.
zip (required)
string — User's zipcode.
country (required)
string — User's country. Example - 'US', 'MX'.
timezone (required)
string — User's timezone. Example - 'EST'.
locale (required)
string — Full name of user's country. Example - 'USA', 'MEXICO', 'CANADA'.
account_username (required)
string — User's username.
account_password (required)
string — User's password.
home_phone (required)
string — User's home phone number.
cell_phone (optional)
string — User's cell phone number.
email (required)
string — User's email.
dealership_name (required)
string — Dealership/Company name.


get: /vehicle/active-installed
Vehicle
Description Active Vehicles with Units
Retrieves only those vehicles that are active in the account which have a unit associated with them.
http://guidepointsystems.com/api2/vehicle/active-installed

Sample JSON result:

{
      "id":"vehc-55617d52-f78256a1",
      "user_id":"user-547c8b76-2505e8a9",
      "unit_id":null,
      "name":"2F215607",
      "phone":"",
      "miles":null,
      "make":"Dodge",
      "model":"Durango",
      "year":"2002",
      "color":"purple",
      "license_plate":"",
      "insurance_holder_name":",
      "insurance_company":",
      "insurance_company_phone":",
      "insurance_policy_number":",
      "insurance_type":",
      "insurance_expiration_date":",
      "features":[
         "OPENDOORS",
         "STARTENGINE",
         "CARFIND",
         "DISABLE"
      ],
      "notes":"",
      "status":"ACTIVE",
      "trim":"SLT",
      "engine":"Engine",
      "unit":{
         "is_loaner":"0",
         "landmark_id":"",
         "id":"unit-4dc2bc25-df5332ca",
         "esn":"637970357509",
         "user_id":"user-547c8b76-2505e8a9",
         "vehicle_id":"vehc-55617d52-f78256a1",
      },
   },
  

get: /vehicle/report
Vehicle
Description Vehicles Report
Retrieves report for vehicles.
Limits
Each report has a limit of 5 vehicles except for the Exceptions, Inactive, Activations, and Command History Reports. The date range or duration per report can be a maximum of 30 days.

Parameters

reportType (required)
string — The report type to make and retrieve. The commands are "History" for History Report, "Exception" for Exception Report, "Inventory" for Inventory Report, "Recent" for Recent Location Report, "InActive" for Inactive Report, "Activations" for Activations Report, "Top10" for Top Locations Report, "Command" for Command History Report, "Loaner" for Loaner Report, "Geofence" for Geofence Report, and "Alerts" for Alerts Report.
esn (optional)
array — Array of ESNs of the vehicles for the report. Required for Recent Locations, History, Alerts, Top Location, and Loaner Report.
loaner (optional)
array — Array of loaner vehicles ESN. Required for loaner report.
dateRange (required)
string — Date range of the report. Required for History, Alerts, Geofence, and Loaner Report.
duration (optional)
integer — Number of days to run the report. Required for Exception and Inactive report.

Examples

Recent Location Report
http://guidepointsystems.com/api2/vehicle/report?reportType=Recent&esn=123456789&dateRange=20150601-20150630
Exception Report (optional)
http://guidepointsystems.com/api2/vehicle/report?reportType=Exception&dateRange=&duration=3
Inactive Report (optional)
http://guidepointsystems.com/api2/vehicle/report?reportType=InActive&dateRange=&duration=5

Sample JSON result:

{
      "address":{
         "location":{
            "Latitude":"32.634",
            "Longitude":"-97.406",
            "IntLat":"0",
            "IntLon":"0",
            "LocationValid":"1",
            "LookupVtime":"1415315884",
            "LastUseVtime":null,
            "OldLookup":"0",
            "AddressStr":null,
            "HouseNumber":"5321",
            "Street":"Meadow Valley Drive",
            "City":"Fort Worth",
            "State":"TX",
            "ZIP":"76123",
            "Country":"US"
         }
      },
      "vehicle_id":"vehc-5499b098-27f27645",
      "esn":"60A143530006",
      "reason":"Ignition On",
      "created_at":"05/21\/2015 9:51 AM",
      "vtime":"1432219875",
      "received_vtime":"1432219879",
      "sequence_number":"0",
      "latitude":"32.634400",
      "longitude":"-97.406120",
      "speed":"0",
      "direction":"N",
      "miles":"4268",
   },
   } 
get: /vehicle/vin
Vehicle
Description VIN Vehicle Information
Retrieve vehicle information from the VIN.
http://guidepointsystems.com/api2/vehicle/vin?VIN=VIN NUMBER
Limits
The vehicle has to be attached to a unit.

Parameters

VIN (required)
string — Vehicle VIN.

Sample JSON result:

{
   "make":"Toyota",
   "model":"Camry",
   "trim":"LE",
   "year":"2010",
   "engine_name":"Engine",
   "engine_availability":"STANDARD",
   "cylinder":"4",
   "total_valves":"16",
   "transmission_speeds":"6",
   "epa_class":"Midsize Cars",
   "vehicle_size":"Midsize",
   "mpg_city":"22",
}
    

Error

Error Codes

1001
LOGIN_FAILED — Could not authenticate you.
1002
UNAUTHORIZED — You do not have permission to perform this action.
1100
DATABASE_ERROR — Unable to establish connection with database.
1302
VEHICLE_NOT_FOUND — The vehicle was not found.
1500
COMMAND_ERROR — There was a problem with the command being sent.
1501
COMMAND_NOT_FOUND — Unknown command.
1502
ACTIVATE_ERROR — There was a problem with activating the vehicle.
1503
UNIT_NOT_FOUND — Unit not found.
1504
UNIT_ACTIVATE_INTERNAL_ERROR — There was an internal error while attempting to activate your unit.
1505
INVENTORY_NOT_FOUND — Inventory was not found.
1506
NO_RECENT_HISTORY_FOUND — No recent history was found for unit.
1507
NO_LOCATION_AVAILABLE — Location not available for the unit.
1600
UNKNOWN_ERROR — Internal error.
1701
USER_NOT_FOUND — The user was not found.
1703
USER_ALREADY_EXISTED — The username already exists.
1802
MISSING_PARAMETERS — Parameter missing:.
2100
TRUSTED_DEVICE_REQUIRED — A trusted device is required for this request. Please verify your device before attempting this request.

Models

Vehicle

id
String (exactly 22 alphanumeric characters) Vehicle ID.
user_id
String (exactly 22 alphanumeric characters)
operator_id
String
unit_id
String (exactly 22 alphanumeric characters)
maintenance_id
String
name
String
phone
String
miles
Integer
make
String
model
String
year
String
color
String
vin
String
expiration_date
String
term
String
license_plate
String
insurance_holder_name
String
insurance_company
String
insurance_company_phone
String
insurance_policy_number
String
insurance_type
String
insurance_expiration_date
String
features
String
notes
String
status
String
trim
String
engine
String
unit
array[Unit]

Unit

id
String Unit ID (exactly 22 alphanumeric characters).
esn
String
iccid
String
msisdn
String
imei
String
user_id
String
vehicle_id
String (exactly 22 alphanumeric characters)
soldby_id
String
desired_rate_level
Integer
rate_level
Integer
config
String
config_last
String
config_last_time
String
hardware_version
String
software_version
String
miles
Integer
last_miles
Integer
landmark_id
String
reseller_id
String
ra
String
ra_reason
String
ra_other
String
development_unit
Integer

UnitData

vehicle_id
String (exactly 22 alphanumeric characters)
esn
String
reason
String
ip
String
created_at
String
vtime
Integer
received_vtime
Integer
sequence_number
Integer
latitude
Integer
longitude
Integer
gps_age
Integer
ignition_state
Integer
minutes_at_location
Integer
speed
Integer
direction
String
hours
Integer
miles
Integer
satellite_count
Integer
ignition_minutes
Integer
state
String
airbag
String
o
String
f
String
rpm
String
tps
String
v
String
ot
String
cs
String

RecentUnitData

unit_id
String (exactly 22 alphanumeric characters)
vehicle_id
String (exactly 22 alphanumeric characters)
esn
String
reason
String
ip
String
created_at
String
vtime
Integer
received_vtime
Integer
sequence_number
Integer
latitude
Integer
longitude
Integer
address
String
gps_age
Integer
ignition_state
Integer
minutes_at_location
Integer
speed
Integer
direction
String
hours
Integer
miles
Integer
satellite_count
Integer
ignition_minutes
Integer
config
String

SurePayAccount

UserID
String (exactly 22 alphanumeric characters)
UnitID
String (exactly 22 alphanumeric characters)
DealerID
String
TransactionID
String
AccountNum
String
FirstName
String
LastName
String
Address
String
City
String
State
String
ZIP
String
Email
String
LocateCode
String
StarterEnable
Boolean
WarningEnable
Boolean
StarterDate
String
WarningDate
String
DateAdded
String
WaitingForTest
Boolean

User

id
String User's ID (exactly 22 alphanumeric characters).
membership_id
String-
customer_type
String FLEET OR GPS.
contact_id
String Example FLEET, Mopar, Nissan, or Surepay.
creator_id
String Operator's ID.
username
String
user_locale
String Example USA, MEXICO, or VENEZUELA.
sub_locale
String Example MOPAR, NISSAN, or CHERY.
created_at
String
title
String
name
String
first_name
String
last_name
String
company_name
String
address
String
city
String
state
String
zip
String
country
String
override_address
Boolean
phone_home
String
phone_work
String
phone_cell
String
email
String
no_email
Boolean
dealership_name
String
timezone
Boolean
user_status
Boolean Example ACTIVE, INACTIVE, or DELETED.