Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables



GpsInsight Adapter








Access GpsInsight using SQL and REST commands


This adapter requires an account with GpsInsight Services.



Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String Url Web service URL
String UserName Login used for authentication
String Authtoken Token used for authentication

Handlers



CreateDriver
Driver
Create a new driver details 

Arguments

Name Description Default
lastname R
firstname
ref_id
email
phone
alert_pref
timezone R

SQL Call

exec BSC.Pressero.CreateDriver 'test', ...
INSERT BSC.Pressero.Driver (Email, ...) values (...)


Http Call

/bsc/gpsinsight/createdriver

Output Columns

This call does not return data.

DeleteDriver
Driver
Delete a driver details 

Arguments

Name Description Default
driver R

SQL Call

exec BSC.Pressero.DeleteDriver '123-3ab57be3-...'
delete from BSC.Pressero.Driver where driver = 'john smith'


Http Call

/bsc/gpsinsight/deletedriver

Output Columns

This call does not return data.

GetGeoCode
GeoCode
Get the GeoCode of an address details 

Arguments

Name Description Default
address R

SQL Call

exec bsc.GpsInsight.GetGeoCode '7201 E. Henkel Way, Scottsdale, AZ 85255'
select * from GpsInsight.GeoCode where address = '7201 E. Henkel Way, Scottsdale, AZ 85255'


Http Call

/bsc/gpsinsight/getgeocode

Output Columns

Decimal latitude
Decimal longitude
String houseNumber
String street
String city
String stateProvince
String postalCode
String country
String raw
String address
GetVehicleDriver
VehicleDriver
Gets information about the currently-assigned driver, if any details 

Arguments

Name Description Default
vehicle R

SQL Call

exec bsc.GpsInsight.GetVehicleDriver 'test'
select * from GpsInsight.VehicleDriver where arg1 = 'test'


Http Call

/bsc/gpsinsight/getvehicledriver

Output Columns

Int32 id
Int32 alert_pref
String email
String firstname
String lastname
String phone
String raw
String vehicle
ListDiagnosticsHistory
DiagnosticsHistory
Description of your handler details 

Arguments

Name Description Default
vehicle R
code
date
start
end

SQL Call

exec bsc.GpsInsight.ListDiagnosticsHistory 'test'
select * from GpsInsight.DiagnosticsHistory where arg1 = 'test'


Http Call

/bsc/gpsinsight/listdiagnosticshistory

Output Columns

String code
String value
DateTime received_date
String raw
String vehiclevehicle vin, serial_number, name or partial name (first to match)
DateTime datereturn diagnostics data for this date
DateTime startstart time of diagnostics
DateTime endend time of diagnostics
ListDiagnosticTypes
DiagnosticTypes
Description of your handler details 

Arguments


SQL Call

exec bsc.GpsInsight.ListDiagnosticTypes 'test'
select * from GpsInsight.DiagnosticTypes where arg1 = 'test'


Http Call

/bsc/gpsinsight/listdiagnostictypes

Output Columns

String id
String name
String raw
ListDrivers
Drivers
Description of your handler details 

Arguments

Name Description Default
driver

SQL Call

exec bsc.GpsInsight.ListDrivers
select * from GpsInsight.Drivers


Http Call

/bsc/gpsinsight/listdrivers

Output Columns

String id
String lastname
String firstname
String ref_id
String emailExternal reference ID for the driver
String phone
Int32 alert_pref
String timezone
String raw
String driver
ListLandmarks
Landmarks
Get a list of landmarks details 

Arguments

Name Description Default
landmark

SQL Call

exec bsc.GpsInsight.ListLandmarks
select * from GpsInsight.Landmarks


Http Call

/bsc/gpsinsight/listlandmarks

Output Columns

String id
String label
Decimal latitudeHorizontal center of landmark
Decimal longitudeVertical center of landmark
Int32 radius
Int32 polygon
Int32 colorColor code (optional, defaults to 255/0000ff). NOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String owner
String coordinates
String radiusUnits'F' = feet, 'M' = miles, 'T' = meters (optional, defaults to F). NOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String addressNOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String address_2NOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String cityNOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String stateNOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String zipNOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String countryNOTE: This is not provided by the API Create but is supplied for INSERT/UPDATE continuity.
String raw
String landmark
ListVehicles
Vehicles
Return a list of vehicles details 

Arguments

Name Description Default
vehicle

SQL Call

exec bsc.GpsInsight.ListVehicles 'test'
select * from GpsInsight.Vehicles where arg1 = 'test'


Http Call

/bsc/gpsinsight/listvehicles

Output Columns

String id
String label
String source
String report_interval
String idle_gph
String fuel_type
String fuel_capacity
String country
String license_state
String license_number
String color
String make
String model
String model_year
String odometer
String phone_number
String ref_id
String email_address
String alert_email
String alert_sms
String alert_garmin
String alert_pref
String first_dt
String serial_number
String vin
String run_time
String engine_size
String icon
String raw
String vehiclevehicle vin, serial_number, name or partial name (optional, first to match)
UpdateDriver
Driver
Update certain driver information. Specify "driver" to identify the record to update, the other fields (firstname, lastname, etc.) will be updated. partial first names) 7=email+sms+garmin) (optional) (optional). Set columns to an empty string to NULL them out. NULL valued columns will be ignored. details 

