Driver Activity Ė Assignments

The Driver Activity - Assignments API is a RESTful web service that enables Verizon Connect customers to integrate 3rd party back-office systems with REVEAL to manage driver/vehicle assignments.For API users leveraging work orders, the driver assignment is a critical component for REVEAL functionality.

Important concepts to understand prior to utilizing any of the available integration methods:

      Driver Activity API is offered as a RESTful web service

      Standard REST verbs are applied: GET and POST

      Throughout this document, we will reference the unique identifier to be invoked for each of the main objects available to be created or deleted.The unique identifiers used within this API method set include:

o   Driver Number

o   Vehicle Number

Note: The current version of the Driver Assignments  API does not support devices tracking Non-Powered Assets.  No information will return regarding Non-Powered Assets within any of the following API methods.

The returned response will be restricted to the Reveal account's data plan. If the information being queried is outside of the data plan, a "400 Bad Request error "response will be returned.

For more details on your account's data plan please reach out to Verizon Connect Customer Support

 

API Summary Details

API Name

Driver Activity API

Endpoint

https://fim.api.eu.fleetmatics.com/rad

Operation

GET, POST

 

GET Assignment by Driver Number

The integrated user will be able to return the Driver Numberís current vehicle assignment.The method will only return the current vehicle assignment for the Driver Number specified.The current vehicle assignment and the start date and time of the assignment will be included.

 

GET Assignment by Driver Number API Request Header

Operation and Path

GET https://fim.api.eu.fleetmatics.com/da/v1/driverassignments/drivers/<DriverNumber>/currentassignment HTTP/1.1

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere atmosphere_app_id=fleetmatics-p-eu-[ Verizon Connect App ID], Bearer [Authorization Token]

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET Assignment by Driver Number Sample Response

{

††† "DriverNumber": "100096",

††† "VehicleNumber": "100096",

††† "StartDateUTC": "2016-08-08T17:51:04.05"

}

 

GET Assignment Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Driver Number

{

††† "DriverNumber": "100096",

Driver Number is the unique identifier for Drivers created within REVEAL.

 

NULL will also be returned if the Driver record assigned at the time of the plot does not have a Driver Number associated with the record in REVEAL.

Vehicle Number

†††††††† "VehicleNumber": "100096",

 

Vehicle Number is the unique identifier for Vehicles created within REVEAL.

The value will default to NULL if no Vehicle is assigned to the driver at the time of the request.Additionally, NULL will be returned if the assigned vehicle does not have a Vehicle Number.

Start Date UTC

††††† "StartDateUTC": "2016-08-08T17:51:04.05"

}

 

Start Date UTC will reflect the time of the driver to vehicle assignment that is returned.

 

GET Assignment by Vehicle Number

The integrated user will be able to return the Vehicle Numberís current driver assignment.The method will only return the current driver assignment for the Vehicle Number specified.The current driver assignment and the start date and time of the assignment will be included.

 

GET Assignment by Driver Number API Request Header

Operation and Path

GET https://fim.api.eu.fleetmatics.com/da/v1/driverassignments/drivers/<VehicleNumber>/currentassignment HTTP/1.1

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere atmosphere_app_id=fleetmatics-p-eu-[ Verizon Connect App ID], Bearer [Authorization Token]

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.

 

GET Assignment by Vehicle Number Sample Response

{

††† "DriverNumber": "100096",

††† "VehicleNumber": "100096",

††† "StartDateUTC": "2016-08-08T17:51:04.05"

}

 

GET Assignment Response Field Breakdown

Field

JSON Formatted Sample

Field Notes and Default Values

Driver Number

{

††† "DriverNumber": "100096",

Driver Number is the unique identifier for Drivers created within REVEAL.

NULL will also be returned if the Driver record assigned at the time of the plot does not have a Driver Number associated with the record in REVEAL.

Vehicle Number

†††††††† "VehicleNumber": "100096",

 

Vehicle Number is the unique identifier for Vehicles created within REVEAL.

The value will default to NULL if no Vehicle is assigned to the driver at the time of the request.Additionally, NULL will be returned if the assigned vehicle does not have a Vehicle Number.

Start Date UTC

††††† "StartDateUTC": "2016-08-08T17:51:04.05"

}

 

Start Date UTC will reflect the time of the driver to vehicle assignment that is returned.

 

POST Driver Assignment

The POST Driver Assignment method enables integration users to link drivers to vehicles within a REVEAL account.

 

POST Assignment API Request

The body of the request should contain the relevant details regarding the assignment you wish to make.The format for the body should be as follows:

[{††

††† "DriverNumber": null,

††† "VehicleNumber": null,

††† "StartDateUTC": "0001-01-01T00:00:00",

††† "EndDateUTC": null

}]

POST Assignment API Request Header

Operation and Path

POST https://fim.api.eu.fleetmatics.com:443/da/v1/driverassignments

HOST

fim.api.eu.fleetmatics.com

Accept

application/json

Authorization

Atmosphere atmosphere_app_id=fleetmatics-p-eu-[ Verizon Connect App ID], Bearer [Authorization Token]

Note: The Token API must be called in order to retrieve a valid token to provide to all subsequent calls.