The
Customer Meta Data (CMD) API is a RESTful web service that enables Fleetmatics
customers to integrate 3rd party back-office systems with REVEAL to
keep driver, user, vehicle, and group information up to date.
The
Customer Meta Data API is separated out into different services that have a
variety of methods that can be accessed to create, update, and delete key
objects within a REVEAL account.
This
documentation will breakdown each of the services and the methods that are
available: Drivers, Users, Vehicles, and Groups.
Key
concepts for using the Customer Meta Data API methods:
·
Customer
Meta Data API is offered as a RESTful web service
·
Standard
REST verbs are applied: GET, POST, PUT, DELETE
·
Customer
Meta Data API services: Drivers, Users, Vehicles, and Groups
·
Throughout
this document, we will reference the unique identifier to be invoked for each
of the main objects available to be created, updated, or deleted. The unique identifiers are as follows and can
be managed within the Fleetmatics REVEAL account by the same field name.
o
Drivers
= Driver Number
o
Users
= Employee ID
o
Vehicles
= Vehicle Number
o
Groups
= Group ID
o
Geofences
= Place ID
The
Customer Meta Data API allows for driver records to be created, updated, and
deleted using the Driver Service methods.
Driver
information will be invoked using the Driver Number as the unique identifier.
The
following GET methods will be used in order to return driver(s) information
that already exist within the Fleetmatics REVEAL account.
·
GET Drivers
·
GET Drivers by Driver Number
·
GET Key Fob by Driver Number
·
GET Driver by Key Fob
The
integrated user will be able to return a list of active drivers within the
Fleetmatics REVEAL account by using this GET method. All drivers that are currently active within
the account will be returned. Any
drivers that have previously been deleted within the Fleetmatics REVEAL account
will NOT be returned within the list.
The
following information will be returned with the Get Driver method:
·
Driver
First Name
·
Driver
Last Name
·
Driver
Number
·
Link
to review the groups the drivers are assigned to
The
integrated user will be able to return driver(s) information by Driver
Number. This GET method will only return
active drivers that are associated with the provided Driver Numbers.
The
following information will be returned:
·
Driver
First Name
·
Driver
Last Name
·
Driver
Number
·
Link
to review the groups the drivers are assigned to
The
integrated user will be able to return Key Fob information by Driver
Number. This GET method will only return
active drivers that are associated with the provided Driver Numbers, but will
highlight the assigned Key Fob Identification details. This method will mostly be used for ensuring
Key Fobs are properly assigned or unassigned.
The
following information will be returned:
·
Driver
First Name
·
Driver
Last Name
·
Driver
Number
·
Key
Fob Identification
The
integration user will be able to return the driver associated with a provided
Key Fob Id. This GET method will only
return active drivers that are associated with the provided Key Fob Id. This method will mostly be used for ensuring
Key Fobs are properly assigned or unassigned, or to locate the owner of a
particular Key Fob to ensure that it isn’t improperly reassigned to a different
driver.
The request method will expect that the
Key Fob ID value be presented exactly as the value reads on the key fob, which
corresponds with the value that should be entered into REVEAL to be associated
with a driver.
The
following information will be returned:
·
Driver
First Name
·
Driver
Last Name
·
Driver
Number
·
Link
with the additional Driver details to be viewed
The
following POST method will be used in order to create drivers within the
Fleetmatics REVEAL account.
·
POST
Drivers
The
integrated user will be able to create drivers by calling this POST method.
The
following information will be available to be provided for the driver record
being created:
·
First
Name
·
Last
Name
·
Driver
Number – will be mandatory in order to reference the driver using web services
·
Email
– must be unique across REVEAL records
·
Mobile
Access – will allow the driver to have access to the Fleetmatics Field App and
Fleetmatics LogBook App
·
Phone
Number
The
integrated user will be able to update a driver’s Key Fob Identification
information by calling this POST method.
The driver record will be referenced based on the user providing a valid
Driver Number to access the driver record details.
Please
note: assigning a key fob to a driver through this method will not remove any
current key fob identification assignments.
Additionally,
multiple key fob identifications can be assigned to one driver record. However, the same key fob identification
cannot be assigned to multiple drivers within Fleetmatics REVEAL.
The Key
Fob Identification is found on the key fob.
The
following PUT methods will be used in order to update existing driver records
that have already been created within the Fleetmatics REVEAL account.
·
PUT
Driver by Driver Number
The
integrated user will be able to update a driver’s record by calling this PUT
method. The driver record will be
referenced based on the user providing a valid Driver Number to access the
driver record details.
The
following information will be available to be updated for the driver record:
·
First
Name
·
Last
Name
·
Driver
Number – will be mandatory in order to reference the driver using web services
·
Email
– must be unique across REVEAL records
·
Mobile
Access – will allow the driver to have access to the Fleetmatics Field App and
Fleetmatics LogBook App
·
Phone
Number
The
following DELETE methods will be used in order to delete existing driver
records and details already created within Fleetmatics REVEAL.
·
DELETE
Driver by Driver Number
·
DELETE
Key Fob by Driver Number
The
integrated user will be able to delete a driver’s record by calling this DELETE
method. The driver record to be deleted
will be referenced based on the integration user providing a valid Driver
Number. Please note: drivers cannot be
mass deleted using this method to mitigate risk of deleting too many drivers
from a Fleetmatics REVEAL account.
The
integrated user will be able to delete a key fob identification from a driver
record.