Arguments

Name Description Default
driver
lastname
firstname
ref_id
email
phone
alert_pref
timezone

SQL Call

exec BSC.Pressero.UpdateDriver 'sm'
update BSC.Pressero.User set Email = 'test@abc.com', ... where driver = 'john smith'


Http Call

/bsc/gpsinsight/updatedriver

Output Columns

This call does not return data.

CreateLandmark
Landmarks
Create a landmark details 

Arguments

Name Description Default
label
latitude
longitude
radius 750
radiusUnits F
color 255

SQL Call

exec bsc.GpsInsight.CreateLandmark '12345678', ...
insert GpsInsight.Landmarks ( serial_number, ... ) values ('My landmark name', ...)


Http Call

/bsc/gpsinsight/createlandmark

Output Columns

This call does not return data.

DeleteLandmark
Landmarks
Delete a landmark details 

Arguments

Name Description Default
landmark R

SQL Call

exec bsc.GpsInsight.DeleteLandmark 12345
select * from GpsInsight.Landmarks where id = 12345


Http Call

/bsc/gpsinsight/deletelandmark

Output Columns

This call does not return data.

UpdateLandmark
Landmarks
Update a landmark details 

Arguments

Name Description Default
landmark
label
latitude
longitude
radius 750
radiusUnits F
color 255
address
address_2
city
state
zip
country

SQL Call

exec bsc.GpsInsight.UpdateLandmark 'abc123', ...
update GpsInsight.Landmarks set color = 'white' where id = 12345


Http Call

/bsc/gpsinsight/updatelandmark

Output Columns

This call does not return data.

CreateVehicle
Vehicles
Create a vehicle details 

Arguments

Name Description Default
serial_number R
label R
vin R
odometer R
color
country
fuel_capacity
fuel_type
license_number
license_state
make
model
model_year
run_time
engine_size
idle_gph
icon

SQL Call

exec bsc.GpsInsight.CreateVehicle '12345678', ...
insert GpsInsight.Vehicles ( serial_number, ... ) values ('12345678', ...)


Http Call

/bsc/gpsinsight/createvehicle

Output Columns

This call does not return data.

DeleteVehicle
Vehicles
Disassociate a vehicle from a device details 

Arguments

Name Description Default
vehicle R
reason
is_rental

SQL Call

exec bsc.GpsInsight.DeleteVehicle 'test'
select * from GpsInsight.Vehicles where arg1 = 'test'


Http Call

/bsc/gpsinsight/deletevehicle

Output Columns

This call does not return data.

ListVehicleHistory
VehicleHistory
Description of your handler details 

Arguments

Name Description Default
vehicle r
date
start
end
location_detail False
inputs False

SQL Call

exec bsc.GpsInsight.ListVehicleHistory
select * from bsc.GpsInsight.VehicleHistory


Http Call

/bsc/gpsinsight/listvehiclehistory

Output Columns

String id
String vin
String label
String serial_number
Int32 age_minutes
String timezone
DateTime fix_time
DateTime fix_time_mst
DateTime fix_time_gmt
Decimal latitude
Decimal longitude
Int32 landmark_id
String landmark
String address
Int32 heading
String ignition
Int32 max_speed
Int32 avg_speed
Int32 inst_speed
Int32 speed_limit
String speed_label
String speed_icon
Decimal odometer
String driver_id
String first_name
String last_name
String raw
String vehiclevehicle vin, serial_number, name or partial name (first to match)
DateTime datea single day at a time (optional)
DateTime startstart date/time (optional)
DateTime endend date/time (optional)
Boolean location_detailshow geocoded street address and landmark, if found(optional, default off)
Boolean inputsshow input state and definition(optional, default off)
ListVehicleTripDetail
VehicleTripDetail
Return details about trips and stops for a vehicle details 

Arguments

Name Description Default
vehicle R
date
start
end

SQL Call

exec bsc.GpsInsight.ListVehicleTripDetail '12ar5j90'
select * from GpsInsight.VehicleTripDetail where vehicle = '12ar5j90'


Http Call

/bsc/gpsinsight/listvehicletripdetail

Output Columns

String driver_last_name
String trip_type
DateTime trip_start
DateTime trip_end
Decimal duration
Decimal distance
Decimal latitude_start
Decimal longitude_start
Decimal latitude_end
Decimal longitude_end
Int32 points
Int32 in_progress
Decimal min_latitude
Decimal min_longitude
Decimal max_latitude
Decimal max_longitude
Decimal fastest_distance
Decimal fastest_hours
Decimal shortest_distance
Decimal shortest_hours
String raw
String vehiclevehicle vin, serial_number, name or partial name (first to match)
DateTime datea single day at a time (optional)
DateTime startstart date/time (optional)
DateTime endend date/time (optional)
UpdateVehicle
Vehicles
Update a vehicle details 

Arguments

Name Description Default
vehicle R
label
vin
odometer
color
country
fuel_capacity
fuel_type
license_number
license_state
make
model
model_year
run_time
engine_size
idle_gph
icon

SQL Call

exec bsc.GpsInsight.UpdateVehicle 'abc123', ...
update GpsInsight.Vehicles set color = 'white' where vehicle = 'abc123'


Http Call

/bsc/gpsinsight/updatevehicle

Output Columns

This call does not return data.