US & Canada Specifications v.2.6
Table
of Contents
Fleetmatics REVEAL+ RESTful Web Services
DELETE Driver by Driver Number
DELETE Key Fob by Driver Number
Deactivate Users by Employee ID
PUT Hours of Use by Vehicle Number
PUT Odometer by Vehicle Number
GET Location by Vehicle Number
GET Assignment by Driver Number
GET Assignment by Vehicle Number
GET Work Order by Work Order Number
GET Current Status by Work Order Number
POST Work Order Status by Work Order Number
PUT Work Order by Work Order Number
The
Token API is a RESTful web service that enables integrated users to retrieve a
token which will be submitted as part of a request header to authenticate
access to various APIs available by Fleetmatics. The integration user will need to pass in
his/her username and password in the request header with basic authentication
scheme and a token text will be returned in HTTP response.
Fleetmatics
must provide the integration user with credentials to access any of our
proprietary APIs. The username and
password provided to the integration user will enable access to the Token API
which is an initial mandatory process for using any of the other available web
services.
When the
token is provided to the integration user it will be required to be added to
the request header for each web services call made. It is important to note that tokens generated
expire after 20 minutes and then the integration user would be expected to call
the service again to receive a new token.
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.
The
Customer Meta Data API allows for user records to be created, updated, and
deleted using the User Service methods.
User
information will be invoked using the Employee ID as the unique identifier.
The
following GET methods will be used in order to return user(s) information that
already exist within the Fleetmatics REVEAL account.
·
GET
Users
·
GET
Users by Employee ID
The
integrated user will be able to return a list of active users within the
Fleetmatics REVEAL account by using this GET method. All users that are currently active within
the account will be returned.
Deactivated and deleted users will not be returned within the user
results.
The
following user information will be returned when this GET method is called:
·
User
First Name
·
User
Last Name
·
Username
– this will be a mandatory field for an email address that the user will need
to log into REVEAL
·
Employee
ID
·
Role
·
Primary
Group
·
Status
·
Link
provided to review what groups the User has access to. If a group update needs to be made, please
review the documentation on the Group methods available.
The
integrated user will be able to return a list of active users within the
Fleetmatics REVEAL account by using this GET method and providing valid
Employee IDs to be referenced.
Deactivated and deleted users will not be returned within the user
results.
The
following information will be returned when this GET method is called:
·
User
First Name
·
User
Last Name
·
Email
– the user’s email address will be used as his/her username to login to REVEAL
·
Employee
ID – must be unique within the account and is mandatory in order to update the
user record via the integration
·
Phone
Number
·
Role
·
Is
Admin – response will be True/False
·
Is
Regional Admin – response will be True/False
·
Is
Driver – response will be True/False
·
Is
Driver Number – must be unique within the account and is mandatory in order to
update the associated driver record via the integration
·
Status
– will show the user’s REVEAL account status: Active or Deactivated
·
Region
– request should be made using ISO alpha 3 country codes for countries
currently supported by REVEAL
·
Language
– request should be made using IETF language tags for languages currently
supported by REVEAL
·
Time
Zone – request should be made using standard ISO time zone abbreviations
·
Link
provided to review what groups the User has access to. If a group update needs to be made, please
review the documentation on the Group methods available.
The
following POST methods will be used in order to create users within the
Fleetmatics REVEAL account.
·
POST
Users
The
integrated user will be able to create new user records within the Fleetmatics
REVEAL account by using this POST method.
The
following information will be available to update the user record:
·
First
Name
·
Last
Name
·
Email
– must be an email address and unique within REVEAL
·
Employee
ID – will be mandatory in order to reference the user through the integration services
·
Phone
Number
·
Is
Administrator – specify if the created user should be given REVEAL Administrator
rights by providing TRUE or FALSE values
o
TRUE
to set the user as an Administrator
o
FALSE
to set the user as a non-admin which will mean the user must be either given
Regional Administrator or Role level access
·
Is
Regional Administrator – specify if the created user should be given REVEAL
Regional Administrator rights by providing TRUE or FALSE values
o
TRUE
to set the user as an Regional Administrator
o
FALSE
to set the user as a non-regional admin which will mean the user must be given
Role level access
§
Please
note: not all REVEAL accounts are automatically enabled with Regional Admin, if
this is not enabled for your account please have your system Administrator
contact customer support to learn if this feature would be beneficial for your
account’s organizational structure.
·
Role
– if the created user is not an Administrator or Regional Administrator, a role
must be specified in order to limit the access the user has within the REVEAL
account. If the Role provided does not
exist in the REVEAL account using an exact text match, then an ERROR for
“invalid role” will be returned.
o
Roles
must be created within Fleetmatics REVEAL prior to attempting to assign the
role to the user using the Customer Meta Data API.
·
Time
Zone – request should be made using standard ISO time zone abbreviations
o
If
NULL the user’s time zone will be set to the Account Preference’s Time Zone
selection
·
Region
– request should be made using ISO alpha 3 country codes for countries
currently supported by REVEAL
o
If
NULL the user’s region will be set to the Account Preference’s Region selection
·
Language
- request should be made using IETF language tags for languages currently
supported by REVEAL
·
Is
Driver – if the created user is also a driver provide TRUE
o
If
TRUE a Driver Number will be required for the created driver record
o
If
the created user is NOT also a driver for your company then provide FALSE
·
Driver
Number – if the “Is Driver” is set to TRUE a Driver Number will be required to
be the unique identifier used for the driver record linked to this user
o
The
corresponding driver record will be automatically created including the
following:
§
First
Name
§
Last
Name
§
Email
§
Assigned
to the “Ungrouped Group”
§
Additional
updates can be made to the driver record using the PUT Driver by Driver Number
When
the user is created, the following access will be provided:
·
Administrators
will receive Entire Fleet access
·
Non-Administrators,
including Regional Administrators, will receive access to the Ungrouped group
To
change the created user’s access please see the Groups section
The
following PUT methods will be used in order to update existing user records
that have already been created within the Fleetmatics REVEAL account.
·
PUT
Users by Employee ID
The
integrated user will be able to update a user’s record by calling this PUT
method. The user record will be
referenced based on the user providing a valid Employee ID to access the driver
record details.
The
following information will be available to be updated for the user record:
·
First
Name
·
Last
Name
·
Email
– must be an email address and unique within REVEAL
·
Employee
ID – will be mandatory in order to reference the user through the integration
services
·
Phone
Number
·
Is
Administrator – specify if the created user should be given REVEAL
Administrator rights by providing TRUE or FALSE values
o
TRUE
to set the user as an Administrator
o
FALSE
to set the user as a non-admin which will mean the user must be either given
Regional Administrator or Role level access
·
Is
Regional Administrator – specify if the created user should be given REVEAL
Regional Administrator rights by providing TRUE or FALSE values
o
TRUE
to set the user as an Regional Administrator
o
FALSE
to set the user as a non-regional admin which will mean the user must be given
Role level access
§
Please
note: not all REVEAL accounts are automatically enabled with Regional Admin, if
this is not enabled for your account please have your system Administrator
contact Customer Support to learn if this feature would be beneficial for your
account’s organizational structure.
·
Role
– if the created user is not an Administrator or Regional Administrator, a role
must be specified in order to limit the access the user has within the REVEAL
account. If the Role provided does not
exist in the REVEAL account using an exact text match, then an ERROR for
“invalid role” will be returned.
o
Roles
must be created within Fleetmatics REVEAL prior to attempting to assign the
role to the user using the Customer Meta Data API.
·
Access
to – the user will be able to provide a Group ID for this user to access when
logging into REVEAL. If the Group ID
provided does not match any of the Group IDs within the REVEAL account, the
integration user will receive an ERROR.
If the user record is being updated with a new Group ID, any previously
associated Group IDs will not be removed.
o
If
the integration user does not specify a Group ID for the user being created to
access the following rules will apply:
§
Admins
will receive access to the Entire Fleet
§
Non-Admins
will receive access to the Ungrouped group
o
Please
note: the user can be assign to more Group IDs using the Group Service methods
after the user has been created.
·
Is
the User a Driver – if the user is also selected to be a driver a separate
driver record will be created within the REVEAL account.
o
The
option to enter a Driver Number will also be available when calling this
method. A Driver Number should only be
supplied when the user is selected to also be a driver. If the user is selected to be a driver, but
no driver number is provided an ERROR will be returned. If the user is not selected to be a driver
but a Driver Number is provided, no driver record will be created.
o
Driver
records automatically created will include the following:
§
First
Name
§
Last
Name
§
Email
§
Assigned
to the Ungrouped Group
·
Time
Zone – request should be made using
standard ISO time zone abbreviations
o
If
NULL the user’s time zone will be set to the Account Preference’s Time Zone
selection
·
Region
– request should be made using ISO alpha 3 country codes for countries
currently supported by REVEAL
o
If
NULL the user’s region will be set to the Account Preference’s Region selection
·
Language
– request should be made using IETF language tags for languages currently
supported by REVEAL
o
If
NULL the user’s language will be set to the Account Preference’s Language
selection
The
following DELETE methods will be used in order to deactivate existing user
records within Fleetmatics REVEAL.
·
Deactivate
Users by Employee ID
The
integrated user will be able to deactivate a user record by providing a valid
Employee ID. Please note: a deactivated
user record will still show within the REVEAL account but will be marked as
deactivated and will only show within the Admin section. A user can only be completely deleted from an
account through the REVEAL site.
The
Customer Meta Data API allows for vehicle records to be updated using the
Vehicle Service methods. The Vehicle Service
does not have methods for creating or deleting vehicles are REVEAL does not
support that functionality. Vehicle records
are tied to a tracking unit installed within the vehicle.
Vehicle
information will be invoked using the Vehicle Number as the unique identifier.
The
following GET methods will be used in order to return vehicle(s) information
that already exist within the Fleetmatics REVEAL account.
·
GET Vehicles
·
GET Vehicle by Vehicle Number
The
integrated user will be able to return a list of vehicles within the
Fleetmatics REVEAL account by using this GET method.
The
following information will be returned with the Get Vehicle method:
·
Vehicle
Name
·
Vehicle
Number
·
Registration
Number
·
VIN
·
Year
·
Make
·
Model
·
Tank
Capacity – value saved to Fleetmatics will be referenced as liters
·
Highway–
value saved to Fleetmatics will be referenced as liters
·
City–
value saved to Fleetmatics will be referenced as liters
·
Vehicle
Size
The
integrated user will be able to return a list of vehicles within the
Fleetmatics REVEAL account by using this GET method when a valid Vehicle Number
is provided.
The
following information will be returned with the GET method:
·
Vehicle
Name
·
Vehicle
Number
·
Registration
Number
·
VIN
·
Year
·
Make
·
Model
·
Tank
Capacity – value saved to Fleetmatics will be referenced as liters
·
Highway
– value saved to Fleetmatics will be referenced as liters
·
City
– value saved to Fleetmatics will be referenced as liters
·
Vehicle
Size
The
following PUT methods will be used in order to update a vehicle record.
·
PUT Vehicle by Vehicle Number
·
PUT Hours of Use by Vehicle Number
·
PUT Odometer by Vehicle Number
The
integrated user will be able to update vehicle information within REVEAL by
using this PUT method when a valid Vehicle Number is provided.
The
following information will be available to be updated for a vehicle record:
·
Vehicle
Name – must be unique within REVEAL account
·
Vehicle
Number – will be mandatory in order to reference the vehicle through the
integration services
·
Registration
Number
·
VIN
·
Year
·
Make
·
Model
·
Tank
Capacity– value saved to Fleetmatics will be referenced as liters
·
Highway
– value saved to Fleetmatics will be referenced as liters
·
City
– value saved to Fleetmatics will be referenced as liters
·
Vehicle
Size – if NULL the vehicle record will be defaulted to Light-Duty
o
Available
options include: Light-Duty, Medium-Duty, or Heavy-Duty
The
integrated user will be able to update a vehicle’s Hours of Use reading within
REVEAL by using this PUT method when a valid Vehicle Number is provided.
The
following information will be available to be updated for a vehicle record:
·
Current
Hours of Use
o
The
Current Hours of Use should be provided in minutes.
·
Current
Hours of Use as of Specific Date
o
The
Current Hours of Use should only be backdated 30 days from the date this method
is called.
When
the Current Hours of Use is updated any hours of use since the date of the
update, or specified date within the update, will be added to the value
provided.
The
integrated user will be able to update a vehicle’s Odometer reading within
REVEAL by using this PUT method when a valid Vehicle Number is provided.
The
following information will be available to be updated for a vehicle record:
·
Current
Odometer
o
This
value must be provided in KILOMETERS and REVEAL frontend will convert the value
based on the User’s Preference in Account Settings when using and reviewing the
value.
·
Current
Odometer as of Specific Date
o
The
Current Odometer should only be backdated 30 days from the date this method is
called.
When
the Current Odometer is updated any distance accumulated since the date of the
update, or specified date within the update, will be added to the value
provided.
The
Customer Meta Data API allows for groups to be updated using the Group Service
methods. The Group Service enables
integrated users to/from assign or remove drivers, vehicle, or users to
specific groups.
Group
information will be invoked using the Group ID as the unique identifier.
·
GET All Groups
·
GET Groups by Driver Number
·
GET Groups by Vehicle Number
·
GET Groups by Employee ID
·
GET Groups by Group ID
·
GET Drivers by Group ID
·
GET Users by Group ID
·
GET Vehicles by Group ID
The
integrated user will be able to return group information within REVEAL by using
this GET method. This will assist the
integrated user to understand the current group structure within the
Fleetmatics REVEAL account in order to properly associate drivers, users, and
vehicles to those groups.
The
following group information will be returned when using this method:
·
Group
Name
·
Group
ID – this is an alphanumeric field that must be unique within the Fleetmatics
REVEAL account and will be mandatory in order to reference the group through
the integration services
The
integrated user will be able to return group information that a driver is
currently assigned to within Fleetmatics REVEAL by providing a valid Driver
Number to reference. Results will
include Group Name and Group ID.
Multiple groups can be returned for each Driver Number provided as
drivers can belong to multiple groups within REVEAL.
The
integrated user will be able to return group information that a vehicle is
currently assigned to within Fleetmatics REVEAL by providing a valid Vehicle
Number to reference. Results will
include Group Name and Group ID.
Multiple groups can be returned for each Vehicle Number provided as
vehicles can belong to multiple groups within REVEAL.
The
integrated user will be able to return group information that a user is
currently assigned to within Fleetmatics REVEAL by providing a valid Employee
ID to reference. Results will include
Group Name and Group ID. Multiple groups
can be returned for each Employee ID provided as users can belong to multiple
groups within REVEAL.
The
integrated user will be able to verify the Group Name that corresponds with a
Group ID to ensure proper placement of drivers, vehicles, and users within the
Fleetmatics REVEAL account.
·
PUT Drivers to Group ID
·
PUT Users to Group ID
·
PUT Vehicles to Group ID
·
PUT Geofences to Group ID
The
integrated user will be able to update a driver to specify what group he/she should
be assigned to. The integration user
will need to specify the driver by Driver Number to be added to the Group ID
provided.
If the
Driver Number or Group ID are not valid within the account an ERROR will be
returned.
When a
driver is assigned to a group this will not remove a driver from any of the
previously assigned groups. Drivers can
belong to multiple groups within REVEAL.
If the driver is assigned to a parent group, the driver will also be
associated with any subgroups of that parent group.
The
integrated user will be able to update a user to specify what group he/she
should be assigned to. The integration user
will need to specify the user by Employee ID to be added to the Group ID
provided.
If the Employee
ID or Group ID are not valid within the account an ERROR will be returned.
When a
driver is assigned to a group this will not remove a driver from any of the
previously assigned groups. Users can
belong to multiple groups within REVEAL.
If the user is assigned to a parent group, the user will also be
associated with any subgroups of that parent group.
The
integrated user will be able to update a vehicle to specify what group it
should be assigned to. The integration
user will need to specify the vehicle by Vehicle Number to be added to the
Group ID provided.
If the Vehicle
Number or Group ID are not valid within the account an ERROR will be returned.
When a vehicle
is assigned to a group this will not remove a vehicle from any of the
previously assigned groups. Vehicles can
belong to multiple groups within REVEAL.
If the vehicle is assigned to a parent group, the vehicle will also be
associated with any subgroups of that parent group.
The
integrated user will be able to update a Geofence to specify what group it
should be assigned to. The integration
user will need to specify the Geofence by the Place ID to be added to the Group
ID provided.
If the
Place ID or Group ID are not valid within the account an ERROR will be
returned.
Geofences
can be assigned to multiple groups.
Adding a Geofence to a group will not remove the Geofence from another
group.
·
DELETE Drivers from Group ID
·
DELETE Users from Group ID
·
DELETE Vehicles from Group ID
·
DELETE Geofences from Group ID
The
integrated user will be able to remove a driver from a specified group. The integration user will need to specify the
driver by Driver Number to be removed from the Group ID provided.
If the
Driver Number or Group ID are not valid within the account an ERROR will be
returned.
Note:
if the driver is removed from all group associations, it will be placed within
the Ungrouped Group within the account.
Invoking this method does NOT delete the driver record from the REVEAL
account.
The
integrated user will be able to remove a user from a specified group. The integration user will need to specify the
user by Employee ID to be removed from the Group ID provided.
If the
Employee ID or Group ID are not valid within the account an ERROR will be
returned.
Note:
if the user is removed from all group associations, it will be placed within
the Ungrouped Group within the account.
Invoking this method does NOT delete the user record from the REVEAL
account.
The
integrated user will be able to remove a vehicle from a specified group. The integration user will need to specify the
vehicle by Vehicle Number to be removed from the Group ID provided.
If the
Vehicle Number or Group ID are not valid within the account an ERROR will be
returned.
Note:
if the vehicle is removed from all group associations, it will be placed within
the Ungrouped Group within the account.
Invoking this method does NOT delete the vehicle record from the REVEAL
account.
The integrated user
will be able to remove a Geofence from a specified group. The integration user will need to specify the
Geofence by Place ID to be removed from the Group ID provided.
If the Place ID or
Group ID are not valid within the account an ERROR will be returned.
Note: if the Geofence
is removed from all group associations, it will be placed within 0 Groups. When Groups Selected is 0 the Geofence will
be available for review to any users with access to view Geofences within the
product. Invoking this method does NOT
delete the Geofence record from the REVEAL account.
The
Geospatial API is a RESTful web service that enables Fleetmatics customers to
integrate 3rd party back-office systems with REVEAL to create and
delete Geofences within their account.
A
Geofence is a virtual perimeter created around a real-world location that’s
used to categorize activity. Geofences
can represent any type of location that is meaningful. Within REVEAL, Geofences are shown throughout
the site in various places and will be shown to the user by the common name
with or without the actual location address.
Important
concepts to understand prior to utilizing any of the available integration
methods:
·
Geospatial
API is offered as a RESTful web service
·
Standard
REST verbs are applied: GET, POST, PUT, and DELETE
·
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 identifier for the Geospatial API
is as follows and can be reviewed within the REVEAL Geofence profile:
o
Geofence
= PlaceID
The
integrated user will be able to verify the Geofences that corresponds with a
Group ID or Category.
·
GET Geofence by Group ID
·
GET Geofence by Category
The
integrated user will have the option to GET Geofences associated with a
specified Group ID. The user will only
be able to provide 1 Group ID within the method to return the active Geofences
assigned to that group. Please note:
Geofences may be assigned to multiple groups and therefore the same Geofence
may be returned for multiple groups.
The
user will not be able to select Entire Fleet or the Unassigned Group to return
Geofences. Only valid Group IDs will be
permitted to be used for the GET Geofences by Group ID method.
The
following data will be returned for Geofences associated with the specified
Group ID:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name
·
Country
·
Geofence
Name
·
GeoShape
Type – this field will populate one of the following options: Circle,
Rectangle, or Polygon
·
Email
Address
·
Is
Shown On Map
·
Is
Shown On Report
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Note
·
Phone
Number
·
Place
ID
·
Postal
Code
·
Link
for spatial information if a Rectangle or Circle – this link may be used in
order to understand the details regarding the Geofence size if the Geofence is
a Circle or Rectangle
The
integrated user will have the option to GET Geofences associated with a
specified Category. The user will only
be able to provide 1 Category within the method to return the active Geofences
assigned to that group. Please note:
Geofences may be assigned to multiple categories and therefore the same
Geofence may be returned for multiple categories.
Category
match will be based on the Category name within REVEAL. If no exact match is found the user will
receive an ERROR.
The
following data will be returned for Geofences associated with the specified
Group ID:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name
·
Country
·
Geofence
Name
·
GeoShape
Type – this field will populate one of the following options: Circle,
Rectangle, or Polygon
·
Email
Address
·
Is
Shown On Map
·
Is
Shown On Report
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Note
·
Phone
Number
·
Place
ID
·
Postal
Code
·
Link
for spatial information if a Rectangle or Circle – this link may be used in
order to understand the details regarding the Geofence size if the Geofence is
a Circle or Rectangle
The
integrated user will have the option to create either a circular or rectangular
Geofence within REVEAL.
·
POST Circle
·
POST Rectangle
The
integrated user will have the option to create a circular Geofence within
REVEAL using an address or latitude and longitude coordinates as the point of
reference for the location to be created.
The address or coordinates provided will be used as the center-point for
the circle.
The
Geofence POST methods will follow this logic as each method allows the user to
supply both an address and a set of coordinates to create the location:
·
If
the user provides only an address the Geofence will be created using the
address and the latitude and longitude values may be NULL.
·
If
the user provides only the latitude and longitude coordinates the Geofence will
be created using the coordinates and address fields may be NULL.
o
If
the user does not provide both a valid latitude and longitude coordinate, an
ERROR will return indicating that both coordinate values were not provided.
·
If
the user provides both an address and latitude and longitude coordinates then
the Geofence will be created referencing the coordinates.
·
If
the user does not provide an address or latitude and longitude coordinates, the
call will return an ERROR indicating that the coordinates or address fields are
required.
·
The
created Geofence will be assigned to the “Entire Fleet” group within the REVEAL
account.
o
If
the Geofence should be assigned to a particular group other than the Entire
Fleet, the CMD PUT Geofence to Group ID method should be invoked following the
creation of the Geofence.
The
following fields will be available to the user when creating a circle Geofence:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name - categories must be created and managed within the REVEAL site. Once the category is created the integrated
user can provide an exact category match to associate with the Geofence being
created. If no exact category match is
found then the user will receive an ERROR.
o
If
the category provided by the user does not match an existing category in the
REVEAL account then an ERROR will return indicating the Category could not be
matched.
·
Country
·
Email
Address – if there is an email address that should be associated with the place
being created
·
Geofence
Name – this is a mandatory field in order to identify and search for the
Geofence within the REVEAL account
·
Is
Shown on Map - this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display on
the map
o
If
the user selects FALSE the Geofence information saved will not be displayed on
the map
·
Is
Shown on Report – this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display
within reports
o
If
the user selects FALSE the Geofence information saved will not be displayed
within reports
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Note
·
Phone
Number – if there is a telephone number that should be associated with the
place being created
·
Place
ID – this is a mandatory field and it must be unique within the REVEAL account
·
Postal
Code
·
Radius
in KM – the user will provide a value for the circular radius to be drawn
around the coordinates that will serve as the center point.
The
integrated user will have the option to create a rectangular Geofence within
REVEAL using an address or latitude and longitude coordinates as the point of
reference for the location to be created.
The
Geofence POST methods will follow this logic as each method allows the user to
supply both an address and a set of coordinates to create the location:
·
If
the user provides only an address the Geofence will be created using the
address and the latitude and longitude values may be NULL.
·
If
the user provides only the latitude and longitude coordinates the Geofence will
be created using the coordinates and address fields may be NULL.
o
If
the user does not provide both a valid latitude and longitude coordinate, an
ERROR will return indicating that both coordinate values were not provided.
·
If
the user provides both an address and latitude and longitude coordinates then
the Geofence will be created referencing the coordinates.
·
If
the user does not provide an address or latitude and longitude coordinates, the
call will return an ERROR indicating that the coordinates or address fields are
required.
·
The
created Geofence will be assigned to the “Entire Fleet” group within the REVEAL
account.
o
If
the Geofence should be assigned to a particular group other than the Entire
Fleet, the CMD PUT Geofence to Group ID method should be invoked following the
creation of the Geofence.
The
following fields will be available to the user when creating a rectangle
Geofence:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name - categories must be created and managed within the REVEAL site. Once the category is created the integrated
user can provide an exact category match to associate with the Geofence being
created. If no exact category match is
found then the user will receive an ERROR.
o
If
the category provided by the user does not match an existing category in the
REVEAL account then an ERROR will return reading, “The Category specified is
not valid within the REVEAL account.”
·
Country
·
Email
Address – if there is an email address that should be associated with the place
being created
·
Geofence
Name – this is a mandatory field in order to identify and search for the
Geofence within the REVEAL account
·
Is
Shown on Map - this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display on
the map
o
If
the user selects FALSE the Geofence information saved will not be displayed on
the map
·
Is
Shown on Report – this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display
within reports
o
If
the user selects FALSE the Geofence information saved will not be displayed
within reports
·
Latitude
·
Length
In KM – mandatory when creating a rectangular Geofence
·
Locality
– city, town, etc.
·
Longitude
·
Note
·
Phone
Number – if there is a telephone number that should be associated with the
place being created
·
Place
ID – this is a mandatory field and it must be unique within the REVEAL account
·
Postal
Code
·
Width
In KM – mandatory when creating a rectangular Geofence
The
integrated user will be able to update a vehicle’s Odometer reading within
REVEAL by using this PUT method when a valid Vehicle Number is provided.
·
PUT Circle by Place ID
·
PUT Rectangle by Place ID
The
integrated user will be able to edit an existing Geofence by calling this PUT
method to update the circular Geofence.
Please note: if the Place ID supplied for this method was formerly a
rectangle the shape will change to a circle when this method is invoked.
The
user will need to provide a valid Place ID to match the Geofence to be edited.
The
following fields are available to be edited as long as a valid Place ID is
provided:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name – user can provide a category if there is an existing category exact match
the Geofence will be assigned to that category
·
Country
·
Email
Address – if there is an email address that should be associated with the place
being created
·
Geofence
Name – this is a mandatory field in order to identify and search for the
Geofence within the REVEAL account
·
Is
Shown on Map - this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display on
the map
o
If
the user selects FALSE the Geofence information saved will not be displayed on
the map
·
Is
Shown on Report – this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display
within reports
o
If
the user selects FALSE the Geofence information saved will not be displayed
within reports
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Phone
Number
·
Place
ID – REQUIRED and must be unique within a REVEAL account
·
Postal
Code
·
Radius
in KM
o
When
editing a circular Geofence the radius should be provided in kilometers with a
center-point
o
If
the category provided does not have an exact match the user will receive an
ERROR
The
integrated user will be able to edit an existing Geofence by calling this PUT
method to update the rectangular Geofence.
Please note: if the Place ID supplied for this method was formerly a
circular the shape will change to a rectangle when this method is invoked.
The
user will need to provide a valid Place ID to match the Geofence to be edited.
The
following fields are available to be edited as long as a valid Place ID is
provided:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Category
Name – user can provide a category if there is an existing category exact match
the Geofence will be assigned to that category
·
Country
·
Email
Address – if there is an email address that should be associated with the place
being created
·
Geofence
Name – this is a mandatory field in order to identify and search for the
Geofence within the REVEAL account
·
Is
Shown on Map - this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display on
the map
o
If
the user selects FALSE the Geofence information saved will not be displayed on
the map
·
Is
Shown on Report – this value should be addressed using TRUE or FALSE
o
If
the user selects TRUE the Geofence information saved will be used to display
within reports
o
If
the user selects FALSE the Geofence information saved will not be displayed
within reports
·
Latitude
·
Length
In KM – mandatory when creating a rectangular Geofence
·
Locality
– city, town, etc.
·
Longitude
·
Phone
Number
·
Place
ID – REQUIRED and must be unique within a REVEAL account
·
Postal
Code
·
Width
In KM – mandatory when creating a rectangular Geofence
The
integrated user will have the option to delete specified Geofences from the
REVEAL account.
·
DELETE Geofence by Place ID
The
integrated user will have the option to delete a specified Geofence using the
Delete Geofence method. The Geofence
will need to be identified by the Place ID.
The
Real-time Aggregated Data API is available to enable integrated users to poll
GPS location-based information collected from vehicles tracked with Fleetmatics
REVEAL.
Important
concepts to understand prior to utilizing any of the available integration
methods:
·
Real-time
Aggregated Data API is offered as a RESTful web service
·
Standard
REST verbs are applied: GET
·
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
Vehicle
Number
Fleetmatics
offers a variety of methods to return vehicle information to be polled by a
customer or third party. Each method is
designed to return a particular set of data, but all methods can be bundled in
order to return a larger set of vehicle-based information if desired, i.e. a
user may call both the Get Location and Get Status for a Vehicle Number.
·
GET
Location by Vehicle Number
·
GET
Status by Vehicle Number
The
integrated user will be able to return location details using this GET method.
The
following information will be returned with the Get Location method:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – State, Province, etc.
·
Country
·
Delta
Distance – distance between the previous GPS plot and the current
·
Delta
Time – time between previous GPS plot and the current
·
Device
Time Zone – the GPS device’s current time zone, “Vehicle Time Zone”
·
Device
Time Zone Offset – the GPS device’s current time zone compared to UTC
·
Direction
– the degrees of the compass direction
·
Display
State – the values used to describe a vehicle’s display state include the
following values:
|
Number |
Definition |
|
0 |
Coverage |
|
1 |
Moving |
|
2 |
Stop |
|
3 |
Towing |
|
4 |
Idle |
|
5 |
Panic |
|
6 |
Privacy |
·
Geofence
Name – if the vehicle is within a Geofence, the name of the Geofence will be
returned
·
Heading
– the following Heading values will be returned:
o
North,
North East, East, South East, South, South West, West, North West, and Unknown
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Postal
Code
·
Speed
– the value will be returned in kilometers per hour
·
Update
UTC
The
integrated user will be able to return vehicle status information using this
GET method.
The following
information will be returned with the Get Status method:
·
Device
Time Zone Offset
·
Display
State – the values used to describe a vehicle’s display state include the
following values:
|
Number |
Definition |
|
0 |
Coverage |
|
1 |
Moving |
|
2 |
Stop |
|
3 |
Towing |
|
4 |
Idle |
|
5 |
Panic |
|
6 |
Privacy |
·
Driver
ID – REVEAL’s Driver Number
·
Driver
Name
·
Engine
Minutes – current engine on minutes
·
Idle
Time
·
Sensor
Values
·
Speed
– the value will be returned in kilometers per hour
·
Current
Odometer – total distance the vehicle has traveled in kilometers
·
Update
UTC
The
Driver Activity API is a RESTful web service that enables Fleetmatics 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
·
GET
Assignment by Driver Number
·
GET
Assignment by Vehicle 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.
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.
·
POST
Assignments
The
integrated user will be able to POST new driver/vehicle assignments within
REVEAL. The user will need to provide
the following information to create a driver assignment:
·
Driver
Number
·
Vehicle
Number
·
Start
Date UTC
·
End
Date UTC – this may be left NULL if the assignment end date is not known
The
Planning and Scheduling API is a RESTful web service that enables Fleetmatics
customers to integrate 3rd party back-office systems with REVEAL to
create and manage work orders to review the vehicle’s GPS data alongside the
locations that their drivers are expected to visit.
Important
concepts to understand prior to utilizing any of the available integration methods:
·
Planning
and Scheduling API is offered as a RESTful web service
·
Standard
REST verbs are applied: GET, POST, PUT, DELETE
·
The
Planning and Scheduling API is broken into two main components: methods
available to manage work orders and methods available to manage navigation
·
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
Work
Order Number
o
Driver
Number
o
Vehicle
Number
o
Work
Order Status Code
o
Work
Order Type Code
o
Stop
ID
The
following GET method will be used in order to return work order details.
·
GET Work Order By Work Order Number
·
GET All Work Order Statuses
·
GET All Work Order Type Codes
·
GET Work Order Type by Code
·
GET Work Order Status by Work
Order Number
The
integrated user will be able to return a work order object’s details using this
GET method. The method will only return
a work order if the work order has been previously created and sent to the
REVEAL account.
The
following information will be returned with the GET Work Order by Work Order
Number method:
·
Actual
Date UTC
·
Actual
Duration
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Driver
Number
·
Work
Order Number
·
Country
·
Description
·
Driver
ID
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Radius
in KM
·
Postal
Code
·
Scheduled
Date UTC
·
Scheduled
Duration
·
Status
Change Date UTC
·
Work
Order Status Code
·
Work
Order Status Description
·
Work
Order Status Type
·
Work
Order Type Code
The
integrated user will be able to use this GET method to collect a list of all
the available work order status codes configured within a REVEAL account. Accurate Work Order Status Code values are
important to track the lifecycle of a work order and will be used to calculate
work order durations and metrics within REVEAL.
Work
Order Status Codes are unique values configured by the integrated user for the
account and can be created using the POST Work Order Status method.
|
Work Order Status Code Created by the integration
user for a REVEAL account – this is a mandatory field to create a work order |
Work Order Status Description Created by the integrated user
and is an optional field |
Work Order Status Type ID Created by REVEAL as an
enumerator value and will be used to calculate work order durations within
REVEAL |
Description of Enumerator Not a value within REVEAL, but
is the interpretations of the Work Order Status Type ID enumerator |
|
|
|
0 |
NONE |
|
|
|
1 |
OPEN |
|
|
|
2 |
IN PROCESS |
|
|
|
4 |
COMPLETE |
|
|
|
8 |
CLOSED |
|
|
|
16 |
CANCELED |
|
|
|
32 |
SUSPENDED |
The
integrated user will be able to manage work orders using values created to describe
the type of work associated with the work order. The Work Order Type Code is provided by the
integrated user using the POST Work Order Type Code method.
The
following information will be returned when invoking this method:
·
Work
Order Type Code
·
Work
Order Type Description
·
Date
and Timestamp when the Work Order Type Code was created by the integrated user
The
integrated user will be able to use this GET method to retrieve a particular
Work Order Type by providing the unique Work Order Type Code value. This will allow users to confirm when/if a
particular Work Order Type was previously created. This method will also show the Work Order
Type Code Description if one was previously provided when creating the code.
The
integrated user will be able to use this GET method to retrieve the current status
of a specific work order.
The
integrated user must present a valid work order number. If the work order number cannot be verified
within the REVEAL account the user will receive an ERROR.
The
following information related to a work order will be returned when invoking
this method:
·
Current
Work Order Status
·
Work
Order Status change date and timestamp
·
Work
Order Status Code
·
Work
Order Status Description
·
Work
Order Status Type ID
·
POST Work Order
·
POST Work Order Status Code
·
POST Work Order Status by Work
Order Number
·
POST Work Order Type Code
The
integrated user will be able to use this method to create (POST) work orders to
their REVEAL account. Each work order
will need to have a set of respective attributes provided within the create
method in order to be used properly within REVEAL.
The
following information will be available to update the work order record:
·
Actual
Date UTC
·
Actual
Duration
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Client
Customer ID – should be NULL
·
Country
·
Description
·
Driver
Number
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
On
Site Duration
·
Postal
Code
·
Radius
in KM
·
Scheduled
Date UTC
·
Scheduled
Duration
·
Status
Change Date UTC
·
Work
Order Number – this is a mandatory field to create a work order and then
perform any subsequent work order calls
·
Work
Order Status Code
·
Work
Order Status Type Code
If both
address fields and latitude/longitude values are provided within the request,
the work order will use the latitude/longitude coordinates to designate the
location. If neither the address nor
coordinates are provided an ERROR will be returned to the integrated user.
The
integrated user will be able to provide REVEAL with Work Order Status Codes to
clarify the state of a work order.
REVEAL interprets all statuses as enumerators that will be used to
review a work order’s lifecycle and to calculate specific durations related to
a work order. Therefore, it is important
for our integrated users to ensure that the Work Order Status Code is properly
aligned to the enumerators that REVEAL will use for these calculations within
Work Order metrics and reporting.
Work
Order Status Codes must be unique within an REVEAL account. The value can be alphanumeric and has a
maximum character value of 64. However,
integrated users may create multiple work order status codes to be aligned with
1 enumerator value. The Work Order
Status Code is a mandatory field for a work order.
|
Work Order Status Code Created by the integration
user for a REVEAL account – this is a mandatory field to create a work order |
Work Order Status Description Created by the integrated user
and is an optional field |
Work Order Status Type ID Created by REVEAL as an
enumerator value and will be used to calculate work order durations within
REVEAL |
Description of Enumerator Not a value within REVEAL, but
is the interpretations of the Work Order Status Type ID enumerator |
|
|
|
0 |
NONE |
|
|
|
1 |
OPEN |
|
|
|
2 |
IN PROCESS |
|
|
|
4 |
COMPLETE |
|
|
|
8 |
CLOSED |
|
|
|
16 |
CANCELED |
|
|
|
32 |
SUSPENDED |
The
integrated user will be able to update a work order’s status using this POST
method. This method should ONLY be used
for updating an existing work order’s status and will not allow for work order
attributes to be modified using this method.
If the work order attributes need to be modified, please refer to the
POST Work Order by Work Order Number method.
The
following fields will be available to be updated using this PUT method:
·
Work
Order Status Change Date
·
Work
Order Status Code
If the
integrated user provides a Work Order Status Code that has not been previously
created within the REVEAL account, a 404 ERROR will be returned. To create a new Work Order Status Code within
an account, see the POST Work Order Status Code method.
The
integrated user will be able to provide REVEAL with Work Order Type Code to
clarify the type of work that should be associated with the work order. The Work Order Type Code is a mandatory field
for a work order.
The
user will be able to provide the following details when creating a new Work
Order Type Code for a REVEAL account:
·
Work
Order Type Code – must be unique
·
Work
Order Type Description – optional
The
Date and Timestamp will be stored upon creation.
·
PUT Work Order by Work Order
Number
The
integrated user will be able to edit an existing work order by using this PUT
method and providing a valid work order number.
This
method will not be able to perform the following changes to a work order:
1. Cannot delete a work order
2. Cannot update a work order’s
status
Please
note the unique identifier to call this PUT method is the Work Order
Number. If a valid Work Order Number is
not provided an ERROR will be returned.
A valid Work Order Number is defined as REVEAL already having received
the work order object previously with a unique Work Order Number.
The
following information work order fields will be available to be updated using
this method:
·
Actual
Date UTC
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Client
Customer ID – should be NULL
·
Country
·
Description
·
Driver
Number
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
On-Site
Duration
·
Postal
Code
·
Radius
in KM
·
Scheduled
Date UTC
·
Scheduled
Duration UTC
·
Work
Order Type Code
If both
address fields and latitude/longitude values are provided within the request,
the work order will use the latitude/longitude coordinates to designate the
location. If neither the address nor
coordinates are provided an ERROR will be returned to the integrated user.
·
GET Stops by Vehicle Number
The
integrated user will be able to use this GET method to retrieve a list of stops
previously sent to a vehicle’s Garmin navigational device.
A valid
Vehicle Number will need to be provided to invoke this method. If the user provides a Vehicle Number for a
vehicle that does not have a Garmin device an ERROR will be returned.
All
stops on the vehicle’s Garmin navigational device that are active will be
returned. The following information
related to the vehicle’s stops will be returned when invoking this method:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Country
·
Description
·
Device
Index – this value will help to review the full list of stops sent to a
vehicle’s Garmin navigational device in order to see the order of the stops
·
Device
Stop ID
·
Is
High Priority
·
Has
Been Completed – Boolean
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Postal
Code
·
Stops
List
·
Vehicle
Number
·
POST Stops
·
POST Stops Order
·
POST Stop for Work Order
The
integrated user will be able to use this POST method to send stops to a
vehicle’s Garmin navigational device in order to help the driver prioritize and
navigate to the stops that he/she will make throughout the day.
The
following information will be available to send a stop to a vehicle:
·
Address
Line 1
·
Address
Line 2
·
Administrative
Area – state, province, etc.
·
Country
·
Description
– optional
·
Latitude
·
Longitude
·
Locality
– city, town, etc.
·
Is
High Priority – when set to “TRUE” this stop will become critical and will take
precedence over any other stop in the vehicle’s stop queue. This value will default to “FALSE.”
·
Postal
Code
If both
address fields and latitude/longitude values are provided within the request,
the work order will use the latitude/longitude coordinates to designate the
location. If neither the address nor
coordinates are provided an ERROR will be returned to the integrated user.
The
integrated user will be able to use this POST method to re-order stops
previously sent to a vehicle’s Garmin navigational device.
The
integrated user will need to provide a valid Vehicle Number.
The
method request will provide the Ordered Device Stop Id List for the user to
place the Stop IDs into the proper order as they should appear on the vehicle’s
corresponding Garmin navigational device.
The
integrated user utilizing both work orders management integration alongside the
Garmin navigation integration will be able to convert existing work orders into
stops to be managed by the Garmin navigational device within the driver’s
vehicle.
Work
Orders must already exist within REVEAL with a valid Work Order Number in order
to be sent as a stop to a driver’s vehicle.
If the Work Order Number does not exist within REVEAL an ERROR will be
returned.
Work
Orders with coordinates/locations that cannot be resolved will return an ERROR
for an invalid request regarding the location for the work order.
If a
Work Order Number does not have a driver assigned to it, an ERROR will be
returned noting that unassigned stops cannot be sent. Furthermore, if the driver assigned to the
work order is not assigned to a vehicle within the REVEAL account, an ERROR
will be returned specifying that the driver assigned to the work order must be
assigned to a vehicle to send a stop.
If the
Work Order is sent with a Description included the description provided within
the request will be shown on the vehicle’s Garmin navigational device. If no Description is provided by the user
within the request, the Garmin navigational device will display the Work Order
Number and Work Order Address.
·
DELETE Stops
The
integrated user will be able to use this DELETE method to remove stops from a
vehicle’s Garmin navigational device.
The
integrated user will need to provide a valid Vehicle Number and Stop Id. If no valid Vehicle Number or Stop Id
exist