docs.driverstyle.fleet.scorpiontrack.com Open in urlscan Pro
35.197.220.192  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Authentication
 * Journeys
   * getHandler returning aggregated list of vehicle driver style scores
 * Vehicles
   * getHandler returning list of vehicle style scores
 * Drivers
   * getHandler returning a single driver
 * Units
   * putUpdates the unit vehicle to assign a driver id

Documentation Powered by ReDoc





DRIVER STYLE API (4.1.0)

Download OpenAPI specification:Download



The purpose of this application is to provide vehicles with a score based on
their driving, values based upon quartix data.


AUTHENTICATION


JWT

For accessing the API a valid JWT token must be passed in all the queries in the
'Authorization Basic' header.

To generate a JWT, pass in the user_id: user_id, and the api_key: public key in
the JWT payload, using the private key to sign the token, using the HS256
algorithm. If doing manually add a : to the JWT string before base64 encoding
the token. Most HTTP client libraries (guzzle, unirest etc) handle this
automatically.

The following syntax must be used in the 'Authorization' header :

Basic: xxxxxx.yyyyyyy.zzzzzz

Security scheme type: API Key header parameter name: Authorization


JOURNEYS


HANDLER RETURNING AGGREGATED LIST OF VEHICLE DRIVER STYLE SCORES

List of vehicle driver style scores using vehicles in the same customer as the
user id who made the request

AUTHORIZATIONS:

JWT

QUERY PARAMETERS

from
string
Example: 1514764800

The from journey date

to
string
Example: 1514764900

The to journey date


RESPONSES

200

List of journeyBehaviour scores

400

Generic Error

get /journeys
https://unknown/api/v1/journeys


RESPONSE SAMPLES

 * 200
 * 400

application/json
Copy
Expand all Collapse all

{
 * "status": 200,
 * "status_desc": "OK",
 * "request_id": "bapr-jqs0-3ao3-2e96-1vqg",
 * "latency": "10.21412ms",
 * "aggregated_scores":
   
   {
    * "meta":
      
      {
       * "page": 2,
       * "limit": 25,
       * "total": 144
      
      },
    * "data":
      
      [
       * 
         {
          * "driver_id": 1002,
          * "driver_name": "Jon Smith",
          * "score": 74,
          * "vehicle_id": 1001,
          * "vehicle_registration": "MD17457",
          * "vehicle_alias": "White van"
         
         }
      
      ]
   
   }

}



VEHICLES


HANDLER RETURNING LIST OF VEHICLE STYLE SCORES

List of vehicle driver style scores using the supplied vehicle id and the time
span

AUTHORIZATIONS:

JWT

PATH PARAMETERS

id
required
integer
Example: 1000


QUERY PARAMETERS

from
string
Example: 1514764800

The from journey date

to
string
Example: 1514764900

The to journey date


RESPONSES

200

List of vehicleJourneyBehaviour scores

400

Generic Error

get /vehicles/{id}
https://unknown/api/v1/vehicles/{id}


RESPONSE SAMPLES

 * 200
 * 400

application/json
Copy
Expand all Collapse all

{
 * "status": 200,
 * "status_desc": "OK",
 * "request_id": "bapr-jqs0-3ao3-2e96-1vqg",
 * "latency": "10.21412ms",
 * "journeys":
   
   {
    * "meta":
      
      {
       * "page": 2,
       * "limit": 25,
       * "total": 144
      
      },
    * "data":
      
      [
       * 
         {
          * "driver_id": 1002,
          * "driver_name": "Jon Smith",
          * "score": 74,
          * "journey_date": 1524314500,
          * "duration": 161,
          * "acc_band_1_count": 1,
          * "acc_band_2_count": 4,
          * "acc_band_3_count": 0,
          * "acc_band_4_count": 2,
          * "acc_band_5_count": 0,
          * "dec_band_1_count": 0,
          * "dec_band_2_count": 4,
          * "dec_band_3_count": 3,
          * "dec_band_4_count": 7,
          * "dec_band_5_count": 3,
          * "cornering_band_1_count": 1,
          * "cornering_band_2_count": 4,
          * "cornering_band_3_count": 0,
          * "cornering_band_4_count": 1,
          * "cornering_band_5_count": 3
         
         }
      
      ]
   
   },
 * "vehicle":
   
   {
    * "data":
      
      {
       * "vehicle_id": 1,
       * "driver_id": 2,
       * "driver_name": "Mike Smith",
       * "alias": "Mikes car",
       * "unit_id": 1,
       * "reg": "BN21 1EG"
      
      }
   
   }

}



DRIVERS


HANDLER RETURNING A SINGLE DRIVER

Get a driver and their driver score

AUTHORIZATIONS:

JWT

PATH PARAMETERS

id
required
integer
Example: 1000



RESPONSES

200

Get a single driver

400

Generic Error

get /drivers/{id}
https://unknown/api/v1/drivers/{id}


RESPONSE SAMPLES

 * 200
 * 400

application/json
Copy
Expand all Collapse all

{
 * "status": 200,
 * "status_desc": "OK",
 * "request_id": "bapr-jqs0-3ao3-2e96-1vqg",
 * "latency": "10.21412ms",
 * "driver":
   
   {
    * "data":
      
      {
       * "driver_id": 1,
       * "first_name": "Peter",
       * "last_name": "Smith",
       * "email": "test@example.com",
       * "mobile_phone": 447874218888,
       * "score": 87.27506265
      
      }
   
   }

}



UNITS


UPDATES THE UNIT VEHICLE TO ASSIGN A DRIVER ID

Assign driver id to journey

AUTHORIZATIONS:

JWT

PATH PARAMETERS

id
required
integer
Example: 1000

The unit id

journey
required
string
Example: 1514764800

The journey date

REQUEST BODY SCHEMA: APPLICATION/JSON

driver_id
integer

The ID of the driver to assign


RESPONSES

200

Success response

400

Generic Error

put /units/{id}/journeys/{journey}
https://unknown/api/v1/units/{id}/journeys/{journey}


REQUEST SAMPLES

 * Payload

application/json
Copy
Expand all Collapse all

{
 * "driver_id": 8

}


RESPONSE SAMPLES

 * 200
 * 400

application/json
Copy
Expand all Collapse all

{
 * "latency": "10.2121ms",
 * "request_id": "bapr-jqs0-3ao3-2e96-1vqg",
 * "status": 200,
 * "status_desc": "OK"

}