OnlineAVL Published Interface
Welcome to the OnlineAVL 2 Published Interface V2.7 WSDL
The Published Interface is designed to provide programmatic access via the internet to the Navman Wireless OnlineAVL2 Vehicle Tracking and Fleet Management product. The Published Interface to the OnlineAVL2 system consists of a set of web-methods made available over the internet to authenticated users of the Published Interface. It provides the ability to send information to vehicles e.g. Text Messages and asserting Auxiliary Outputs (ConEx), and retrieve information from the Vehicles e.g. GPS Activity, Auxiliary Inputs (ConEx), Engine Management data (EMS) and Text Messaging (MDT/MNav). It is assumed the reader is somewhat familiar with the Navman Fleet Tracking system.The following operations are supported. For a formal definition, please review the Service Description.
-
AddDriverByType
Add driver with specified details to the indicated fleet. -
AssignRouteToVehicle
Assigns Route to a vehicle -
AssignToVehicleGroup
This method assigns vehicle to given vehicle group display name. -
CancelRouteInstance
Cancels a Route by routeId in a fleet -
CreateOwner
Creates a fleet -
CreateSiteEx
Create the specified extended site -
DeleteSiteEx
Delete the specified extended site -
DoCalibrateEngineHours
Calibrates the engine hours. -
DoCalibrateOdometer
Calibrates the odometer value. -
DoLogin
This method is used to authenticate a client application with the Published Interface web service. This method returns a session id/ token which must be supplied with all subsequent API calls. -
DoLogoff
This method disconnects the session for the supplied session id. -
DoQueryVehicleLocation
Sends the SMDP message to the device to return the current location of vehicle. -
DoSendDeleteTextMessage
This method provides a mechanism for the client application to instruct the Vehicle MDT to delete all text messages on the device. -
DoSendForms
This method sends list of form instance messages to the specified vehicles. -
DoSendRouteMessage
This method provides a mechanism for the client application to send a single Route-To Message to the MDT's on the supplied Vehicle(s). -
DoSendRouteMessages
This method provides a mechanism for the client application to send multiple Route-To Messages to the MDT's on the supplied Vehicle(s). Note that the batch operation is done asynchronously. This method returns as soon as a batch execution process has been created to perform the batch operation. -
DoSendTextMessage
This method provides a mechanism for the client application to send a text message to one or more of the supplied Vehicles. -
DoSetDeviceOutputs
This method provides a mechanism for the client application to set the new state of a single ConEx output port of an individual vehicle. This method can only be invoked for one vehicle at a time. -
DoTransferVehicles
Transfers a vehicle from one fleet to another for a leasing arrangement. -
EditDriverInfo
Edit Driver Info (Driver, DriverLicence and DriverProfile tables) -
GetConExConfigurationsByVehicles
This method provides the current configuration of Conex equipment installed on the supplied Vehicle(s). -
GetDriverVehicleTables
Get all Licence Classes, Driver Groups, Vehicle Types and Vehicle Groups for the specified fleet -
GetDrivers
This method provides a list of Drivers associated with the specified Owner/ Fleet accessible by the user. -
GetEMSPeriodActivity
Gets EMS trip information for a list of fleets or vehicles, for a specific time period -
GetFleetDiagnostics
Gets the EMS Diagnostics information for the selection of vehicles/fleets for a specific date range -
GetFormList
Gets a list of form definitions -
GetFormListDetail
This method returns a list of form definitions. -
GetForms
Returns a list of form instances for given owner or vehicless or form numbers -
GetFormsDetails
This method provides a list of form instance detail for given message ids or vehicle ids or form number. -
GetGeofences
This method provides a list of Geofences associated with the specified Owner/ Fleet accessible by the user. -
GetHOSDriverDailyLogs
Get HOS Driver Daily Logs for a specified Driver or for all Drivers in a specified Fleet -
GetHOSDriverLogEditRecords
Get HOS Driver Log Edit Records for a specified Driver or for all Drivers in a specified Fleet -
GetHOSDrivers
Get all drivers including HOS information belonging to the specified fleet (ownerID) -
GetHOSProfileTables
Get all HOS Profile Tables (Regulations, Regulation Cycle, Regulation Types, Timezone, Status Definition - plus Carrier Information and Terminal for the specified fleet) -
GetHOSTimers
Get all HOS Timers for the specified Driver/Fleet -
GetHardwareDetails
Gets the hardware details of the device for the specified vehicle or all the vehicles under the specified Owner. -
GetMessages
This method provides all text messages sent from Vehicles for a specified Fleet during a specified time period. -
GetOwners
This method provides information on the Owners (Fleets) which are accessible by the user. -
GetPeriodActivity
This method provides the current status of all vehicles belonging to the supplied Owner/ Fleet accessible by the user. -
GetPeriodActivityEx
This method provides the current status of all vehicles belonging to the supplied Owner/ Fleet accessible by the user with provision of version override for handling late arriving data. -
GetPlanTemplates
Get Plan templates and attributes for a fleet -
GetSafetyAnalyticsEvents
This method returns the safety analytics events for the specified time period. -
GetSendRouteMessagesStatus
This method provides a mechanism for the client application to request a status update for the batch route-to messages request which was sent to the server using the DoSendRouteMessages() web service method. -
GetSentFormsStatus
This method send list of sent forms for knowing their status. -
GetSiteExs
Get a list of extended sites associated with the specified fleet -
GetSiteTypes
Get a list of site types associated with the specified fleet -
GetSites
Get a list of sites associated with the specified fleet. -
GetVehicleDVIR
Get all vehicle DVIR for the specified fleets/vehicles/drivers -
GetVehicleEngineHours
Get Vehicle Engine Hours for a fleet or a collection of vehicles -
GetVehicleGroups
This method retrieves list of vehicle group for given owner. -
GetVehicleSnapShots
This method provides the current status of all vehicles belonging to the supplied Owner/ Fleet accessible by the user. -
GetVehicleTransferStatus
Gets the status of a vehicle transfer. -
GetVehicles
This method provides a list of Vehicles for the supplied Owner/ Fleet. -
GetVehiclesActivityDetails
This method provides extended information for the supplied Vehicle activity record. -
GetWorkflowTaskSettings
Gets all tasks with details like actions and fields for given template based on associated workflow -
GetWorkflowTaskUpdates
Gets all task updates for each route within the date time range -
ImportPlan
Import Plans for fleet -
SendMNavMessage
Sends data to the MNav device for the targeted vehicle(s) -
SetVehicleDetails
Updates specified vehicle properties for the specified vehicle. -
UpdateDVIRByMechanic
Update DVIR -
UpdateOwner
Modifies a fleet. -
UpdateSiteEx
Update the specified extended site -
UpdateVehicleCustomStatus
Updates the vehicle custom status.