WEBFLEET.

connect Reference

Revision history 1 Welcome 2 Programming Guide
2.1 Introduction to WEBFLEET.connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 2.2 Preparing for WEBFLEET.connect. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.2.1 Registering for WEBFLEET.connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.2.2 Checking requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.2.3 Creating a user and assigning rights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 2.3 Making requests to WEBFLEET.connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 2.3.1 Making HTTP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 2.3.2 Making SOAP requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 2.3.3 Request limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 2.3.4 Common parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

3 Reference
3.1 Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.1.1 showObjectReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.1.2 showVehicleReportExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 3.1.3 showObjectGroupReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 3.1.4 showObjectGroupObjectReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 3.1.5 showContracts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 3.1.6 updateVehicle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 3.2 Orders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3.2.1 sendOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3.2.2 sendDestinationOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 3.2.3 updateOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 3.2.4 updateDestinationOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 3.2.5 insertDestinationOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 3.2.6 cancelOrderExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 3.2.7 assignOrderExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 3.2.8 reassignOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 3.2.9 deleteOrderExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 3.2.10 clearOrdersExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 3.2.11 showOrderReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 3.3 Text messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 3.3.1 sendTextMessageExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 3.3.2 clearTextMessagesExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 3.4 Drivers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 3.4.1 showDriverReportExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 3.4.2 insertDriverExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 3.4.3 updateDriverExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

v.1.7.4, © 2011 TomTom Business Solutions

2

3.4.4 deleteDriverExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 3.5 Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 3.5.1 showAddressReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 3.5.2 showAddressGroupReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 3.5.3 showAddressGroupAddressReportExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . 54 3.5.4 insertAddressExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 3.5.5 updateAddressExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 3.5.6 deleteAddressExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 3.5.7 attachAddressToGroupExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 3.5.8 detachAddressFromGroupExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 3.5.9 insertAddressGroupExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 3.5.10 deleteAddressGroupExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 3.6 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 3.6.1 showEventReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 3.6.2 acknowledgeEventExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 3.6.3 resolveEventExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 3.7 Trips and working times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 3.7.1 showTripReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 3.7.2 showTripSummaryReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 3.7.3 showLogbookReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 3.7.4 showWorkingTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 3.7.5 showStandStills. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 3.7.6 showIdleExceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 3.8 Miscellaneous reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 3.8.1 showIOReportExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 3.8.2 showObjectAccelerationEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 3.8.3 showObjectSpeedingEvents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 3.9 Geocoding and routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 3.9.1 geocodeAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 3.9.2 calcRouteSimpleExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 3.10 Message queues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 3.10.1 Overview of queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 3.10.2 createQueueExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 3.10.3 deleteQueueExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 3.10.4 popQueueMessagesExtern. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 3.10.5 ackQueueMessagesExtern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Appendix A: Operation return codes
Response codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Response codes - Queues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Appendix B: Resources
WEBFLEET.connect resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Other resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

v.1.7.4, © 2011 TomTom Business Solutions

3

2.2 1. all rights reserved No part may be reproduced except as authorized by written permission.4 1.7.added support for GO x10 Changed the size of the order text parameter for sendDestinationOrderExtern.1.7.8 1. Author UM CS IM ML ML IM IM IM IM 1.0. TomTom International B.0 1. added updateAddressExtern Editorial changes Initial release after conversion to DocBook Extended parameter set for sendDestinationOrderExtern .0 2006-11-07 IM v. 1.6 1.WEBFLEET.1.V.. updateDestinationOrderExtern and cancelOrderExtern. Added some notes regarding performance impacts to showMessageReportExtern.1. updateOrderExtern.The copyright and the foregoing restriction extend to reproduction in all media.1. © 2011 TomTom Business Solutions 4 .5 1. Table: Revision history: Revision 1.1.4 Copyright © 2005-2010 TomTom Business Solutions.7 1.1.1.9 Date 2004-10-08 2005-08-22 2005-09-29 2005-09-30 2005-09-30 2006-04-05 2006-04-07 2006-06-29 2006-08-22 Description Initial release Added showTripReportExtern and added the field fuel_usage to showTripSummaryReportExtern output Added sendDestinationOrderExtern Added methods to deal with addresses (Addresses) Added parameter addrgrpname to insertAddressExtern.connect.3 1. Doc.1.connect TomTom Business Solutions. Renamed parameter from radium to radius for insertAddressExtern (documentation fix) Added methods for order management: insertDestinationOrderExtern.Revision history Revision history TomTom WEBFLEET.4.1.

Added geocodeAddress for geocoding.5 1. Minor additions to the documentation of some result columns.2 2006-12-08 IM 1.2.3.1 2007-01-23 2007-05-07 IM IM 1.3. Author IM 1.3.3 2007-07-20 IM 1. Changed DNS hostname for WEBFLEET.tomtomwork.3.3.1 Date 2006-11-24 Description Corrected the range_pattern for user-defined from du to ud. the column might still be part of the result. Changed the result column name for showOrderReportExtern from orderno to orderid.com. Added reassignOrderExtern New request limits (Request limits) based on functional groups.2.7 2008-05-08 IM v.4.Table: Revision history: Revision 1. Changed the parameter addrstate to addrcountry for insertAddressExtern and updateAddressExtern.2 2007-07-17 IM 1. msgstatus and msgtype for showMessageReportExtern. Added documentation of parameter constraints for showMessageReportExtern.4 2007-10-10 IM 1.webfleet. Extensions to showObjectReportExtern. Added value documentation for tripmode for showTripReportExtern. Updated documentation for showMessageReportExtern with new explanations for msgidbased replication and parameter limits.1. Added examples and corrections to the date format requirements for rangefrom_string and rangeto_string. but the contents – if any – should be considered as reserved). Added showOrderMessageReportExtern. © 2011 TomTom Business Solutions 5 . Added some more explanations on how to make HTTP requests. Removed filter parameter objectgroupname from several report methods that return message-based data.3 1.6 2007-10-12 2008-01-24 IM IM 1. Updated documentation for showTripReportExtern with new explanations for tripid-based replication and interpretation of date range filters.3.connect to connect.7. now returns most recent position data in addition to object details. Removed userstate from the result set documentation for showMessageReportExtern (for backward compatibility.2.3. Minor editorial changes. Added value documentation for status.

Updated documentation for objectno/objectid and orderno/orderid with details about parameter size.8 Date 2008-07-29 Description Updated documentation for insertAddressExtern and updateAddressExtern . clearTextMessagesExtern. eta. see Orders.6.1 2009-06-18 IM 1. Added new details to showObjectReportExtern on page 19: current destination navigated to. Expanded the list of documented error codes in Appendix A. Removed documentation for showMessageReportExtern because its use is deprecated and will not be available after 2008-12-31. Added support for the digital tachograph to showObjectReportExtern. © 2011 TomTom Business Solutions 6 . Added a clarification regarding supported date/time formats to showWorkingTimes. Replaced working and usage time reports with showWorkingTimes. Added new methods: clearOrdersExtern.0 2008-10-28 IM 1.Table: Revision history: Revision 1.1. updateAddressExtern and showAddressReportExtern. Added appendixes with operation result codes and recommended resources. Added section Making SOAP requests. Added deleteOrderExtern. Added support for address regions to insertAddressExtern. Added documentation for parameter restrictions on showTripReportExtern. Author IM 1. current order (if any) and matched address number for the vehicle's current position (all subject to support by the connected device).5. Added a set of methods for driver management.0 2009-02-16 IM 1.1 2010-02-18 IM 1. Operation Return Codes.4. Extended the filter parameter set for showEventReportExtern and added methods to flag events as acknowledged and as resolved. Updated documentation for userstate result element for showOrderMessageReportExtern. Added a new section about queuebased access to messages (Overview of queues).5.2 1.6. Minor editorial changes.2 2010-02-25 IM v. Updated result columns for the object a driver is currently signed onto to showDriverReportExtern. popQueueMessagesExtern and all driver management methods. Added support for address colours to insertAddressExtern. Added examples to sendDestinationOrderExtern and showOrderReportExtern. updateAddressExtern and showAddressReportExtern.added description for the parameter visible.0 2009-07-02 2010-01-06 IM IM 1. Removed documentation for showOrderMessageReportExtern (its use is still supported but it should not be used in new work anymore). Updated Creating a user and assigning rights for the new WEBFLEET UI.6.5.7.4. Added useISO8601 to the general parameters (General parameters).3. Added new groups to request limits for driver and event methods.

popQueueMessagesExtern). Removed documentation for showPersonReportExtern and showTrailerReportExtern (their use is still supported but it should not be used in new work anymore). Added Bluetooth address of a paired Remote LINK device (rll_btaddress) to showObjectReportExtern.7.3 2010-12-15 RH v.7. Added parameters to showTripSummaryReportExtern. Clarification on the message classes that can be used for queue creation. Removed documentation for showOrderMessageReportExtern and showStoplistReportExtern (their use is still supported but it should not be used in new work anymore). Added new parameters to updateVehicle. Added event_time to popQueueMessagesExtern.1. Other minor editorial changes.4. Added new method to support inventory of devices: showContracts. Renamed chapters and changed order.7.1 2010-06-17 IM 1. Added new action calcRouteSimpleExtern. Added new JSON objects to surplus_data and new message classes to popQueueMessagesExtern. Added working time information to showDriverReportExtern. Added updateVehicle.Table: Revision history: Revision 1. showObjectAccelerationEvents. Added parameters to showVehicleReportExtern. © 2011 TomTom Business Solutions 7 . Fixed and expanded the source_device enumeration for popQueueMessagesExtern. showStandStills. Updated the user creation guide to point out that full permissions on orders might be necessary for certain methods to succeed. Clarification on the data size for objectno (10 characters).0 Date 2010-05-20 Description Updated the request limit table with new limits for queue access and queue management methods. Removed function geocodeAddressExtern from the Reference document and added geocodeAddress. Author IM 1.7. showIdleExceptions.2 2010-09-02 IM 1. Expanded the list of documented error codes in Appendix A: Operation return codes. Added new result parameter to showWorkingTimes.7. Added parameters to showTripReportExtern. Corrected parameter namin in showDriverReportExtern. Added new data elements for the TomTom Remote LINK (see Drivers. Clarification on the supported devices for deleteOrderExtern. Added new section Trips and working times and new actions showObjectSpeedingEvents.

Extended list of Messages types for popQueueMessagesExtern.4. Extended information about case-sensitivity of inbound parameters of multiple commands. Edited parameter names for showEventReportExtern. Updated parameters list for updateDestinationOrderExtern.Table: Revision history: Revision 1.7.7. Added advise on the use of HTTP authentication in Making HTTP requests.1. Updated result list for showTripSummaryReportExtern. Added limits for calcRouteSimpleExtern to Default request limit configuration. Extended list of Operation response codes. Author RH v. Added description for pin and code for Drivers commands. Added new parameters to showTripReportExtern. © 2011 TomTom Business Solutions 8 .4 Date 2011-02-24 Description Changed description for avg_accel and description of showObjectAccelerationEvents.

tomtomwork.com/webfleet/connect.connect Reference Guide.The programming guide contains a detailed description of how to submit requests to WEBFLEET. • Reference .Welcome 1 Welcome Welcome Welcome to the WEBFLEET.7.1. including an explanation of how to enable access to the service. v. This document provides all the information you need to integrate WEBFLEET into your applications using the WEBFLEET.connect and the data that is returned by the service. The documentation is divided into the following sections: • Programming Guide . © 2011 TomTom Business Solutions 9 . including their parameters and the data returned by these operations.4.The Reference is a detailed description of all available operations.connect interface. Updated versions of this documentation and other resources are available online at www.

how to access the service and how to interpret the output that is returned. For instance. See Orders • Drivers – Insert.connect: • Reports – Retrieve data that correspond to the information contained in the reports generated within WEBFLEET • Messaging – Send text to mobile units and retrieve incoming messages. In order to access the WEBFLEET.Programming Guide 2 Programming Guide Programming Guide This programming guide is an introduction to using the WEBFLEET. See Addresses • Orders – Insert. See Drivers As WEBFLEET.1 Introduction to WEBFLEET.connect WEBFLEET. send. update and delete addresses and address groups as well as relations between addresses and address groups. update and delete orders and retrieve order status information. Please talk to your TomTom WORK sales contact if you do not have access to a WEBFLEET. This affects all elements of the WEBFLEET. access restrictions set up within WEBFLEET apply. v. See Message queues and Orders • Addresses – Insert.connect enabled. 2.connect is an API that allows you to access the WEBFLEET service through a web-enabled application. Otherwise you will not be able to test the integration into your application.connect impersonates as the user that is provided as part of the service request authentication. These are the primary functionalities accessible through WEBFLEET. if the user has the respective access right to do so (for example: ’Edit access’ for ’All addresses’).connect service you need a WEBFLEET account that is WEBFLEET.1.connect interface.7.connect enabled account.connect interface. update and delete drivers and retrieve driver status information. © 2011 TomTom Business Solutions 10 . addresses can only be updated.4.

1. Click New.connect. There should be at least one active object to make full use of the functionality offered by WEBFLEET.2 Preparing for WEBFLEET.2. To create a new user select Users from the More pull down box.Programming Guide 2.Some functions require geographic coordinates such as longitude and latitude.2. Make sure that you are able to provide valid coordinates.1 Registering for WEBFLEET. Once your request got approved. otherwise you won't be able to fully leverage all functionality that WEBFLEET.connect downloads page on the internet to download the activation form. send a completed activation form containing details about the application you want to integrate with WEBFLEET. © 2011 TomTom Business Solutions 11 . Geographic coordinates used by WEBFLEET always refer to the WGS84 coordinate system and have different representations.connect. you must first create a user within your WEBFLEET account and give this user the right to use WEBFLEET.3 Creating a user and assigning rights In order to access WEBFLEET.connect. 2. This includes inserts and updates of addresses and sending orders.connect can be made available to every customer with a valid WEBFLEET account.7. access is granted and you can start using WEBFLEET. To enable an existing WEBFLEET account for WEBFLEET. Visit the WEBFLEET.connect offers.connect 2. 2.connect.2 Checking requirements Geographic coordinates .2. 3. 2.connect WEBFLEET.connect.4. This procedure is outlined below: 1. Login to WEBFLEET as account administrator. v.

Click Ok to save your changes. 9. 10. v. 7. Select a security profile under Profile settings. 8. To assign the necessary rights select the System tab and tick Access to interface WEBFLEET. 5.4.7. 6.If you want to import addresses select the Addresses tab and select Admin access from the pull down box. A good starting point is to use the profile Standard. Start changing user rights by selecting Advanced.1. © 2011 TomTom Business Solutions 12 . Click Save to save your changes. Fill in the required details.Programming Guide 4.connect.

where HTTP is mentioned.connect uses HTTP GET requests as the underlying transport mechanism for requests. © 2011 TomTom Business Solutions 13 . The error message has the following layout: v.webfleet.tomtomwork. Responses are returned as comma-separated values (CSV).extern Therefore the base URL with the https scheme used is: https:// connect.4.Programming Guide 11. 2.connect.tomtomwork. neither Basic nor Digest. All requests are made using specific URLs. therefore.3. WEBFLEET.3 Making requests to WEBFLEET.connect. it is recommended to use HTTPS to access the service via SSL. Do not use HTTP authentication.1 Making HTTP requests This section explains how to use HTTP to issue requests to WEBFLEET. HTTP authentication is not required by the service as username and password are included in the URL of the requests.com • path .connect begins with constant elements for • host .webfleet.com/extern. In order to ensure transmission security. passing parameter names and values as URL parameters.7. The base URL Every HTTP request to WEBFLEET.You can experiment with WEBFLEET.connectspecific HTTP requests by entering the request URL into the browser's address bar and submitting the request. Handling the response In case of an error.connect 2.1. an error message is returned as plain text.Click Ok to save your changes. HTTPS might be used as well.

WEBFLEET.document is empty All methods that transmit data.3. If there is no data to return. If the number of requests executed exceeds this limit.2 Making SOAP requests This section explains how to use SOAP to issue requests to WEBFLEET. All methods that return data. your specific toolkit might need an additional support library to enable proper handling of MTOM. appearing as ’""’. all send . WEBFLEET.if this character is part of the data. Different limits apply for different functional groups and are defined by a maximum number of requests allowed in a certain time period. Quoting character is ’"’ .1. it is required to use HTTPS to access the service via SSL.com. Most SOAP toolkits support the automatic generation of routines and classes based on the WSDL description. WEBFLEET.3 Request limits The number of requests that can be issued is limited.webfleet. it is quoted with ’"’.connect uses the MTOM extension to SOAP in order to provide an optimised transmission of data.connect will return an error message and not process requests again until there where no further requests within in the limit monitoring interval. © 2011 TomTom Business Solutions 14 .7. 2. The message is either in the language defined by the lang parameter or in English if no localised translation is available.connect supports the SOAP message protocol for issuing requests over an HTTPS connection.g. The v. e.Programming Guide id. an error message is returned: 63. The WSDL files describing the operations and the data types are available at https:/ /soap.connect.. 2..ReportExtern return data as quoted comma-separated values with one record per line.4.. Although most modern SOAP toolkits support this extension. The easiest way to use the SOAP interface with your application is to use a SOAP toolkit appropriate for your programming platform. SOAP toolkits are available for most popular languages and platforms. It is therefore advisable to use the column names returned in the first response line to identify the data columns by their name. e. that is the response is empty. return nothing on successful completion. description id is a numeric value and description provides a reason text. In order to ensure transmission security.3.connect..tomtomwork. The ordering of result columns might not always match that of the documentation and is subject to change without notice. methods.g. those with names ending in .

Table 2-1: Default request limit configuration Group address Members • showAddressGroupReportExtern • showAddressGroupAddressReportE xtern • insertAddressExtern • updateAddressExtern • deleteAddressExtern • attachAddressToGroupExtern • detachAddressFromGroupExtern • insertAddressGroupExtern • deleteAddressGroupExtern • geocodeAddressExtern • • • • • • • • • • • information sendOrderExtern sendDestinationOrderExtern updateOrderExtern updateDestinationOrderExtern insertDestinationOrderExtern cancelOrderExtern.7.1.4. © 2011 TomTom Business Solutions 15 .Programming Guide limit for a group applies to the accumulated number of requests for each member of that group.reassignOrderEx tern sendTextMessageExtern deleteOrderExtern clearOrdersExtern clearTextMessagesExtern assignOrderExtern Interval (s) 3600 Limit 900 order 1800 300 • showObjectReportExtern • showOrderReportExtern • showAddressReportExtern • • • • • • • • showDriverReportExtern insertDriverExtern updateDriverExtern deleteDriverExtern insertDriverGroupExtern deleteDriverGroupExtern attachDriverToGroupExtern detachDriverFromGroupExtern 60 6 driver 60 10 events queue access queue management showOrderMessageReportExtern • resolveEventExtern • acknowledgeEventExtern • popQueueMessagesExtern • ackQueueMessagesExtern • createQueueExtern • deleteQueueExtern • showOrderMessageReportExtern 1800 60 86400 60 300 10 10 3 v.

the limit may be reduced at any time without prior notice and eventually if the problems are not fixed within a reasonable amount of time .3. Find the parameters that are required on all requests below: • Authentication parameters • General parameters Find the parameters that are not required but are shared between various requests below: • Date range filter parameters Table 2-2: Authentication parameters Parameter account username password Type string string string Description A valid account name User name within the account that is allowed to access the service Password for the user name v.1. but require a certain period of proper client operation within the limits set above.connect cause too much load on the system.Programming Guide Table 2-1: Default request limit configuration Group showTripRepor tExtern showEventReportExtern lbs Members • showTripReportExtern • showEventReportExtern • calcRouteSimpleExtern Interval (s) 60 60 60 Limit 1 1 10 For requests that are not member of one of the groups above. Should an application using WEBFLEET. © 2011 TomTom Business Solutions 16 .connect might be revoked completely.access to WEBFLEET. there is limit of ten requests per minute per WEBFLEET account.7. 2. Extensions of this limit are available upon request on a case by case basis.connect requests take a variety of parameters.4 Common parameters WEBFLEET.4.

4. The preferred ISO 8601 compliant notation for strings that represent dates which are to be passed to WEBFLEET. Example: 2007-02-02T12:12:12.7.e.1. a semicolon used to as the delimiter for the output columns. action string Specifies the operation to be executed.|. See chapter Reference for a list of available operations and more information. yyyyMMdd'T'hh:mm:ss[(.Programming Guide Table 2-3: General parameters Parameter separator Type positiveInteger Description A delimiter character identifier that indicates the delimiter to be used for the output columns: • 1 . i.a space character • 3 . If set to true.connect is the compact full notation with dashes and colons. See the ISO8601 specification or learn more here.a comma character If no value is specified. The list of available languages is subject to change. Please ask your support contact if you want to use other values than those mentioned here.German • en . optional milli seconds and time zone.500+01:00 useISO8601 boolean v. Expressed as a two-letter language code.a tab character • 2 . This parameter is optional.)S](((+|-)hh:mm)|Z).English Language to be used for output formatting. © 2011 TomTom Business Solutions 17 . lang string Valid values are: • de . all date/time-relevant parameters are expected to be IS8601-formatted and all date/ time result fields will be IS8601-formatted.

07.Programming Guide Table 2-4: Date range filter parameters Parameter range_pattern Type string Description Valid values are: • d0 – Today • d-1 – Yesterday • d-2 – Two days ago • d-3 – Three days ago • d-4 – Four days ago • d-5 – Five days ago • d-6 – Six days ago • w0 – Current week • w-1 – Last week • w-2 – Two weeks ago • w-3 – Three weeks ago • m0 – Current month • m-1 – Last month • m-2 – Two months ago • m-3 – Three months ago • ud – User-defined range Specifies a relative date range for the data to be returned.7. 13. rangefrom_stri ng string Lower bound for a date range (start date). v.2007 23:59:59 • lang = en format: dd/MM/[yy]yy HH:mm:ss examples: 13/07/07 23:42:00. Use of this parameter rules out the usage of rangefrom_string and rangeto_string and vice versa except for range_pattern=ud requires rangefrom_string and rangeto_string to be present.07 23:42:00.MM. 13/07/2007 23:59:59 • lang = nl format: d-M-[yy]yy H:mm:ss examples: 13-7-07 23:42:00.1. © 2011 TomTom Business Solutions 18 . 13-07-2007 23:59:59 rangeto_string string Upper bound for a date range (end date). The required format depends on the value for the lang parameter: • lang = de format: dd.4.07.[yy]yy HH:mm:ss examples: 13.

An object in WEBFLEET always has a certain type (vehicle. Code sample 3-1: Request and Response https://connect. Provides access to object master data and the most recent position information available for each object.1 Objects 3. asset."".1."objecttype"."0" "028". "lastmsgid"."105985957"."Fahrzeug"."Demo 2".1 showObjectReportExtern Description Delivers a list of all objects."0" Parameters showObjectReportExtern requires the following common parameters: • Authentication parameters v.""."107711249". whereas this action lists all objects with type independent properties like number."".).Reference 3 Reference Reference 3."deleted" "026". etc. Object types .tomtomwork."Fahrzeug"."objectclassname".4."desc ription"."Demo 1"."". person."Fahrzeug"."Demo 3".""."objectname".com/extern? account=xxx&username=xxx&password=xxx&lang=de& action=showObjectReportExtern& filterstring=Demo "objectno"."0" "027". name and description.1. © 2011 TomTom Business Solutions 19 .).""."107794499".webfleet. Every type defines special properties. showPersonReportExtern.These properties are listed by special actions (showVehicleReportExtern.7. etc.

© 2011 TomTom Business Solutions 20 . case-sensitive. Display name of an object.1. v.S" E/W in the WGS84 coordinate system. deleted msgtime longitude latitude postext postext_short speed course boolean string string string string string string nonNegativeInteger Compass direction in degrees (0° . Description Identifying number of an object.S" N/S in the WGS84 coordinate system. Possible values are in the range 0 ≤ msgid ≤ 264-1..7. Geographic latitude in the form GGG° MM' SS. Unique within an account.4. Type string string Description An arbitrary pattern that is located in the object data. 360°). Geographic longitude in the form GGG° MM' SS. A name of an object group. ID of the last message received from or sent to this object.Reference • General parameters Table 3-1: Parameters specific to showObjectReportExtern: Parameter filterstring objectgroupname Result Table 3-2: Result for showObjectReportExtern: Parameter objectno objectname objectclassname objecttype description lastmsgid Type string (10) string string string string string mgsid identifies a message and is system wide unique.

© 2011 TomTom Business Solutions 21 .Northwest dest_longitude int dest_text dest_eta dest_isorder dest_addrnr orderno string dateTime Date and time of the estimated time of arrival (eta) as reported from the navigation system.Reference Table 3-2: Result for showObjectReportExtern: Parameter direction Type nonNegativeInteger Description Cardinal and intercardinal compass directions.West 8 . case-sensitive. case-sensitive. v.Southeast 5 . but it might be inaccurate.1. Geographic longitude in the WGS84 coordinate system. • L – last: the GPS position is from the last known good fix. Possible values are: • • • • • • • • quality satellite status string string string GPS signal status indicator. Account-unique driver number. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters.7. • V – warn: a current GPS fix is available.4.Northeast 3 . • 0 – invalid: no GPS fix available or GPS has no meaning for this message. derived from course. Unit of measurement is micro degrees (10-6 grd).South 6 .North 2 . string (20) Account-unique order id. driver codriver string (20) string (20) Account-unique driver number. dest_latitude int Geographic latitude in the WGS84 coordinate system. Maximum capacity is 20 bytes.Southwest 7 . Unit of measurement is micro degrees (10-6 grd). possible values are: • A – ok: a current GPS fix is available with this message. 1 . a current fix is not (yet) available. case sensitive.East 4 .

Parameters showVehicleReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-3: Parameters specific to showVehicleReportExtern: Parameter filterstring objectgroupname Type string string Description An arbitrary pattern that is located in the object data. formatted as six groups of two hexadecimal digits. separated by colons (:).Reference Table 3-2: Result for showObjectReportExtern: Parameter driver_current workstate Type nonNegativeInteger Description Valid values are: • 0 – Unknown • 1 – Free time (PND only) • 2 – Pause (PND and digital tachograph) • 3 – Standby (digital tachograph only) • 4 – Working (PND only) • 5 – Driving (digital tachograph only) • 6 – Other work (digital tachograph only) Valid values are: • 0 – Unknown • 1 – Free time (PND only) • 2 – Pause (PND and digital tachograph) • 3 – Standby (digital tachograph only) • 4 – Working (PND only) • 5 – Driving (digital tachograph only) • 6 – Other work (digital tachograph only) Remote LINK Bluetooth address.4. Example: 00:13:6C:88:26:0B codriver_curre ntworkstate nonNegativeInteger rll_btaddress string (17) 3.7. A name of an object group. The IEEE 802 MAC-48/EUI-48 address of a Bluetooth device.2 showVehicleReportExtern Description Lists all objects of type "Vehicle". © 2011 TomTom Business Solutions 22 .1.1. v.

Possible values are: • 0 . in ml/100 km Fleet based fuel consumption reference value.lpg ep_fueltype string Fuel type determined by ecoPLUS. Unique within an account. Display name of an object.unknown • 1 .Reference Result Table 3-4: Result for showVehicleReportExtern: Parameter objectno objectname licenseplatenumber vehicletype width length height maxweight netweight netload power numaxes identnumber registrationdate vh_avgfuelusa ge ep_avgfuelusa ge fl_avgfuelusag e vh_fueltype Type string (10) string string string string string string string string string string string string string int int int string Vehicle based fuel consumption reference value.diesel • 2 .7.1. in ml/100km. © 2011 TomTom Business Solutions 23 . Possible values are: • 1 .4. v. Vehicle configured fuel type. in ml/100 km ecoPLUS based fuel consumption reference value. case-sensitive.gasoline Description Identifying number of an object.gasoline • 3 .diesel • 2 .

1. separated by colons (:). formatted as six groups of two hexadecimal digits.3 showObjectGroupReportExtern Description Lists all object groups.lpg enginesize ep_btaddress nonNegativeInteger string (17) in ccm ecoPLUS Bluetooth address. © 2011 TomTom Business Solutions 24 .Reference Table 3-4: Result for showVehicleReportExtern: Parameter fl_fueltype Type string Description Fleet based fuel type. Result Table 3-6: Result for showObjectGroupReportExtern: Parameter objectgroupname Type string Description 3. The IEEE 802 MAC-48/EUI-48 address of a Bluetooth device. Parameters showObjectGroupReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-5: Parameters specific to showObjectGroupReportExtern: Parameter filterstring Type string Description An arbitrary pattern that is located in the object data.4 showObjectGroupObjectReportExtern Description v. Example: 00:13:6C:88:26:0B 3.4. Possible values are: • 0 .7.diesel • 2 .1.unknown • 1 .1.gasoline • 3 .

7. Result Table 3-8: Result for showObjectGroupObjectReportExtern: Parameter objectgroupname objectno objectname Type string string (10) string Identifying number of an object.Reference Lists the assignments of objects to object groups. case-sensitive.4. Parameters showObjectGroupObjectReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-7: Parameters specific to showObjectGroupObjectReportExtern: Parameter filterstring Type string Description An arbitrary pattern that is located in the object data.1. Each object can be in no. Parameters showContracts requires the following common parameters: • Authentication parameters • General parameters Table 3-9: Parameters specific to showContracts: Parameter objectno Type string (10) Description Identifying number of an object. Unique within an account. Description 3.1.5 showContracts Description This action shows contract and device data for selected devices. © 2011 TomTom Business Solutions 25 . one or more than one group. Unique within an account. v. case-sensitive. Display name of an object. This parameter is optional.

Example: 2007-12-24T16:00:00+02:00 tariff_name activation_key iccid roaming_enabl ed obu_type obu_serialno obu_osversion obu_appverion pnd_type pnd_serialno pnd_ncversion pnd_appversio n string string string boolean string string string string string string string string SIM card number Description Identifying number of an object.4.1. case-sensitive. Example: 2007-12-24T16:00:00+02:00 end_date dateTime ISO 8601-formatted date and time.Reference Result Table 3-10: Result for showContracts: Parameter objectno contractno begin_date Type string (10) string dateTime ISO 8601-formatted date and time. © 2011 TomTom Business Solutions 26 . Unique within an account. 3. combined representation in the extended format.7.1. Parameters updateVehicle requires the following common parameters: • Authentication parameters v.6 updateVehicle Description This action allows the update of vehicle details. combined representation in the extended format.

case-sensitive.1. This parameter is required.7. valid values are: • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • heavyweight_truck_trailer tanker_truck heavy_truck medium_truck dump_truck pallet_truck concrete_lorry deposit_tipper garbage_truck loader excavator wrecker truck_wrecker multicar street_sweeper tractor heavyweight_truck truck_with_trailer trailer truck_trailer crane bus firetruck ambulance police caddy van multivan car_station_wagon pickup suv taxi car ape vespa bike containership link v. vehicletype string Case-sensitive.Reference • General parameters Table 3-11: Parameters specific to updateVehicle: Parameter objectno Type string (10) Description Identifying number of an object. © 2011 TomTom Business Solutions 27 .4. Unique within an account.

fuelconsumption fueltype float fuel consumption in l/100km. © 2011 TomTom Business Solutions 28 .gasoline • 3 .7.1. max: 300 This parameter is optional. valid values are: • 0 .lpg in kg in kg in kg in kg white grey black ivory red orange yellow green blue netweight maxweight netload maxload numaxles length width height description float float float float nonNegativeInteger nonNegativeInteger nonNegativeInteger nonNegativeInteger string (200) in mm in mm in mm v.4. valid values are: • • • • • • • • • identnumber registrationdate denotation licenseplatenumber speedlimit string (20) string (20) string (20) string (50) float speed limit in km/h.diesel • 2 . string Case-sensitive. max: 100 This parameter is optional.Reference Table 3-11: Parameters specific to updateVehicle: Parameter vehiclecolor Type string Description Case-sensitive.unknown • 1 . min: 0. min: 0.

Unique within an account. This parameter is required.reset 3.2.1. The message is sent asynchronously and therefore a positive result of this operation does not indicate that the message was sent to the object successfully.7.2 sendDestinationOrderExtern Description v.1 sendOrderExtern Description The sendOrderExtern operation allows you to send an order message to an object. This parameter is required. 3.4.Reference Table 3-11: Parameters specific to updateVehicle: Parameter power enginesize reset_fuelavg Type float nonNegativeInteger boolean Description in kW in ccm Reset switch for measured or calculated average fuel consumption. case-sensitive. • 1 .2. Parameters sendOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-12: Parameters specific to sendOrderExtern: Parameter objectno Type string (10) Description Identifying number of an object. ordertext string (500) This parameter is required. case-sensitive. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters.2 Orders 3. Maximum capacity is 20 bytes. orderid string (20) Account-unique order id. © 2011 TomTom Business Solutions 29 .

com/ extern?account=xxx&username=xxx&password=xxx&lang=de&ac tion=sendDestinationOrderExtern&objectno=001&orderid=S1234. e. Therefore you should always provide a time zone definition with orderdate. the destination is given by geographical coordinates (51°21'55. Example for minimal set of parameters Sends a destination order referring to an address that has been created before with insertAddressExtern. Make sure to quote the + as %2B.001AF&ordertext=Test&addrnr=401 Example for ISO-formatted order date Sends a destination order with an scheduled arrival time of 4:30pm on June 5th 2009 in the CEST timezone (Central European Summer Time is 2 hours ahead of UTC). otherwise the timezone specification will not parse correctly and the response will contain an error message.webfleet.com/ extern?account=xxx&username=xxx&password=xxx&lang=de&ac tion=sendDestinationOrderExtern&objectno=001&orderid=S1234.12°23'55.webfleet. 2009-01-20T+01:00 and provide your local time part to ordertime.003AF&ordertext=Test&latitude=51365338&longitude=1 2398799&country=DE&zip=04129&city=Leipzig&street=Maximi lianallee 4 Parameters sendDestinationOrderExtern requires the following common parameters: • Authentication parameters v.com/ extern?account=xxx&username=xxx&password=xxx&lang=de&ac tion=sendDestinationOrderExtern&objectno=001&orderid=S1234. The message is sent asynchronously and therefore a positive result of this operation does not indicate that the message was sent to the object successfully.1. © 2011 TomTom Business Solutions 30 .tomtomwork. Code sample 3-4: Destination with latitude and longitude https://connect.Reference The sendDestinationOrderExtern operation allows you to send an order message together with target coordinates for a navigation system connected to the in-vehicle unit.tomtomwork. you need to take care of specifying the time zone as otherwise UTC will be assumed by definition.2" N .6" E) and a location description is provided for the driver.002AF&ordertext=Test&addrnr=401&useISO8601=true&or derdate=2009-06-05T+02:00&ordertime=16:30:00 Example for destination with latitude and longitude Sends a destination order. Use with ISO8601 date and time formats. If used in conjunction with useISO8601=true.webfleet.g. Code sample 3-3: ISO-formatted order date https://connect.4. The address must be geocoded. Code sample 3-2: Minimal set of parameters https://connect.tomtomwork.7.

7. Type of order. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. This parameter is optional.pickup order • 3 . ordertime time Scheduled time of fulfilment for this order. v. Maximum capacity is 20 bytes. © 2011 TomTom Business Solutions 31 . Valid values are: • 1 .1. orderdate date Scheduled date of fulfilment for this order.delivery order If empty or not present. orderid string (20) Account-unique order id.service order • 2 . ordertext ordertype string (500) nonNegativeInteger This parameter is required. the default is service order. If empty or not present.4. the default is the current day (calculated using the time zone defined on the WEBFLEET account). Unique within an account. case-sensitive. This parameter is optional. This parameter is required.Reference • General parameters Table 3-13: Parameters specific to sendDestinationOrderExtern: Parameter objectno Type string (10) Description Identifying number of an object. the default is 00:00. This parameter is required. This parameter is optional. case-sensitive. If empty or not present.

zip.1. This parameter is optional. This parameter is optional. This parameter is optional.4.that may be proceeded by a +). This parameter is optional. Requires ordertime and orderdate. Case-sensitive. The address must be geo-coded. city. © 2011 TomTom Business Solutions 32 . If addrnr is provided. This parameter is optional. contact string (50) Name of a contact person for this order. 15. This parameter is optional. street) are ignored and replaced by the respective values from the address record identified by addrnr. other parameters describing the destination (longitude.Reference Table 3-13: Parameters specific to sendDestinationOrderExtern: Parameter arrivaltolerance Type nonNegativeInteger Description If there is an active order. Differences between ETA and ordertime are interpreted as follows: • show as standard if: teta < torder • show as warning if: torder < teta < torder+arrivaltolerance • show as alarm if: torder+arrivaltolerance < teta Unit of measurement is minutes. the TomTom GO constantly monitors the ETA and sends notifications messages if the ETA changes significantly. 60 and 120. Must conform to the following format: \+?([\d /\(\)\-])+ (a sequence of numbers and ()/ . addrnr string (10) Use an address identified by addrnr as returned by showAddressReportExtern. Valid values are: 0. notify_enabled boolean If set to 1 enables generation of an event (Events) as soon as the ETA is lower than notify_leadtime.7. v. contacttel string (20) Phone number of the contact person for this order. 30. country. notify_leadtime nonNegativeInteger Time in minutes before arrival at destination at which an event (Events) is generated if notify_enabled is set to 1. latitude.

Unit of measurement is micro degrees (10-6 grd). Maximum capacity is 20 bytes. Street and house number of the destination address. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. This parameter is required. used only for display to the driver. Country of the destination address. used only for display to the driver. See Geographic coordinate conversion on Wikipedia ISO 3166-1 alpha-2 code for the country (capital letters). Unit of measurement is micro degrees (10-6 grd).1. used only for display to the driver.7. used only for display to the driver. case-sensitive. See Geographic coordinate conversion on Wikipedia Geographic latitude in the WGS84 coordinate system. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. City of the destination address. Parameters updateOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-14: Parameters specific to updateOrderExtern: Parameter orderid Type string (20) Description Account-unique order id. Post code of the destination address.3 updateOrderExtern Description Updates an order that was submitted with sendOrderExtern. Transformation from degree.Reference Table 3-13: Parameters specific to sendDestinationOrderExtern: Parameter longitude Type int Description Geographic longitude in the WGS84 coordinate system. latitude int country string (2) zip city street string (7) string (50) string (50) 3. Transformation from degree.2. © 2011 TomTom Business Solutions 33 . v.4.

If empty or not present.4 updateDestinationOrderExtern Description Updates an order that was submitted with sendDestinationOrderExtern or with insertDestinationOrderExtern. the default is 00:00.2. ordertext orderdate string (500) date This parameter is required. 3. © 2011 TomTom Business Solutions 34 . v. If empty or not present. Scheduled date of fulfilment for this order. This parameter is optional. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters.Reference Table 3-14: Parameters specific to updateOrderExtern: Parameter ordertext Type string (500) Description This parameter is required. Parameters updateDestinationOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-15: Parameters specific to updateDestinationOrderExtern: Parameter orderid Type string (20) Description Account-unique order id.1.4. the default is the current day (calculated using the time zone defined on the WEBFLEET account). ordertime time Scheduled time of fulfilment for this order. This parameter is required. This parameter is optional. Maximum capacity is 20 bytes. case-sensitive.7.

Valid values are: 0. © 2011 TomTom Business Solutions 35 . This parameter is optional. 60 and 120. city. 15. contact string (50) Name of a contact person for this order. notify_enabled boolean If set to 1 enables generation of an event (Events) as soon as the ETA is lower than notify_leadtime. contacttel string (20) Phone number of the contact person for this order. The address must be geo-coded. This parameter is optional. This parameter is optional. 30. notify_leadtime nonNegativeInteger Time in minutes before arrival at destination at which an event (Events) is generated if notify_enabled is set to 1. latitude.4. street) are ignored and replaced by the respective values from the address record identified by addrnr. Case-sensitive.that may be proceeded by a +). Must conform to the following format: \+?([\d /\(\)\-])+ (a sequence of numbers and ()/ . addrnr string (10) Use an address identified by addrnr as returned by showAddressReportExtern. This parameter is optional. country. Requires ordertime and orderdate. This parameter is optional. zip. Differences between ETA and ordertime are interpreted as follows: • show as standard if: teta < torder • show as warning if: torder < teta < torder+arrivaltolerance • show as alarm if: torder+arrivaltolerance < teta Unit of measurement is minutes.1. This parameter is optional.7. If addrnr is provided.Reference Table 3-15: Parameters specific to updateDestinationOrderExtern: Parameter arrivaltolerance Type nonNegativeInteger Description If there is an active order. other parameters describing the destination (longitude. v. the TomTom GO constantly monitors the ETA and sends notifications messages if the ETA changes significantly.

Unit of measurement is micro degrees (10-6 grd). Street and house number of the destination address. Transformation from degree. Post code of the destination address. used only for display to the driver.Reference Table 3-15: Parameters specific to updateDestinationOrderExtern: Parameter longitude Type int Description Geographic longitude in the WGS84 coordinate system.4. See Geographic coordinate conversion on Wikipedia Geographic latitude in the WGS84 coordinate system.2.7. used only for display to the driver. Parameters insertDestinationOrderExtern requires the following common parameters: • Authentication parameters v. See Geographic coordinate conversion on Wikipedia ISO 3166-1 alpha-2 code for the country (capital letters). © 2011 TomTom Business Solutions 36 . minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Unit of measurement is micro degrees (10-6 grd). Transformation from degree.5 insertDestinationOrderExtern Description The insertDestinationOrderExtern operation allows you to transmit an order message to WEBFLEET. City of the destination address. The message is not sent and must be manually dispatched to an object within WEBFLEET. Country of the destination address. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. used only for display to the driver. latitude int country string (2) zip city street string (7) string (50) string (50) 3. used only for display to the driver.1.

Requires ordertime and orderdate. ordertext ordertype string (500) nonNegativeInteger This parameter is required. If empty or not present. Maximum capacity is 20 bytes. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. This parameter is optional. 30. Valid values are: 0. the default is service order.7. case-sensitive. Type of order. Valid values are: • 1 . This parameter is required. the default is 00:00. v.service order • 2 .delivery order If empty or not present. orderdate date Scheduled date of fulfilment for this order. © 2011 TomTom Business Solutions 37 . This parameter is optional. This parameter is optional.1.4.pickup order • 3 . Differences between ETA and ordertime are interpreted as follows: • show as standard if: teta < torder • show as warning if: torder < teta < torder+arrivaltolerance • show as alarm if: torder+arrivaltolerance < teta Unit of measurement is minutes. This parameter is optional.Reference • General parameters Table 3-16: Parameters specific to insertDestinationOrderExtern: Parameter orderid Type string (20) Description Account-unique order id. the default is the current day (calculated using the time zone defined on the WEBFLEET account). 60 and 120. If empty or not present. arrivaltolerance nonNegativeInteger If there is an active order. 15. the TomTom GO constantly monitors the ETA and sends notifications messages if the ETA changes significantly. ordertime time Scheduled time of fulfilment for this order.

Post code of the destination address. notify_leadtime nonNegativeInteger Time in minutes before arrival at destination at which an event (Events) is generated if notify_enabled is set to 1. used only for display to the driver. latitude int country string (2) zip string (7) v. This parameter is optional.4. Country of the destination address. street) are ignored and replaced by the respective values from the address record identified by addrnr. used only for display to the driver. country. See Geographic coordinate conversion on Wikipedia Geographic latitude in the WGS84 coordinate system. contact string (50) Name of a contact person for this order. latitude.Reference Table 3-16: Parameters specific to insertDestinationOrderExtern: Parameter notify_enabled Type boolean Description If set to 1 enables generation of an event (Events) as soon as the ETA is lower than notify_leadtime. Unit of measurement is micro degrees (10-6 grd). Transformation from degree.7. This parameter is optional. The address must be geo-coded.that may be proceeded by a +). longitude int Geographic longitude in the WGS84 coordinate system. This parameter is optional. If addrnr is provided. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. contacttel string (20) Phone number of the contact person for this order. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Must conform to the following format: \+?([\d /\(\)\-])+ (a sequence of numbers and ()/ . This parameter is optional. other parameters describing the destination (longitude. See Geographic coordinate conversion on Wikipedia ISO 3166-1 alpha-2 code for the country (capital letters). addrnr string (10) Use an address identified by addrnr as returned by showAddressReportExtern. Transformation from degree. city. © 2011 TomTom Business Solutions 38 . Unit of measurement is micro degrees (10-6 grd). This parameter is optional. Case-sensitive.1. zip.

Parameters cancelOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-17: Parameters specific to cancelOrderExtern: Parameter orderid Type string (20) Description Account-unique order id. 3. © 2011 TomTom Business Solutions 39 . used only for display to the driver. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters.4. 3.7 assignOrderExtern Description Assigns an existing order to an object and can be used to accomplish the following: • send an order that was inserted before using insertDestinationOrderExtern • resend an order that has been rejected or cancelled Parameters assignOrderExtern requires the following common parameters: • Authentication parameters v.2. case-sensitive.7. Maximum capacity is 20 bytes. insertDestinationOrderExtern or sendOrderExtern.Reference Table 3-16: Parameters specific to insertDestinationOrderExtern: Parameter city street Type string (50) string (50) Description City of the destination address.1. used only for display to the driver.2.6 cancelOrderExtern Description Cancels orders that were submitted using one of sendDestinationOrderExtern. Street and house number of the destination address.

This objectno names the object that will receive the order. Maximum capacity is 20 bytes. case-sensitive. This parameter is required.4. This is done by cancelling the order on the old object that is currently assigned to this order and assigning the new object to the order. This parameter is required.8 reassignOrderExtern Description Reassigns an order that was submitted using one of sendDestinationOrderExtern.7. objectid string (10) Identifying number of an object. Required if the order is not linked to an object yet. v. © 2011 TomTom Business Solutions 40 . This parameter is optional. Parameters reassignOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-19: Parameters specific to reassignOrderExtern: Parameter orderid Type string (20) Description Account-unique order id. This parameter is required.1.Reference • General parameters Table 3-18: Parameters specific to assignOrderExtern: Parameter orderid Type string (20) Description Account-unique order id.2. Maximum capacity is 20 bytes. Unique within an account. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. case-sensitive. insertDestinationOrderExtern or sendOrderExtern to another object. This objectid names the object that will receive the order. The order is then sent to the new object. 3. objectno string (10) Identifying number of an object. case-sensitive. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. Unique within an account. case-sensitive.

Reference

3.2.9 deleteOrderExtern
Description Deletes an order from a device and optionally marks it as deleted in WEBFLEET. Supported for the stand-alone TomTom navigation devices connected to WEBFLEET and the TomTom navigation devices connected to LINK 300/310. Parameters deleteOrderExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-20: Parameters specific to deleteOrderExtern: Parameter orderid Type string (20) Description Account-unique order id, case-sensitive. Maximum capacity is 20 bytes, actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. mark_deleted boolean If set to 1, marks the order as deleted within WEBFLEET. Defaults to 0.

3.2.10 clearOrdersExtern
Description Removes all orders from the device and optionally marks them as deleted in WEBFLEET. Parameters clearOrdersExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-21: Parameters specific to clearOrdersExtern: Parameter objectno mark_deleted Type string (10) boolean Description Identifying number of an object. Unique within an account, case sensitive. If set to 1, marks the order as deleted within WEBFLEET. Defaults to 0.

v.1.7.4, © 2011 TomTom Business Solutions

41

Reference

3.2.11 showOrderReportExtern
Description Shows a list of orders that match the search parameters. Each entry shows the order details and current status information. Example - Retrieve all orders for the previous week Uses a range_pattern to access all orders with an orderdate within the last week. Code sample 3-5: Retrieve all orders for the previous week https://connect.webfleet.tomtomwork.com/ extern?account=xxx&username=xxx&password=xxx&lang=de&ac tion=showOrderReportExtern&range_pattern=w-1 Example - Retrieve orders for a specific object and day Uses a user defined (ud) range_pattern with ISO-formatting to access all orders with a specific orderdate assigned to a specific object. Code sample 3-6: Retrieve orders for a specific object and day https://connect.webfleet.tomtomwork.com/ extern?account=xxx&username=xxx&password=xxx&lang=de&ac tion=showOrderReportExtern&objectno=001&useISO8601=true &range_pattern=ud&rangefrom_string=2009-0611T00:00:00&rangeto_string=2009-06-11T23:59:59 Parameters showOrderReportExtern requires the following common parameters: • Authentication parameters • General parameters showOrderReportExtern requires the following other parameters: • Date range filter parameters Table 3-22: Parameters specific to showOrderReportExtern: Parameter objectno Type string (10) Description Identifying number of an object. Unique within an account, case-sensitive. This parameter is optional. objectgroupname string Case-sensitive. This parameter is optional.

v.1.7.4, © 2011 TomTom Business Solutions

42

Reference

Table 3-22: Parameters specific to showOrderReportExtern: Parameter orderid Type string (20) Description Account-unique order id, case-sensitive. Maximum capacity is 20 bytes, actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. This parameter is optional. ordertype nonNegativeInteger Type of order. Valid values are: • 1 - service order • 2 - pickup order • 3 - delivery order This parameter is optional. Result Table 3-23: Result for showOrderReportExtern: Parameter orderdate Type date Description Scheduled date of fulfilment for this order. If empty or not present, the default is the current day (calculated using the time zone defined on the WEBFLEET account). Account-unique order id, case-sensitive. Maximum capacity is 20 bytes, actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. ordertext ordertype string (500) nonNegativeInteger Type of order. Valid values are: • 1 - service order • 2 - pickup order • 3 - delivery order Identifying number of an object. Unique within an account, case-sensitive. Display name of an object. Geographic longitude in the WGS84 coordinate system. Unit of measurement is micro degrees (10-6 grd). Transformation from degree, minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. See Geographic coordinate conversion on Wikipedia

orderid

string (20)

objectno objectname longitude

string (10) string int

v.1.7.4, © 2011 TomTom Business Solutions

43

Rejected • 401 . See Geographic coordinate conversion on Wikipedia orderstate_latit ude int v. Unit of measurement is micro degrees (10-6 grd). © 2011 TomTom Business Solutions 44 .Service order started • 202 .Delivery finished • 245 .Departed from delivery location • 298 .Pick up started • 224 .Finished orderstate_tim e orderstate_lon gitude string int Geographic longitude in the WGS84 coordinate system.Departed from pick up location • 241 .Accepted • 201 .Sent • 101 .Arrived at destination • 203 . Unit of measurement is micro degrees (10-6 grd).Delivery order started • 242 .Arrived at delivery location • 243 .Resumed • 299 .Arrived at pick up location • 223 .Suspended • 301 . Transformation from degree.Delivery started • 244 . See Geographic coordinate conversion on Wikipedia destination orderstate string nonNegativeInteger Valid values are: • 0 .Cancelled • 302 . Transformation from degree. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Received • 102 . Unit of measurement is micro degrees (10-6 grd).Pickup order started • 222 . minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Work finished • 205 .Reference Table 3-23: Result for showOrderReportExtern: Parameter latitude Type int Description Geographic latitude in the WGS84 coordinate system. See Geographic coordinate conversion on Wikipedia Geographic latitude in the WGS84 coordinate system.4. Transformation from degree.Read • 103 .1.Pick up finished • 225 .Work started • 204 .7.Departed from destination • 221 . minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Not yet sent • 100 .

Scheduled time of fulfilment for this order. If empty or not present. case-sensitive.1. Street and house number of the destination address. Scheduled time of fulfilment for this order.3 Text messages 3.7.The message is sent asynchronously and therefore a positive result of this operation does not indicate that the message was sent to the object successfully. Description 3. used only for display to the driver. Possible values are: • 1 – Estimated delay within tolerance. • 2 – Estimated delay above tolerance. Unique within an account. v. Parameters sendTextMessageExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-24: Parameters specific to sendTextMessageExtern: Parameter objectno messagetext Type string (10) string (500) Description Identifying number of an object.1 sendTextMessageExtern Description The sendTextMessageExtern operation allows you to send a text message to an object.4. If empty or not present. the default is 00:00. the default is 00:00.Reference Table 3-23: Result for showOrderReportExtern: Parameter orderstate_pos text planned_arrival _time estimated_arriv al_time arrivaltolerance notify_enabled notify_leadtime delay_warning s Type string time time time boolean nonNegativeInteger nonNegativeInteger Warning state based on planned and estimated arrival time and the arrival time tolerance value.3. © 2011 TomTom Business Solutions 45 .

4. Unique within an account. 3.4.3. Unique within an account. Parameters clearTextMessagesExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-25: Parameters specific to clearTextMessagesExtern: Parameter objectno Type string (10) Description Identifying number of an object.1 showDriverReportExtern Description Lists all drivers.4 Drivers 3.7.2 clearTextMessagesExtern Description Removes all text messages from the device.1. case-sensitive. v. This parameter is required.Reference 3. Parameters showDriverReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-26: Parameters specific to showDriverReportExtern: Parameter filterstring driverno Type string string Description An arbitrary pattern that is located in the object data. © 2011 TomTom Business Solutions 46 . Search for the specified driver number. Identifying number of a driver.

Identifies the driver currently signed on to this object.4. To be used for all devices except TomTom LINK (calssic) and TomTom GO 715. objectno v. © 2011 TomTom Business Solutions 47 . Description Account-unique driver number. Remote LINK/ID key identifier Type string (20) string (50) string (50) string (50) string (2) string (10) string (250) string (250) string (50) string (50) string (50) ISO 3166-1 alpha-2 code for the country (capital letters). Identifying number of an object.1. Example: 2007-12-24T16:00:00Z The time when the driver signed on to this object.7. signontime dateTime ISO 8601-formatted date and time in the UTC timezone. ISO 3166-1 alpha-2 code for the country (capital letters). case-sensitive. case sensitive. Unique within an account. Unique within one account. dt_cardid dt_cardcountry rll_buttonid string (16) string (2) string (16) A driver card id as used with the digital tachograph. combined representation in the extended format.Reference Result Table 3-27: Result for showDriverReportExtern: Parameter driverno name1 name2 name3 state zip city street telmobile telprivate email description company code string (250) nonNegativeInteger (50) ([19]\d*) string (10) Identifying number used for driver identification.

Co-Driver Valid values are: • • • • • • • 0 . combined representation in the extended format.Pause (PND and digital tachograph) 3 .Unknown 1 . Example: 2007-12-24T16:00:00Z current_workin gtimeend dateTime ISO 8601-formatted date and time in the UTC timezone.Working (PND only) 5 . Accumulated working time if current_workstate indicates a non-working state.Other work (digital tachograph only) current_workst ate nonNegativeInteger current_workin gtimestart dateTime ISO 8601-formatted date and time in the UTC timezone.1. Example: PT362S represents a duration of 362 seconds. case-sensitive. 3.Free time (PND only) 2 .7.2 insertDriverExtern Parameters insertDriverExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-28: Parameters specific to insertDriverExtern: Parameter driverno Type string (20) Description Account-unique driver number.4.4.Driver • 2 .Reference Table 3-27: Result for showDriverReportExtern: Parameter signonrole Type nonNegativeInteger Description Valid values are: • 1 . combined representation in the extended format. © 2011 TomTom Business Solutions 48 . v. name string (50) This parameter is required. as does PT6M2S. Example: 2007-12-24T16:00:00Z current_workin gtime duration ISO 8601-formatted duration.Standby (digital tachograph only) 4 .Driving (digital tachograph only) 6 . This parameter is required.

provide an empty parameter • to assign a new ID key. This parameter is optional. first remove the old assignment • if the parameter is not part of the request. This parameter is optional. Usage details: • the ID key provided must be 'available'. dt_cardcountry string (2) ISO 3166-1 alpha-2 code for the country (capital letters). not assigned to any other driver • to remove the ID key assignment.7.Reference Table 3-28: Parameters specific to insertDriverExtern: Parameter company code Type string (250) nonNegativeInteger (50) ([19]\d*) string (4000) string (2) string (10) string (250) string (250) string (50) string (50) nonNegativeInteger (20) ([19]\d*) string (50) string (16) A driver card id as used with the digital tachograph. Identifying number used for driver identification. the current assignment is left unchanged This parameter is optional. that is. rll_buttonid string (16) Remote LINK/ID key identifier. This parameter is required. Unique within one account. To be used for TomTom LINK (calssic) and TomTom GO 715. To be used for all devices except TomTom LINK (calssic) and TomTom GO 715.4. Description description country zip city street telmobile telprivate pin email dt_cardid v. This parameter is required. ISO 3166-1 alpha-2 code for the country (capital letters). © 2011 TomTom Business Solutions 49 . Identifying number used for driver identification.1.

This parameter is required.4. Identifying number used for driver identification. Unique within one account. © 2011 TomTom Business Solutions 50 . This parameter is optional. case-sensitive. To be used for TomTom LINK (calssic) and TomTom GO 715. This parameter is optional. dt_cardcountry string (2) ISO 3166-1 alpha-2 code for the country (capital letters).Reference 3. This parameter is required. description country zip city street telmobile telprivate pin email dt_cardid v. Identifying number used for driver identification.1. ISO 3166-1 alpha-2 code for the country (capital letters). This parameter is required.4.7. name company code string (50) string (250) nonNegativeInteger (50) ([19]\d*) string (4000) string (2) string (10) string (250) string (250) string (50) string (50) nonNegativeInteger (20) ([19]\d*) string (50) string (16) A driver card id as used with the digital tachograph. To be used for all devices except TomTom LINK (calssic) and TomTom GO 715. This parameter is required.3 updateDriverExtern Parameters updateDriverExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-29: Parameters specific to updateDriverExtern: Parameter driverno Type string (20) Description Account-unique driver number.

5.4 deleteDriverExtern Parameters deleteDriverExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-30: Parameters specific to deleteDriverExtern: Parameter driverno Type string (20) Description Account-unique driver number. provide an empty parameter • to assign a new ID key. © 2011 TomTom Business Solutions 51 . 3.7. case-sensitive. driverno_old string (20) Account-unique driver number.5 Addresses 3. 3. This parameter is required.1. that is.4.Reference Table 3-29: Parameters specific to updateDriverExtern: Parameter rll_buttonid Type string (16) Description Remote LINK/ID key identifier Usage details: • the ID key provided must be 'available'. first remove the old assignment • if the parameter is not part of the request. case-sensitive.1 showAddressReportExtern Parameters showAddressReportExtern requires the following common parameters: • Authentication parameters v. the current assignment is left unchanged This parameter is optional. not assigned to any other driver • to remove the ID key assignment.4. This parameter is required.

© 2011 TomTom Business Solutions 52 .7.4. Description Identifying number of an address.1.Reference • General parameters Table 3-31: Parameters specific to showAddressReportExtern: Parameter filterstring addressgroupname Result Table 3-32: Result for showAddressReportExtern: Parameter addrnr addrname1 addrname2 addrname3 addrstate addrzip addrcity addstreet addrinfo addrregion contact teloffice telmobile telprivate fax mailaddr latitude longitude location Type string (10) string string string string (2) string string string string string string string string string string string string string string Geographic latitude in the form GGG° MM' SS. A name of an address group.S" N/S in the WGS84 coordinate system. ISO 3166-1 alpha-2 code for the country (capital letters). Geographic longitude in the form GGG° MM' SS. v. Unique within an account. Type string string Description An arbitrary pattern that is located in the object data.S" E/W in the WGS84 coordinate system.

7.4.Reference Table 3-32: Result for showAddressReportExtern: Parameter radius Type int Description Describes the perimeter around the address's location within that object locations are associated with this address. © 2011 TomTom Business Solutions 53 . If set to 1.2 showAddressGroupReportExtern Parameters showAddressGroupReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-33: Parameters specific to showAddressGroupReportExtern: Parameter filterstring Type string Description An arbitrary pattern that is located in the object data. Result Table 3-34: Result for showAddressGroupReportExtern: Parameter addressgroupname Type string Description v. the address will be shown on the map. • • • • • • • • • • • • • • • • brightblue dullorange brightorange brightpalegreen grassgreen brightpurple darkred dullazure deeppurple brightazure orangehighlight brightgreen brightorangehighlight khaki paleblue turquoise visible color boolean string 3.1. Controls visibility of this address on the map.5.

Description 3. case-sensitive.4.4 insertAddressExtern Description Inserts an address record.7. Result Table 3-36: Result for showAddressGroupAddressReportExtern: Parameter addressgroupname addrnr Type string string (10) Identifying number of an address. © 2011 TomTom Business Solutions 54 .5.Reference 3. The relationship between addresses and address groups is of m:n cardinality.3 showAddressGroupAddressReportExtern Description Shows a list with all associations between addresses and address groups. but must not necessarily belong to a group. v. Parameters showAddressGroupAddressReportExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-35: Parameters specific to showAddressGroupAddressReportExtern: Parameter filterstring Type string Description An arbitrary pattern that is located in the object data.5. Unique within an account. Unique within an account.1. Parameters insertAddressExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-37: Parameters specific to insertAddressExtern: Parameter addrnr Type string (10) Description Identifying number of an address. Each address can be in more than one address group.

district or federal state this locality belongs to. the address will be shown on the map.7. Name (or abbreviation) of the county. positionx int visible boolean v. Description addrinfo location positiony string (1000) string (1000) int Geographic latitude in the WGS84 coordinate system.1. See (Geographic coordinate conversion on Wikipedia) Controls visibility of this address on the map. © 2011 TomTom Business Solutions 55 . Transformation from degree. Unit of measurement is micro degrees (10-6 grd). minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Reference Table 3-37: Parameters specific to insertAddressExtern: Parameter addrname1 addrname2 addrname3 addrstreet addrzip addrcity addrcountry addrregion contact teloffice telmobile telprivate fax mailaddr radius Type string (50) string (50) string (50) string (50) string (10) string (50) string (2) string string (50) string (20) string (20) string (20) string (20) string (254) int Describes the perimeter around the address's location within that object locations are associated with this address. ISO 3166-1 alpha-2 code for the country (capital letters). minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. See (Geographic coordinate conversion on Wikipedia) Geographic longitude in the WGS84 coordinate system.4. Transformation from degree. If set to 1. Unit of measurement is micro degrees (10-6 grd).

Unique within an account. © 2011 TomTom Business Solutions 56 .7. Unique within an account. The address will be automatically associated with this group.4.Reference Table 3-37: Parameters specific to insertAddressExtern: Parameter color Type string Description Case-sensitive. valid values are: • • • • • • • • • • • • • • • • addrgrpname string (30) brightblue dullorange brightorange brightpalegreen grassgreen brightpurple darkred dullazure deeppurple brightazure orangehighlight brightgreen brightorangehighlight khaki paleblue turquoise Name of an address group.5 updateAddressExtern Description Updates an existing address record. 3. case-sensitive. v.1. Parameters updateAddressExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-38: Parameters specific to updateAddressExtern: Parameter addrnr addrname1 addrname2 addrname3 addrstreet Type string (10) string (50) string (50) string (50) string (50) Description Identifying number of an address.5. This parameter is optional.

See (Geographic coordinate conversion on Wikipedia) Controls visibility of this address on the map. the address will be shown on the map.4. Description addrinfo location positiony string (1000) string (1000) int Geographic latitude in the WGS84 coordinate system. Transformation from degree. Unit of measurement is micro degrees (10-6 grd). See (Geographic coordinate conversion on Wikipedia) Geographic longitude in the WGS84 coordinate system. Unit of measurement is micro degrees (10-6 grd). positionx int visible boolean v. district or federal state this locality belongs to. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Reference Table 3-38: Parameters specific to updateAddressExtern: Parameter addrzip addrcity addrcountry addrregion contact teloffice telmobile telprivate fax mailaddr radius Type string (10) string (50) string (2) string string (50) string (20) string (20) string (20) string (20) string (254) int Describes the perimeter around the address's location within that object locations are associated with this address. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Name (or abbreviation) of the county. Transformation from degree.7. If set to 1. ISO 3166-1 alpha-2 code for the country (capital letters). © 2011 TomTom Business Solutions 57 .1.

© 2011 TomTom Business Solutions 58 . 3.7 attachAddressToGroupExtern Parameters attachAddressToGroupExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-40: Parameters specific to attachAddressToGroupExtern: Parameter addrnr Type string (10) Description Identifying number of an address. valid values are: • • • • • • • • • • • • • • • • brightblue dullorange brightorange brightpalegreen grassgreen brightpurple darkred dullazure deeppurple brightazure orangehighlight brightgreen brightorangehighlight khaki paleblue turquoise 3.6 deleteAddressExtern Parameters deleteAddressExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-39: Parameters specific to deleteAddressExtern: Parameter addrnr Type string (10) Description Identifying number of an address.5.1.4.7. Unique within an account. v.Reference Table 3-38: Parameters specific to updateAddressExtern: Parameter color Type string Description Case-sensitive.5. Unique within an account.

Reference Table 3-40: Parameters specific to attachAddressToGroupExtern: Parameter addrgrpname Type string (30) Description Name of an address group. Name of an address group.5. 3. 3.8 detachAddressFromGroupExtern Parameters detachAddressFromGroupExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-41: Parameters specific to detachAddressFromGroupExtern: Parameter addrnr addrgrpname Type string (10) string (30) Description Identifying number of an address. Unique within an account.10 deleteAddressGroupExtern Parameters deleteAddressGroupExtern requires the following common parameters: • Authentication parameters v.1.5.4. case-sensitive. case-sensitive.7. Unique within an account. case-sensitive. Unique within an account.5. Unique within an account.9 insertAddressGroupExtern Parameters insertAddressGroupExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-42: Parameters specific to insertAddressGroupExtern: Parameter addrgrpname Type string (30) Description Name of an address group. 3. © 2011 TomTom Business Solutions 59 .

Valid values are: • 0 . This parameter is optional.Notice/Information 2 .Alarm 1 4 .Message 1 . resolved boolean Flags a resolved event.Reference • General parameters Table 3-43: Parameters specific to deleteAddressGroupExtern: Parameter addrgrpname Type string (30) Description Name of an address group.1. Parameters showEventReportExtern requires the following common parameters: • Authentication parameters • General parameters showEventReportExtern requires the following other parameters: • Date range filter parameters Table 3-44: Parameters specific to showEventReportExtern: Parameter objectno Type string (10) Description Identifying number of an object.Resolved This parameter is optional. Unique within an account. 3.6 Events 3.Alarm 3 This parameter is optional. © 2011 TomTom Business Solutions 60 .4. case-sensitive. eventlevel_cur nonNegativeInteger Event level.6. v. Unique within an account.Warning 3 . case-sensitive. Valid values are: • • • • • • 0 .Unresolved • 1 .1 showEventReportExtern Description Provides a list of event notifications.7.Alarm 2 5 .

4.7.1. Identifies the user who acknowledged this event.Alarm The current event level for this event. alarmlevel eventlevel_cur string string Event level. Geographic latitude in the form GGG° MM' SS. Identifying number of an object. Result Table 3-45: Result for showEventReportExtern: Parameter eventid msgtime eventtime objectno msgtext postext latitude longitude restime acktime eventlevel Type string string string string (10) string string string string string string string Event level. Geographic longitude in the form GGG° MM' SS.Warning • A .Acknowledged This parameter is optional.Reference Table 3-44: Parameters specific to showEventReportExtern: Parameter acknowledged Type boolean Description Flags an acknowledged event.Information • W . Valued values are: • I .S" N/S in the WGS84 coordinate system.Alarm The original event level this event had when it was created. case sensitive. resuser ackuser string string Identifies the user who resolved this event.Information • W .Warning • A .Unacknowledged • 1 . Unique within an account. © 2011 TomTom Business Solutions 61 . Description v. Valid values are: • 0 . Valid values are: • I .S" E/W in the WGS84 coordinate system.

© 2011 TomTom Business Solutions 62 .Reference 3. Parameters acknowledgeEventExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-46: Parameters specific to acknowledgeEventExtern: Parameter eventid Type nonNegativeInteger Description 3.7 Trips and working times 3.6.6.3 resolveEventExtern Description Flags an event below an alarmed level as resolved.7.1 showTripReportExtern Description Provides as list of trips of an object. Usage patterns v.2 acknowledgeEventExtern Description Flags an event at an alarmed level as acknowledged.1.7.4. The event level will be set to the next lower level. Parameters resolveEventExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-47: Parameters specific to resolveEventExtern: Parameter eventid Type string Description 3.

Due to this behaviour.4. store the highest tripid and provide this as a parameter to the next call. trip records sent late due to unavailable GPRS coverage might be missed).The recommended frequency of calls depends on the distribution of trip reports over any specific period of time as well as business requirements.Reference showTripReportExtern supports two alternative usages patterns for different application integration scenarios: • continuous replication of trip records into a local application. Parameters showTripReportExtern requires the following common parameters: • Authentication parameters v. Continuous replication is therefore the recommended method of retrieving trip records in near real-time. that is. an objectno must be provided to constrain the result set. the replication is done by referring to a tripid retrieved from a previous call to showTripReportExtern. daily calls to showTripReportExtern (for example. a periodic call of showTripReportExtern can be used to retrieve all new trip records received since the last call. Each trip record is identified by a tripid that is strictly (monotonically) increasing. all parameters are checked for invalid combinations and an error message is returned if an unacceptable parameter combination is detected. a date range filter (Date range filter parameters) compliant to more restrictions (see below) must be present. Continuous replication If your application requires access to all or specific trip records. there is no guarantee that all trips can be consistently downloaded by e. must have been returned by previous calls to showTripReportExtern.g. • The time period covered by date range filter (Date range filter parameters) may not be greater than 1 year. use a one-time download covering a small time period. While processing the downloaded results of a call to showTripReportExtern. • one-time (or on demand) download of trip records created within a variable time period using a date range filter (Date range filter parameters). For both usage patterns. not the date/time when the trip record was created. In order to retrieve an initial value for tripid. Date range filter behaviour The date range filter applies to the trip start date/time. • If no tripid is provided. • If tripid is provided. • If the time period covered by date range filter (Date range filter parameters) is greater than 1 month (and less than or equal to 1 year). either all trip records or a subset of trip records for a specific object (selected by providing filter conditions) can be downloaded.7. The date range filter applies to the start time of a trip. Parameter restrictions Before processing a request.1. © 2011 TomTom Business Solutions 63 . but should not be more frequent than one call every 15 minutes. it must be valid.

Unknown trip type 1 . This parameter is optional.Business trip 3 .Reference • General parameters showTripReportExtern requires the following other parameters: • Date range filter parameters Table 3-48: Parameters specific to showTripReportExtern: Parameter objectno Type string (10) Description Identifying number of an object. case-sensitive. drivergroupname string Name of the group of drivers the driver is assigned to. case-sensitive. The odometer reading when this event started. Result Table 3-49: Result for showTripReportExtern: Parameter tripid tripmode Type string nonNegativeInteger Possible values are: • • • • • 0 . case-sensitive. case-sensitive. A detailed textual description of the location where this event started. Identifying number of a driver.Way-to-work trip 4 . This parameter is optional. v. This parameter is optional.4.7. The time recorded when this event started.Private trip 2 . This parameter is optional.Correction trip (user changed the odometer value manually) Description objectno objectname start_time start_odometer start_postext string (10) string string string string Identifying number of an object. Display name of an object. © 2011 TomTom Business Solutions 64 . tripid driverno nonNegativeInteger string This parameter is optional. Unique within an account. Unique within an account. Unique within an account. objectgroupname string Name of the group of objects the object is assigned to. case-sensitive.1.

Description The time recorded when this event ended. © 2011 TomTom Business Solutions 65 . Unit of measurement is ’second’. The odometer reading when this event ended. max. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Transformation from degree. Geographic longitude in the WGS84 coordinate system. A detailed textual description of the location where this event ended. start_latitude int start_formatted _longitude start_formatted _latitude end_longitude string string int v. Geographic latitude in the form GGG° MM' SS. Transformation from degree. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Unit of measurement is micro degrees (10-6 grd). See (Geographic coordinate conversion on Wikipedia) The difference between start_odometer and end_odometer. Unit of measurement is micro degrees (10-6 grd). minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.1.7. Geographic longitude in the WGS84 coordinate system. The difference between start_time and end_time. Unit of measurement is '’meter’.S" N/S in the WGS84 coordinate system. Unit of measurement is micro degrees (10-6 grd). See (Geographic coordinate conversion on Wikipedia) Geographic latitude in the WGS84 coordinate system.Reference Table 3-49: Result for showTripReportExtern: Parameter end_time end_odometer end_postext duration idle_time distance avg_speed max_speed fuel_usage start_longitude Type string string string string start string string string float int Fuel consumption in litres. See (Geographic coordinate conversion on Wikipedia) Geographic longitude in the form GGG° MM' SS.S" E/W in the WGS84coordinate system. Transformation from degree.4. three decimals allowed.

Identifying number of an address. end_formatted _longitude end_formatted _latitude driverno drivername start_addrno end_addrno fueltype string string string string co2 ep_distance string int 3.Reference Table 3-49: Result for showTripReportExtern: Parameter end_latitude Type int Description Geographic latitude in the WGS84 coordinate system. Identifying number of an address.S" E/W in the WGS84 coordinate system. Identifying number of a driver. Unique within an account.2 showTripSummaryReportExtern Parameters showTripSummaryReportExtern requires the following common parameters: • Authentication parameters • General parameters showTripSummaryReportExtern requires the following other parameters: • Date range filter parameters Table 3-50: Parameters specific to showTripSummaryReportExtern: Parameter objectno Type string (10) Description Identifying number of an object.1. Distance measured by ecoPLUS in meters.diesel • 2 .4.7.S" N/S in the WGS84 coordinate system. v. case-sensitive.lpg Carbon dioxide emissions in grams. Unique within an account.gasoline • 3 .7. See (Geographic coordinate conversion on Wikipedia) Geographic longitude in the form GGG° MM' SS. © 2011 TomTom Business Solutions 66 . Unique within an account. Geographic latitude in the form GGG° MM' SS. string Possible values are: • 0 . Display name of a driver.unknown • 1 . Unit of measurement is micro degrees (10-6 grd). minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Unique within an account. Transformation from degree.

A detailed textual description of the location where this event ended. The difference between start_odometer and end_odometer. case-sensitive. Display name of an object.1. The odometer reading when this event started. Unit of measurement is ’meter’. Description Identifying number of an object. © 2011 TomTom Business Solutions 67 . The odometer reading when this event ended.Reference Result Table 3-51: Result for showTripSummaryReportExtern: Parameter objectno objectname start_time start_odometer end_time end_odometer end_postext distance triptime operatingtime standstill tours fuel_usage Type string (10) string string string string string string string string string string string float Fuel consumption in litres. Unique within an account. v. max.3 showLogbookReportExtern Parameters showLogbookReportExtern requires the following common parameters: • Authentication parameters • General parameters showLogbookReportExtern requires the following other parameters: • Date range filter parameters Table 3-52: Parameters specific to showLogbookReportExtern: Parameter objectno Type string (10) Description Identifying number of an object.7.4. The time recorded when this event ended. The time recorded when this event started.7. case-sensitive. Unique within an account. 3. three decimals allowed.

Identifying number of an object. all parameters are checked for invalid combinations and an error message is returned if an unacceptable parameter combination is detected. this is typically at the visited party.1.Reference Result Table 3-53: Result for showLogbookReportExtern: Parameter tripid objectno objectname logflag start_time start_odometer start_postext end_time end_odometer end_postext distance logpurpose logcontact logcomment Type string string (10) string string string string string string string string string string string string The time recorded when this event started. A detailed textual description of the location where this event ended. Any additional annotation for this trip. The difference between start_odometer and end_odometer.7. Parameter restrictions This method only supports ISO8601-formatted date/time values in parameters and result set. A detailed textual description of the location where this event started. © 2011 TomTom Business Solutions 68 . The odometer reading when this event ended. The time recorded when this event ended.4. Display name of an object. case-sensitive. Before processing a request. Unique within an account. Contact details for this trip. • The time period covered by date range filter (Date range filter parameters) may not be greater than 1 month.7.4 showWorkingTimes Description This report shows work time states changes of the (co)driver. The odometer reading when this event started. Unit of measurement is ’meter’. v. A description of the purpose. • At least one of the filter parameters objectno or driverno must be provided. Description 3. the locations and vehicle.

Co-Driver Identifying number of an object. The time recorded when this event started. This parameter is required. A detailed textual description of the location where this event started.Driver • 2 . Valid values are: • 1 . Identifying number of an address. Unique within an account. © 2011 TomTom Business Solutions 69 .1. Display name of a driver. case-sensitive.7.Reference Parameters showWorkingTimes requires the following common parameters: • Authentication parameters • General parameters showWorkingTimes requires the following other parameters: • Date range filter parameters Table 3-54: Parameters specific to showWorkingTimes: Parameter objectno Type string (10) Description Identifying number of an object. case-sensitive. The odometer reading when this event started. driverno string Identifying number of a driver. Display name of an object. Unique within an account. This parameter is required. case-sensitive. Unique within an account. Unique within an account. Unique within an account. Result Table 3-55: Result for showWorkingTimes: Parameter driverno drivername role Type string string nonNegativeInteger string (10) string string string string Description Identifying number of a driver. objectno objectname start_time start_odometer start_postext start_addrno v.4.

minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.Free time (PND only) • 2 . case-sensitive. Unit of measurement is micro degrees (10-6 grd). Unique within an account. A detailed textual description of the location where this event ended. Unit of measurement is micro degrees (10-6 grd).1. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Unique within an account. Transformation from degree.Other work (digital tachograph only) Identifying number of an object. Unit of measurement is micro degrees (10-6 grd). © 2011 TomTom Business Solutions 70 . Unit of measurement is micro degrees (10-6 grd).7. Transformation from degree.Driving (digital tachograph only) • 6 .Working (PND only) • 5 .Pause (PND and digital tachograph) • 3 . See Geographic coordinate conversion on Wikipedia Valid values are: • 0 .Standby (digital tachograph only) • 4 . Transformation from degree. See Geographic coordinate conversion on Wikipedia Geographic longitude in the WGS84 coordinate system. Identifying number of an address.Unknown • 1 . See Geographic coordinate conversion on Wikipedia The time recorded when this event ended. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. See Geographic coordinate conversion on Wikipedia Geographic longitude in the WGS84 coordinate system. Transformation from degree.Reference Table 3-55: Result for showWorkingTimes: Parameter start_latitude Type int Description Geographic latitude in the WGS84 coordinate system.4. The odometer reading when this event ended. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. int Geographic latitude in the WGS84 coordinate system. start_longitude int end_time end_odometer end_postext end_addrno end_latitude string string string end_longitude int workstate nonNegativeInteger end_objectno end_objectnam e string (10) string v.

4.7.Reference Table 3-55: Result for showWorkingTimes: Parameter externaldevicetimeoffset Type string Description The offset in system time between external device (currently only digital tachograph) and LINK. This parameter is required. combined representation in the extended format. ISO 8601-formatted date and time. 3. Unit of measurement is ’second’.5 showStandStills Description This actions shows a list of all stops for a certain vehicle for a specified period. Unique within an account.7. ISO 8601-formatted date and time. Example: 2007-12-24T16:00:00+02:00 duration string The difference between start_time and end_time. combined representation in the extended format. © 2011 TomTom Business Solutions 71 . Example: 2007-12-24T16:00:00+02:00 end_time string The time recorded when this event ended.1. case-sensitive. Result Table 3-57: Result for showStandStills: Parameter start_time Type string Description The time recorded when this event started. see Date range filter parameters Table 3-56: Parameters specific to showStandStills: Parameter objectno Type string (10) Description Identifying number of an object. in seconds. Parameters showStandStills requires the following common parameters: • Authentication parameters • General parameters showStandStills requires the following other parameters: • range_pattern. v.

lpg Type string string string string Description Geographic latitude in the form GGG° MM' SS.6 showIdleExceptions Description This report shows a list of idle exceptions detected by the LINK or ecoPLUS of an object or of all objects of a object group. Fuel consumption in litres. © 2011 TomTom Business Solutions 72 . The report shows all idle exceptions that have ended within the period defined with the start_time and end_time.S" E/W in the WGS84 coordinate system. Carbon dioxide emissions in grams. Unique within an account. • As historical data is available for 90 days only a historical time period covered by date range filter (Date range filter parameters) may not start earlier than 90 days in the past. Unique within an account.unknown • 1 . • A future time period covered by date range (Date range filter parameters) may not start in the future. v.S" N/S in the WGS84 coordinate system.S" N/S in the WGS84 coordinate system. Possible values are: • 0 .7. Identifying number of an address. case-sensitive. Geographic longitude in the form GGG° MM' SS. three decimals allowed.7. max. all parameters are checked for invalid combinations and an error message is returned if an unacceptable parameter combination is detected.gasoline • 3 . Geographic latitude in the form GGG° MM' SS.Reference Table 3-57: Result for showStandStills: Parameter latitude longitude formatted_latit ude formatted_long itude addrno postext objectno fuel_usage co2 fueltype string string (10) float string string Identifying number of an object. Parameter restrictions Before processing a request.diesel • 2 .S" E/W in the WGS84 coordinate system. 3.4.1. Geographic longitude in the form GGG° MM' SS. An idle event occurs when an object is still for more than five minutes with engine running.

This parameter is required. This parameter is optional. the time period covered by date range filter (Date range filter parameters) may not be greater than 1 month. The start time of the idle exception can be outside this range. Display name of an object.S" N/S in the WGS84 coordinate system. Geographic longitude in the form GGG° MM' SS.S" N/S in the WGS84 coordinate system. Duration of idle exception interval in seconds.4.S" E/W in the WGS84 coordinate system. The time recorded when this event ended. Unique within an account. Parameters showIdleExceptions requires the following common parameters: • Authentication parameters • General parameters showIdleExceptions requires the following other parameters: • Date range filter parameters Table 3-58: Parameters specific to showIdleExceptions: Parameter objectno Type string (10) Description Identifying number of an object. The time recorded when this event started. the time period covered by date range filter (Date range filter parameters) may not be greater than 1 day. Geographic latitude in the form GGG° MM' SS. • If an object group is specified.Reference • If no object is specified. objectgroupname Result Table 3-59: Result for showIdleExceptions: Parameter objectno objectname start_time end_time idle_duration latitude longitude formatted_latit ude Type string (10) string string string int string string string Description Identifying number of an object. case-sensitive. v. Unique within an account.1.7. Geographic latitude in the form GGG° MM' SS. the time period covered by date range filter (Date range filter parameters) may not be greater than 1 day. © 2011 TomTom Business Solutions 73 . string Case-sensitive. case-sensitive. • If an object is specified. Note: Only those idle exceptions are reported that end in the requested date and time range.

Unique within an account.4. © 2011 TomTom Business Solutions 74 . Unique within an account.7.8.Reference Table 3-59: Result for showIdleExceptions: Parameter formatted_long itude addrno postext fuel_usage co2 fueltype string float int string Fuel consumption in litres. three decimals allowed. max. 3. Identifying number of an address.S" E/W in the WGS84 coordinate system. case-sensitive. Carbon dioxide emissions in grams.unknown • 1 .1 showIOReportExtern Parameters showIOReportExtern requires the following common parameters: • Authentication parameters • General parameters showIOReportExtern requires the following other parameters: • Date range filter parameters Table 3-60: Parameters specific to showIOReportExtern: Parameter objectno iofilter Type string (10) string Description Identifying number of an object. v.gasoline • 3 .1. Possible values are: • 0 .lpg Type string Description Geographic longitude in the form GGG° MM' SS.8 Miscellaneous reports 3.diesel • 2 .

two to four seconds for a sharp turn. Unit of measurement is ’meter’. case-sensitive. actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters.2 showObjectAccelerationEvents Description This action shows unwanted driver behaviour.7. The odometer reading when this event ended. The time recorded when this event started. 3. A detailed textual description of the location where this event started. e. Unit of measurement is ’second’. based on a threshold defined by the user.4. A detailed textual description of the location where this event ended. breaking or cornering. © 2011 TomTom Business Solutions 75 . The difference between start_time and end_time. These events only cover short time periods. Parameters showObjectAccelerationEvents requires the following common parameters: • Authentication parameters • General parameters showObjectAccelerationEvents requires the following other parameters: v. The odometer reading when this event started.g. Unique within an account.1. objectname start_time start_odometer start_postext end_time end_odometer end_postext reference distance duration string string string string string string string string string string Display name of an object. Maximum capacity is 40 bytes. The time recorded when this event ended. The difference between start_odometer and end_odometer. Name of the input or output channel.Reference Result Table 3-61: Result for showIOReportExtern: Parameter objectno Type string (10) Description Identifying number of an object. It shows a list of events with information on excessive acceleration.8.

• ≤ 449 . Acceleration in milli-g.medium severity • 650 to 749 . © 2011 TomTom Business Solutions 76 .very high severity The result may not include average acceleration in the very low severity range. case-sensitive. in km/h.7. ISO 8601-formatted date and time. combined representation in the extended format. in km/h. Unique within an account. Display name of an object. combined representation in the extended format. This parameter is optional. Result Table 3-63: Result for showObjectAccelerationEvents: Parameter objectno objectname start_time Type string (10) string Date Description Identifying number of an object.high severity • ≥ 750 . v. Event start. Example: 2007-12-24T16:00:00+02:00 start_speed end_speed max_accelspee d float float float in km/h. Varies between a minimum of 0 and a maximum of approx. case-sensitive.very low severity • 450 to 549 .1100. Use this value to limit the size of the result list and receive events with more relevant severity. Unique within an account.Reference • Date range filter parameters Table 3-62: Parameters specific to showObjectAccelerationEvents: Parameter objectno avg_accel Type string (10) int Description Identifying number of an object.4.1. Example: 2007-12-24T16:00:00+02:00 end_time Date Event end. ISO 8601-formatted date and time. This value is the lower threshold used for including acceleration events with an average acceleration higher than indicated.low severity • 550 to 649 .

See Geographic coordinate conversion on Wikipedia Geographic longitude in the WGS84 coordinate system.min • 360 . Direction of acceleration in degrees: • 0 . minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.4.max Possible values are: • 0 .medium severity • 650 to 749 .brake • 2 .3 showObjectSpeedingEvents Description This action shows unwanted driver behaviour.very low severity • 450 to 549 .very high severity max_accel accel_dir int int Acceleration in milli-g.low severity • 550 to 649 . Transformation from degree. accel_type nonNegativeInteger latitude int longitude int postext string 3.high severity • ≥ 750 .1. See Geographic coordinate conversion on Wikipedia Position at event end time.steering right Geographic latitude in the WGS84 coordinate system. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. • ≤ 449 . © 2011 TomTom Business Solutions 77 .8.acceleration • 1 .steering left • 3 .Reference Table 3-63: Result for showObjectAccelerationEvents: Parameter avg_accel Type int Description Acceleration in milli-g. Unit of measurement is micro degrees (10-6 grd). Varies between a minimum of 0 and a maximum of 2000. Parameters showObjectSpeedingEvents requires the following common parameters: • Authentication parameters • General parameters v. Transformation from degree. Unit of measurement is micro degrees (10-6 grd). It shows a list of trips or part of trips with information on excessive speeding.7.

minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Result Table 3-65: Result for showObjectSpeedingEvents: Parameter objectno objectname start_time start_longitude Type string (10) string string int Description Identifying number of an object. case-sensitive. Geographic longitude in the WGS84 coordinate system. See (Geographic coordinate conversion on Wikipedia) Geographic latitude in the WGS84 coordinate system.1. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Unit of measurement is micro degrees (10-6 grd). case-sensitive.7. The time recorded when this event started. Unit of measurement is micro degrees (10-6 grd). See (Geographic coordinate conversion on Wikipedia) start_latitude int start_postext end_time end_longitude string string int end_latitude int v. See (Geographic coordinate conversion on Wikipedia) A detailed textual description of the location where this event started. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Geographic longitude in the WGS84 coordinate system. © 2011 TomTom Business Solutions 78 . Unique within an account. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Transformation from degree. Display name of an object. The time recorded when this event ended. Unit of measurement is micro degrees (10-6 grd).Reference showObjectSpeedingEvents requires the following other parameters: • Date range filter parameters Table 3-64: Parameters specific to showObjectSpeedingEvents: Parameter objectno Type string (10) Description Identifying number of an object. Transformation from degree. See (Geographic coordinate conversion on Wikipedia) Geographic latitude in the WGS84 coordinate system. Unique within an account. Transformation from degree. Unit of measurement is micro degrees (10-6 grd).4. Transformation from degree.

3.g. because the result might not be as expected (e. Validating the response.g.1 geocodeAddress Description Geocodes the address provided as request parameters and returns all possible matches. by comparing it to the input parameters.Reference Table 3-65: Result for showObjectSpeedingEvents: Parameter end_postext max_speed min_speed avg_speed object_speedli mit road_speedlimit Type string string string string float float in km/h in km/h Description A detailed textual description of the location where this event ended.9. e.4.9 Geocoding and routing 3. © 2011 TomTom Business Solutions 79 . due to typing errors) and could result in driving to the wrong destination if used without validation. one per line. the result needs to be validated. Parameters geocodeAddress requires the following common parameters: • Authentication parameters • General parameters Table 3-66: Parameters specific to geocodeAddress: Parameter addrstreet addrstreetnumber addrzip addrcity Type string (50) string (10) string (10) string (50) Description v.7. If the request returns one or multiple matches.1.

Unit of measurement is micro degrees (10-6 grd).S" N/S in the WGS84 coordinate system.Reference Table 3-66: Parameters specific to geocodeAddress: Parameter addrcountry Type string (2) Description ISO 3166-1 alpha-2 code for the country (capital letters). This parameter is required. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer.1. Geographic longitude in the WGS84 coordinate system. Transformation from degree.S" E/W in the WGS84 coordinate system. This parameter is required. Unit of measurement is micro degrees (10-6 grd).7. Geographic latitude in the form GGG° MM' SS. See Geographic coordinate conversion on Wikipedia Description latitude int v. Transformation from degree. See Geographic coordinate conversion on Wikipedia Geographic latitude in the WGS84 coordinate system. postext formatted_long itude formatted_latit ude longitude string string string int Geographic longitude in the form GGG° MM' SS. provider nonNegativeInteger Defaults to 0. 0 = TomTom Route Planner Result Table 3-67: Result for geocodeAddress: Parameter addrstreet addrstreetnumber addrzip addrcity addrcountry Type string (50) string (10) string (10) string (50) string (2) ISO 3166-1 alpha-2 code for the country (capital letters). © 2011 TomTom Business Solutions 80 .4.

Avoid motorway • 3 . separated by a semicolon: score . v. This parameter is optional.1. It is possible that multiple records are returned with the same score.9.Shortest • 2 .Walk • 4 . © 2011 TomTom Business Solutions 81 .Possible values of type are: • house • street • poi • city • postal code 3. Possible values are: • 0 .Bicycle • 5 . type . Parameters calcRouteSimpleExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-68: Parameters specific to calcRouteSimpleExtern: Parameter route_type Type nonNegativeInteger Description Defines type of route type for calculation of estimated time of arrival.Quickest • 1 .7.Reference Table 3-67: Result for geocodeAddress: Parameter additional_infor mation Type Description Contains the following.Value between 1 and 0. where 1 is best score and 0 is worst.Speed limited Defaults to 0.4. Optionally IQ Routes and/or HD Traffic information can be included.2 calcRouteSimpleExtern Description Determines the route from a start location to an end location and calculates the resulting estimated time of arrival for a specific route-type.

Defaults to the current time. If specified.don’t use traffic If use_traffic is set to 1. it is used together with start_day overruling the default of start_datetime. Possible values are: • mon • tue • wed • thu • fri • sat • sun • today Defaults to the current day.1 Possible values are: • 0 . This parameter is optional.4. over rules start_day and start_time. © 2011 TomTom Business Solutions 82 .7. If start_time is specified. If start_day is specified it is used together with start_time.0 • if start_datetime is not used . Case-sensitive.don’t use traffic • 1 . even if start_datetime is set to a different day and time.1.use traffic • Any other value . v.Reference Table 3-68: Parameters specific to calcRouteSimpleExtern: Parameter use_traffic Type nonNegativeInteger Description Defines if traffic information needs to be taken into account for calculating the route and estimated time of arrival. overruling the default of start_datetime. start_day string Defines the weekday of departure. Defaults to the current day and time. the current traffic situation is used to calculate the best route and the estimated time of arrival. start_datetime dateTime Defines the departure date and time. start_time string Defines the departure time. Default: • if start_datetime is used .

use_tollroads nonNegativeInteger Defines if toll roads should be avoided for and the route calculation. Transformation from degree. Possible values are: • 0 . Transformation from degree.Use IQ Routes Defaults to 1. v. Unit of measurement is micro degrees (10-6 grd).4. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. See (Geographic coordinate conversion on Wikipedia) This parameter is required.Do not use IQ Routes • 1 .Include toll roads Defaults to 1. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. If used. See (Geographic coordinate conversion on Wikipedia) This parameter is required.1.Reference Table 3-68: Parameters specific to calcRouteSimpleExtern: Parameter use_iqr Type nonNegativeInteger Description Defines if IQ Routes data should be used for calculating the estimated time of arrival. © 2011 TomTom Business Solutions 83 .Avoid toll roads • 1 . end_latitude int Geographic latitude in the WGS84 coordinate system. start_longitude int Geographic longitude in the WGS84 coordinate system. Unit of measurement is micro degrees (10-6 grd). indicate start_datetime or start_day and start_time to obtain best results. start_latitude int Geographic latitude in the WGS84 coordinate system. See (Geographic coordinate conversion on Wikipedia) This parameter is required.7. Possible values are: • 0 . Transformation from degree. Unit of measurement is micro degrees (10-6 grd).

Unit of measurement is micro degrees (10-6 grd). end_day string Possible values are: • mon • tue • wed • thu • fri • sat • sun Empty if start_datetime is specified.4. end_time string The calculated arrival time.1. See (Geographic coordinate conversion on Wikipedia) This parameter is required. Transformation from degree. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. delay timezone_offse t string string v. © 2011 TomTom Business Solutions 84 . The calculated duration of a trip from the departure location to the destination location. Empty if no start_datetime is specified and start_day or start_time is specified.Reference Table 3-68: Parameters specific to calcRouteSimpleExtern: Parameter end_longitude Type int Description Geographic longitude in the WGS84 coordinate system. Timezone offset. The unit of measurement is ’second’.7. Result Table 3-69: Result for calcRouteSimpleExtern: Parameter end_datetime Type string Description The calculated arrival date and time. Empty if start_datetime is specified. distance time nonNegativeInteger string Distance to destination (in meters). The unit of measurement is ’second’. Estimated delay for a trip due to traffic. The unit of measurement is ’second’.

It is a violation of the intended use of WEBFLEET.10.1.1 Overview of queues An alternative way to collect data is offered via the message queues.connect queues to • repeatedly create queues and then leave them inactive • repeatedly call popQueueMessagesExtern without subsequently calling ackQueueMessagesExtern.10. messages are stored a limited amount of time (time to live.10 Message queues 3. © 2011 TomTom Business Solutions 85 . A queue is always bound to the user creating it and collects messages matching the message class provided.7. the message is deleted from that queue and no longer available. All messages received by WEBFLEET are made available via message queues that can be accessed using a message queue. Once a message has been retrieved from a queue by using popQueueMessagesExtern and subsequently acknowledged by using ackQueueMessagesExtern. even if they have not been retrieved.2 createQueueExtern Description Creates a new queue.Reference 3. 3. The default TTL is set to 14 days. A message queue is a temporary repository for all messages associated with that subscription's filter condition (message class). Queues that have not been used for 30 consecutive days may be removed without prior notice. In order to prevent the message queues from overflowing. Parameters createQueueExtern requires the following common parameters: • Authentication parameters v. TTL) and are automatically deleted once the TTL has expired.4.

© 2011 TomTom Business Solutions 86 .3 deleteQueueExtern Description Deletes an existing queue.Reference • General parameters Table 3-70: Parameters specific to createQueueExtern: Parameter msgclass Type nonNegativeInteger Description Valid values are: • 0 – All messages (includes tracking-only messages and 4.10.7.7.Order related messages • 5 .8.Text messages v.8) • 2 .8) • 2 – All except position messages (includes 4.7.Driver related messages • 7 . 3.5.5.7.All except position messages (includes 4. does not include tracking-only messages) • 4 .1.4.Status messages • 8 .5.8. Always true. Parameters deleteQueueExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-72: Parameters specific to deleteQueueExtern: Parameter msgclass Type nonNegativeInteger Description Valid values are: • 0 . errors will be reported using the standard error reporting mechanism. does not include tracking-only messages) • 4 – Order related messages • 5 – Driver related messages • 7 – Status messages • 8 – Text messages Result Table 3-71: Result for createQueueExtern: Parameter action result Type string boolean Description The name of the operation that has been executed.All messages (includes tracking-only messages and 4.7.5.

1.4. Otherwise.7. Parameters popQueueMessagesExtern requires the following common parameters: • Authentication parameters • General parameters Table 3-74: Parameters specific to popQueueMessagesExtern: Parameter msgclass Type nonNegativeInteger Description Valid values are: • 0 .5. does not include tracking-only messages) • 4 .4 popQueueMessagesExtern Description Retrieves outstanding messages for a given subscription. errors will be reported using the standard error reporting mechanism.10. the number of messages that will be returned on a single response is limited.All except position messages (includes 4. you need to create a queue using createQueueExtern using the same message class parameter that you are going to provide with calls to popQueueMessagesExtern. 3.Order related messages • 5 . Before using popQueueMessagesExtern to retrieve outstanding messages.8) • 2 .Reference Result Table 3-73: Result for createQueueExtern: Parameter action result Type string boolean Description The name of the operation that has been executed. © 2011 TomTom Business Solutions 87 .Text messages v. Always true. the messages will be kept and returned again during the next call to popQueueMessagesExtern.Driver related messages • 7 . Once you have successfully processed (and stored) all of the retrieved messages.Status messages • 8 .7.8. In order to prevent your system from being flooded with oversized responses. you need to use ackQueueMessagesExtern to acknowledge completion of the message transfer to your application.7.All messages (includes tracking-only messages and 4.5. Calls to popQueueMessagesExtern and ackQueueMessagesExtern must be serialised.

order A 8 or 9 digit number representing class and type of the message. Unique within an account. digits 4-6 are reserved and digits 7 and 8 indicate the message class.timer event • 5 . digits 0-3 indicate the message type.1.data • 9 . Identifying number of a driver. Counted from right to left.unknown • 1 . The message class is equal to the field msg_class.trip • 11 . case-sensitive. See Drivers to learn more about drivers.polling • 4 .system • 2 .gps event • 6 . © 2011 TomTom Business Solutions 88 . Possible values are in the range 0 ≤ msgid ≤ 264-1.set output • 8 . ISO 8601-formatted date and time in the UTC timezone.7.text • 3 . v.4. Unique within an account. For a comprehensive list of possible message types see Messages types.configuration • 10 . msg_text objectno driverno string (10) string Identifying number of an object. msg_time dateTime msg_type nonNegativeInteger ign inputs odometer outputs pndconn boolean Indicates the connection state of the TomTom navigation device.input event • 7 . combined representation in the extended format. Example: 2007-12-24T16:00:00Z msg_class nonNegativeInteger Valid values are: • 0 .Reference Result Table 3-75: Result for popQueueMessagesExtern: Parameter msgid Type string Description mgsid identifies a message and is system wide unique.

Unknown trip type • 1 . Geographic longitude in the WGS84 coordinate system. pos_latitude int pos_longitude int pos_text pos_country pos_postcode pos_params string A list name-value pairs that describe the position. Unit of measurement is micro degrees (10-6 grd).showzip=1.Private trip • 2 .4. pairs are separated by ’. Example: street=B2 Maximilianallee. Name and value are separated by ’=’. Unit of measurement is micro degrees (10-6 grd).Business trip • 3 .town1_name= Leipzig. Possible names are: • city • country • direction • distance • highway_exit • highway_intersection • name1 • name2 • name3 • street • text • town1_country • town1_name • town1_part • town1_zip • town2_country • town2_name • town2_zip • zip Please note that the result doesn't always contain all position parameters. v. town1_zip=04129.’.Reference Table 3-75: Result for popQueueMessagesExtern: Parameter trip_mode Type nonNegativeInteger Description Possible values are: • 0 .Correction trip (user changed the odometer value manually) Geographic latitude in the WGS84 coordinate system.1. string (2) ISO 3166-1 alpha-2 code for the country (capital letters).7. © 2011 TomTom Business Solutions 89 .Way-to-work trip • 4 .

Reference Table 3-75: Result for popQueueMessagesExtern: Parameter pos_time Type dateTime Description ISO 8601-formatted date and time in the UTC timezone.Southeast 5 .7. v. derived from course.West 8 .1. See Addresses to learn more about addresses. Maximum capacity is 20 bytes.Southeast 5 . © 2011 TomTom Business Solutions 90 .West 8 . Example: 2007-12-24T16:00:00Z pos_addrno string (10) Refers to the nearest address if the position is within the address radius.No fix data available. case-sensitive.East 4 .Southwest 7 . Position data refer to the last known position.Northwest orderno string (20) Account-unique order id. derived from course.North 2 .South 6 .Northwest speed course GPS status indicator: • L . direction nonNegativeInteger Cardinal and intercardinal compass directions. • A . actual number of characters depends on the byte count consumed by the UTF-8 encoding of those characters. Possible values are: • • • • • • • • 1 .Southwest 7 .Northeast 3 . • V .North 2 .4.South 6 . in km/h nonNegativeInteger Cardinal and intercardinal compass directions.No fix available. Possible values are: • • • • • • • • status string 1 . combined representation in the extended format.East 4 .Northeast 3 .Sufficient quality for a valid fix. See Orders to learn more about orders.

Arrived at pick up location • 223 .Arrived at delivery location • 243 .Pick up finished • 225 .Departed from delivery location • 298 .Pick up started • 224 . Example: 2007-12-24T16:00:00Z distance user_status user_text nonNegativeInteger Distance to destination (in meters) v.Delivery finished • 245 .Rejected • 401 .Not yet sent • 100 . combined representation in the extended format. order_type nonNegativeInteger dest_latitude int dest_longitude int dest_text eta dateTime ISO 8601-formatted date and time in the UTC timezone.Delivery started • 244 .Delivery order started • 242 . Unit of measurement is micro degrees (10-6 grd).Service order started • 202 .Departed from destination • 221 . Geographic longitude in the WGS84 coordinate system.service order • 2 .Resumed • 299 .Suspended • 301 .Pickup order started • 222 . © 2011 TomTom Business Solutions 91 .4.delivery order Geographic latitude in the WGS84 coordinate system.Arrived at destination • 203 .pickup order • 3 .Finished Type of order.7. Unit of measurement is micro degrees (10-6 grd).Work started • 204 .Cancelled • 302 .1.Accepted • 201 .Reference Table 3-75: Result for popQueueMessagesExtern: Parameter order_state Type nonNegativeInteger Description Valid values are: • 0 .Read • 103 .Sent • 101 .Departed from pick up location • 241 . Valid values are: • 1 .Work finished • 205 .Received • 102 .

Unknown 1 .Other work (digital tachograph only) workstate nonNegativeInteger source_device string The external equipment this message originated from: • 0 .Free time (PND only) 2 . Only available on card insertion and removal messages.Control card 4 . Example: 00:13:6C:88:26:0B rll_buttonid string (16) Remote LINK/ID key identifier v. dt_cardaction dt_cardtype nonNegativeInteger Valid values are: • • • • • 0 .Company card dt_slot nonNegativeInteger Valid values are: • 1 .TomTom navigation device • 1 .Working (PND only) 5 .TomTom Remote LINK Working Time • 3 .Reference Table 3-75: Result for popQueueMessagesExtern: Parameter dt_cardid Type string (18) Description A driver card id as used with the Digital Tachograph. prefixed with the ISO 3166-1 alpha-2 code for the country (capital letters). Contains the card id for driver cards that are not assigned to a driver or for any other card type.Driver • 2 .4.Workshop card 3 . formatted as six groups of two hexadecimal digits.TomTom Remote LINK Logbook dt_state rll_btaddress string (17) Remote LINK Bluetooth address. © 2011 TomTom Business Solutions 92 .Driving (digital tachograph only) 6 .7. The IEEE 802 MAC-48/EUI-48 address of a Bluetooth device.Unknown 1 .Driver card 2 .Standby (digital tachograph only) 4 . separated by colons (:).Pause (PND and digital tachograph) 3 .Co-Driver Valid values are: • • • • • • • 0 .Digital tachograph • 2 .1.

See (Geographic coordinate conversion on Wikipedia) The odometer reading when this event started. Transformation from degree. in milliseconds.Reference Table 3-75: Result for popQueueMessagesExtern: Parameter surplus_data Type string Description A JSON-encoded string that carries additional data items that augment certain messages. start_time start_latitude string int The time recorded when this event started. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. containing Parameters specific to ep_snapshotdata: ISO 8601-formatted date and time in the UTC timezone. Transformation from degree.4. Unit of measurement is micro degrees (10-6 grd). minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. See (Geographic coordinate conversion on Wikipedia) Geographic longitude in the WGS84 coordinate system. • ep_paireddata: ecoPLUS initiating message. Transformation from degree. Unit of measurement is micro degrees (10-6 grd). Geographic latitude in the WGS84 coordinate system. Example: 2007-12-24T16:00:00Z Contains local time of the device on which the event occurred and/or the time the message was generated. combined representation in the extended format. • dt_timeoffset: time difference between event_time and the Digital Tachograph's internal clock. Geographic latitude in the WGS84 coordinate system.1. containing Parameters specific to ep_paireddata: • ep_tripdata: ecoPLUS additional trip information. The time recorded when this event ended.7. © 2011 TomTom Business Solutions 93 . containing Parameters specific to ep_tripdata: • ep_snapshotdata: ecoPLUS update recording. See (Geographic coordinate conversion on Wikipedia) event_time dateTime start_longitude int start_odometer end_time end_latitude string string int v. Unit of measurement is micro degrees (10-6 grd).

minutes and seconds can be done with the following calculation: (degrees + minutes/60 + seconds/ 3600) * 106 and rounding to an integer. Valid values are: • G .error Position reply .old position Postion reply .trip (vehicle changed GPS postion) • S . See (Geographic coordinate conversion on Wikipedia) The odometer reading when this event ended.standstill Message types Table 3-76: Messages types msg_type 100 101 103 200 201 202 203 204 205 210 Description outgoing text message incoming text message All messages deleted Position query Position reply Position reply .7.not allowed due to private mode Position reply .1. Transformation from degree.Reference Table 3-75: Result for popQueueMessagesExtern: Parameter end_longitude Type int Description Geographic longitude in the WGS84 coordinate system. © 2011 TomTom Business Solutions 94 .very old position Position/total position number Request track log (specific to LINK classic) 211 220 230 300 310 320 330 340 Request track log .error (specific to LINK classic) Position message Distance message Position message Position/total position number Position message Distance message Position message end_odometer trip_type string string v. Unit of measurement is micro degrees (10-6 grd).4.

distance Input switched on Input switched off v.4. © 2011 TomTom Business Solutions 95 . maximum speed. duration. speed limit (specific to TomTom GO 715) Standstill begin Standstill end Movement violation Position lock alarm Arriving at area Leaving area Ignition on Device on (specific to TomTom GO 715) 511 Ignition off Device off (specific to TomTom GO 715) 512 520 521 530 531 532 533 534 540 541 542 543 544 545 546 Trip data Unit switched on Unit switched off Power connected GPS antenna failure Power disconnected Battery removed Battery insterted Input signal changed Request operating data Operating data Operating data not available Operating data: input name.1. duration.7.empty Tracking data indicating the number of positions delivered Speed limit violation distance. number of switch events.Reference Table 3-76: Messages types msg_type 350 351 353 401 420 421 426 427 440 450 510 Description Position/total position number Position message .

Reference

Table 3-76: Messages types msg_type 547 Description GPS antenna connected (specific to LINK 300/310) Request operating data - error (specific to LINK classic) 548 550 GPS antenna disconnected (specific to LINK 300/310) Trip distance, duration, idling information, maximum speed, GPS coverage (specific to LINK classic) Trip distance, duration, idling information, maximum speed, average speed, GPS coverage (specific to LINK 300/310) Trip distance, duration, idling information, maximum speed (specific to TomTom GO 715) 551 This message is delivered when either no GPS signal or partly no GPS signal was available druing the trip: Trip message - no data (specific to LINK classic) Trip duration, maximum speed, average speed (specific to LINK 300/310) Trip duration, maximum speed (specific to TomTom GO 715) 552 554 600 601 602 603 700 Minor vehicle action Trip, distance, duration, idling information, fuel usage, maximum speed, GPS coverage Switch indicated output on Switch indicated output off Output switched on Output switched off Alarm/emergency Event message, status 701 703 704 705 706 710 711 712 713 Request status log Status log - no data available Request status log - error Status message Text message Logon driver Logoff driver Begin of work, driver indicated End of work, driver indicated

v.1.7.4, © 2011 TomTom Business Solutions

96

Reference

Table 3-76: Messages types msg_type 714 715 716 717 718 719 720 721 722 729 730 731 732 733 734 735 Description Begin of break, driver indicated End of break, driver indicated Work status change, indicating driver role, old and new work status Work started (driver role and driver name indicated) Work ended (driver role and driver name indicated) Work time event, indicating driver Toll road begin Toll road end Expenses (type, amount, currency) Order text message Order accepted Order rejected Order started Order completed Order cancelled Order modified Order: arrived at loading site (specific to LINK classic) 736 Cancel order Order: begin loading (specific to LINK classic) 737 Order deleted Order: end loading (specific to LINK classic) 738 All orders deleted Order: departure from loading site (specific to LINK classic) 739 740 741 742 743 744 Order: Arrival at unloading site Order: begin unloading Order: end unloading Order: departure from unloading site Order: delay announcement indicating time Order: begin waiting

v.1.7.4, © 2011 TomTom Business Solutions

97

Reference

Table 3-76: Messages types msg_type 745 746 747 748 749 750 751 Description Order: end waiting Order: additional costs (type, amount, currency) Arriving at depot Departing from depot Order: statustext Message read Destination reached Or odometer manual input 752 753 754 755 Navigation started (destination indicated) Navigation cancelled Message received Message discarded Or object details: license plate number, vehicle type 756 Specific to LINK 300/310 either Connection established to device Or device name 757 758 760 Device outage Vehicle type changed Order state Arriving at customer (specific to LINK classic) 761 Order: Estimated time of arrival to order destination. Departing from customer (specific to LINK classic) 762 763 Time left until order destination is reached. Navigation: Estimated time of arrival to destination. Trip begin (specific to LINK classic) 764 765 766 770 771 Trip end Begin waiting End waiting Digital tachograph connected Digital tachograph disconnected

v.1.7.4, © 2011 TomTom Business Solutions

98

error (specific to LINK classic) 803 ecoPLUS setup request via installation tool (specific to LINK 300/310) Version information (specific to LINK classic) v.Reference Table 3-76: Messages types msg_type 772 773 774 775 776 777 780 781 782 783 784 785 786 787 788 789 790 791 792 800 Description Device signals disconnection of unknown digital tachograph. Digital tachograph card inserted into digital tachograph.4. Remote LINK is paired Remote LINK low battery Driver logon Unknown driver logon Driver logoff Unknown driver logoff Working time event of driver Working time event of unknown employee Remote LINK paiting rejected as not supported by subscription Remote LINK battery replaced Remote LINK setup request per installation tool Remote LINK setup response for installation tool Remote LINK pairing rejected as there is already another device paired ecoPLUS paired (specific to LINK 300/310) Configuration message (specific to LINK classic) 801 ecoPLUS pairing rejected as not supported by subscription (specific to LINK 300/310) Configuration acknowledge (specific to LINK classic) 802 ecoPLUS pairing rejected as there is already another device assigned (specific to LINIK 300/310) Configuration acknowledge . © 2011 TomTom Business Solutions 99 .1. Time difference between digital tachograph and LINK device. Tachograph card not assigned to driver. Digital tachograph card removed from digital tachograph.7. Working state changed for digital tachograph card that is not assigned to a driver in WEBFLEET.

error Parameter query .1.Reference Table 3-76: Messages types msg_type 804 Description ecoPLUS setup response for installation tool (specific to LINK 300/310) Feature information (specific to LINK classic) 805 ecoPLUS power status (specific to LINK 300/310) Query version information (specific to LINK classic) 806 ecoPLUS fuel type changed (specific to LINK 300/310) Version information .error Start basic initialisation Basic initialisation completed Basic initialisation not successful as the device has a wrong SIM card Device activation rejected Device activation accepted Device activation rejected as the device has a wrong SIM card Device successfully activated Device has been reset Activation rejected because an object name is required v.ok Configuration driver list Parameter query .error (specific to LINK classic) 807 ecoPLUS connection lost (specific to LINK 300/310) Query release information 808 ecoPLUS plugged into vehicle (specific to LINK 300/310) Firmware release information 810 811 812 Reset unit Reset unit .update (specific to LINK classic) 814 815 816 817 820 821 822 823 824 825 826 827 828 Parameter query Parameter query Parameter query . © 2011 TomTom Business Solutions 100 .ok (specific to LINK classic) 813 Software update available Parameter query .4.7.

7.1.error Odometer query .error (private mode) v.4.error Query ignition time counter .Reference Table 3-76: Messages types msg_type 832 833 840 841 842 850 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 JSON objects Table 3-77: Parameters specific to ep_paireddata: Parameter ep_btaddress Type String Description Description Debug data Clear order stack Reset device Device reset completed Device reset error Reboot device Odometer change Odometer change acknowledged Odometer change error Disable odometer function Odometer function disabled Odometer query Odometer Odometer query .errror due to private mode Odometer change not allowed as a digital tachograph is connected Set ignition time counter to ignition on time and duration Ignition time counter set to ignition on time and duration Set ignition time counter . © 2011 TomTom Business Solutions 101 .error Disable ignition time counter Ignition time counter disabled Query ignition time counter Ignition time counter is ignition on time and duration Query ignition time counter .

10. three decimals allowed.1. Fuel consumption in litres. © 2011 TomTom Business Solutions 102 .Reference Table 3-77: Parameters specific to ep_paireddata: Parameter version_info Type String Description Table 3-78: Parameters specific to ep_tripdata: Parameter distance fuel_usage co2 Type string float String Description The difference between start_odometer and end_odometer.5 ackQueueMessagesExtern Description Acknowledges outstanding messages retrieved with a previous call to popQueueMessagesExtern.7. Parameters ackQueueMessagesExtern requires the following common parameters: • Authentication parameters v. Carbon dioxide emissions in grams. Unit of measurement is '’meter’. only returned if distance is greater than 0. Table 3-79: Parameters specific to ep_snapshotdata: Parameter avgfuelusage_ distance avgfuelusage_t ime rpm gear Type int int int int Description in ml/100km. max. in ml/h revolutions per minute the current gear 3.4.

8) • 2 .g. © 2011 TomTom Business Solutions 103 .Order related messages • 5 .Reference • General parameters Table 3-80: Parameters specific to ackQueueMessagesExtern: Parameter msgclass Type nonNegativeInteger Description Valid values are: • 0 .All messages (includes tracking-only messages and 4. errors will be reported using the standard error reporting mechanism.1. The number of messages that have been acknowledged with that request.4.8. does not include tracking-only messages) • 4 .Text messages Result Table 3-81: Result for ackQueueMessagesExtern: Parameter action result acknowledgedMessages Type string boolean nonNegativeInteger Description The name of the operation that has been executed.7.All except position messages (includes 4.5.7.Driver related messages • 7 . outstandingMessages nonNegativeInteger v. Depending on certain conditions (e.Status messages • 8 . time between pop and ack) this might not be equal to the number of messages returned by the last pop.7. Always true. An estimate for the number of messages that are still waiting in the queue.5.

4. Check your parameter for typos. Your last action could not be processed. A system error has occurred.7. 60 63 General error. Access denied. Please enter a valid time period. Your last action could not be processed. v. A system error has occurred. Please check your input.1. Your last action could not be processed A constraint violation occured. © 2011 TomTom Business Solutions 104 . One of the entered values is too large.Appendix A: Operation return codes Appendix A: Operation return codes Response codes Table: Operation response codes Code 0 1 8 Message The operation was successful. No detailed information available. Description 9 20 40 45 47 55 Indicates that the API method supplied as the parameter action is not available. Action is valid Invalid time period. A system error has occurred. The time period you have entered is invalid. Document contains no data Indicates that the result set is empty for the specific combination of parameters provided for the request.You have insufficient permissions to perform this function.

objectgroupname is invalid. Unknown macro command or unit not initialised. The account is temporary blocked. Please enter an order text. Missing order date Missing order text Invalid arrival time format. 2509 2513 v. The entered time of arrival has an invalid format. The contract for the object used in the request is not valid (e.g. 1112 1130 1132 1140 2109 2110 2210 2501 2502 2504 2506 2507 objectno is invalid. Password must be given. has expired). The entered order destination coordinates have an invalid format. The provided order number doesn’t exist. Either the account or the username supplied does not exist or the password is wrong. The provided object number doesn’t exist.4. Invalid objectgroupname Contract not valid Please enter a date of execution. You need to provide a password. Please enter the coordinates of the order destination. The user is not valid anymore. Either the password is empty or the parameter was not part of your request. The account is not valid anymore. © 2011 TomTom Business Solutions 105 . check account/username/password.1. The input field "Username" must not be empty. Invalid format of order destination coordinates. Message Description 1106 Authentication failed.Table: Operation response codes Code 90 123 167 1101 1105 User invalid (does not exist).7. Missing order destination coordinates. The entered telephone number has an invalid format.

A number identifying an address within an account must be provided. © 2011 TomTom Business Solutions 106 .Table: Operation response codes Code 2514 2515 Message Incomplete destination description. Use sendDestinationOrderExtern or updateOrderExtern if you need to modify an existing order.7. Maximum message text length (UTF-8 format) exceeded Maximum order text length (UTF-8 format) exceeded Maximum order number length exceeded The feature sendText is not supported by this unit The addressed device is either used with a tariff that doesn’t include messaging or hasn’t been configured properly (PND not paired during initialization) The addressed device is either used with a tariff that doesn't include messaging or hasn't been configured properly (PND not paired during initialization) 2600 2601 2602 2604 2605 The feature sendOrder is not supported by this unit 4000 4001 4002 An address by the same key exists already in the account.4. Description 2516 2517 The selected order number is invalid or not unique. Duplicate Order number. An address with the same identification does already exist. A name must be provided for an address.1. A group of the same name / identification does already exist. 4003 4004 4006 4007 v. The address group does not exist. The address does not exist. Updating the order type of an already existing order is not supported.

Language missing or invalid.7.Table: Operation response codes Code 4008 Message The name of an address group can not be NULL or empty The micro degree value of a geo-coordinate (latitude. Occurs if you did not wait long enough for a response from the previous request and prematurely terminated the connection. Your last WEBFLEET. but might fail again until the initial request has timed out. Request quota reached.180000000 to +180000000 micro degrees. more than n requests in t seconds are not permitted External requests are not allowed for that account/user.4.connect Description 4009 4010 4107 8000 8011 8014 8015 Requests using the same account-username pair must always be serialised and may not overlap. please see the operation’s documentation for the allowed range. See Request limits See Registering for WEBFLEET. The allowed range is a non-null value of . Your request exceeds the quota defined for that request type or that request group. Account / username busy processing other request. The range_pattern is missing for this operation. non-null Identifier for an address group within an account must be given! Invalid accountname General system error. The recommended time-out for requests is 300 seconds. A unique. 8104 8105 9000 Action missing or invalid. longitude) is outside the allowed range. invalid parameter (range_pattern) missing parameter (range_pattern) missing parameter (objectno) The range_pattern is invalid for this operation. please see the operation’s documentation for the allowed range.connect action could not be processed. © 2011 TomTom Business Solutions 107 .1. Either the account has to be activated for external request or the user has no permission. Requests may be retried after a 10 second wait interval. 9001 9002 9003 v.

rangeto_string) Description The time period given by rangefrom_string and rangeto_string exceeds the allowed time range for this operation and parameter combination. objectno and/or date range given For the date range given an objectno also needs to be given.4. order not reassignable no valid contract for object no valid id given no trip id.7. You need to provide either a msgid or date range filter parameters (see Date range filter parameters) The use of range_pattern requires values for rangefrom_string and rangeto_string. 9005 invalid parameter (msgid) 9006 missing parameter(s) (range_pattern and/or msgid) invalid parameter (rangefrom_string) invalid parameter (rangeto_string) invalid parameters (rangefrom_string must be a date before rangeto_string) invalid orderstate (must be 0|100|101|102|103|201| 202|203|204|205|221|22 2|223|224|225|241|242| 243|244|245|298|299|30 1|302|401) invalid ordertype (must be 1|2|3) missing parameter(s) (orderid.the message might have been deleted after being outdated. please see the documentation for the allowed range. The use of range_pattern requires values for rangefrom_string and rangeto_string. objectid) wrong state. driver does not exist driver group does not exist driver name is missing 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 v.Table: Operation response codes Code 9004 Message invalid parameters (rangefrom_string. © 2011 TomTom Business Solutions 108 .1. The msgid is not known to the system .

1.4.7. © 2011 TomTom Business Solutions 109 .Table: Operation response codes Code 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9044 Message driver number is missing or invalid driver group name is missing or invalid driver pin must be not empty and must be a number driver code must be a number driver number must be unique driver group name must be unique country of driver invalid driver group not unique or not existing driver not unique or not existing driver already in group driver not in group driver company invalid driver description invalid driver zip invalid driver city invalid driver street invalid driver mobile invalid driver private telephone invalid driver email invalid driver code not unique tachograph card id invalid tachograph card country invalid tachograph card is already assigned to other driver Description v.

v.Table: Operation response codes Code 9047 Message driver is already assigned to other ibutton ibutton already assigned to other driver event does not exist event is not on alarm level event is not below alarm level eventid invalid event already resolved event already acknowledged event level unknown event state unknown The event level parameter eventlevel_cur provided is not within the defined range.7. acknowledged) provided is not within the defined range.1. Use resolveEventExtern to flag this event as resolved. 9048 9060 9061 9062 9063 9064 9065 9066 9067 9080 9081 9082 9083 9100 9101 9104 9114 9123 order does not exist order not yet assigned to unit order is assigned to an other unit already orderid parameter missing or invalid object does not exist object no parameter missing or invalid date-rage is unparsable This operation is presently not supported. Remove this assignment first by updating the other driver with an empty button id. The button id is already assigned to another driver. object-no is not part of this objectgroupname Both objectno and objectgroupname are given and the objectno and objectgroupname exist.4. One of the event state parameters (resolved. Description The driver has already a button id assigned to. but the objectno is not part of the objectgroup. Use acknowledgeEventExtern to flag this event as acknowledged before resolving it. Remove the assignment first by providing an empty button id. © 2011 TomTom Business Solutions 110 .

Table: Operation response codes Code 9195 Message The request parameters for this request are invalid.4. exists already Returned by createQueueExtern if a queue for that msgclass already exists for that user. The request can not be processed. Please provide fewer / differently combined parameters.Queues Code WFCQ_E0001 WFCQ_E0006 Message queue database doesn't exist for {0} skipped creation of queue. but with an empty result. Some or all request parameters are missing or incomplete. An upstream system did not respond properly.1. Please make sure you provide parameters that adhere to the required structure (see documentation or WSDL) and the minimum amount of request data as documented. © 2011 TomTom Business Solutions 111 . At the moment we are unable to service this request. The current request with the parameters given processed successfully. 9199 9200 20100 Response codes .7. Maximum period length exceeded (range_pattern) driverno or objectno or both are missing or invalid Description Invalid parameter(s) 9196 Missing or incomplete parameter(s) 9197 Invalid combination of parameter(s) 9198 Indicates that the result set is empty for the specific combination of parameters provided for the request. The current combination of parameters can not be processed as-is.Queues Table: Operation response codes . Description v. The creation has been skipped and no changes were made to the existing queue.

’account parameter missing’. WFCQ_E0022 WFCQ_E0033 WFCQ_E0034 WFCQ_E0035 WFCQ_E0037 WFCQ_E0041 WFCQ_E0043 WFCQ_E0053 {0} queue unknown.1. no more calls allowed error due to being finally unable to resolve a deadlock while processing tx ’action’ unknown one or more of ’action parameter missing’. skipping deletion account unknown shutdown was already initiated. WFCQCS_E00 00 WFCQCS_E00 01 WFCQCS_E00 03 WFCQCSWS_ UNKNOWN v. no subscription(s) found authentication failed queue doesn’t exist. The operation named in the action is not available. A queue that has not been created (createQueueExtern) first cannot be deleted.Table: Operation response codes .4. A queue needs be created with createQueueExtern before trying to retrieve messages from it. The username does not exist or the password does not validate. © 2011 TomTom Business Solutions 112 . please try again later There are (likely transient) problems. ’password parameter missing’. that prevent the operation from completing successfully.Queues Code WFCQ_E0007 Message queue to acknowledge doesn't exist queue to pop doesn’t exist Description The operation ackQueueMessagesExtern could not be executed as there is no queue for the msgclass provided. ’msgclass parameter missing’ empty result problems processing your request. ’username parameter missing’. The account name does not exist. There is no queue for the msgclass provided.7.

Also available as an RSS feed.connect blog Follow the blog to stay up to date with latest developments. libraries. © 2011 TomTom Business Solutions 113 .Appendix B: Resources Appendix B: Resources WEBFLEET.7. • WEBFLEET.1.connect resources • WEBFLEET.connect download section Download the latest documentation. • WEBFLEET.1 • RFC 1738 . • WEBFLEET.Uniform Resource Locators (URL) • Simple Object Access Protocol (SOAP) • Web Services Description Language (WSDL) • SOAP Message Transmission Optimization Mechanism (MTOM) • ISO 8601 • Wikipedia article about ISO 8601 • JSON website v.Hypertext Transfer Protocol -.4.HTTP/1. examples and localised activation forms.connect online support Use the online support form if you can't find an answer to your question elsewhere.connect discussion group Turn to this discussion group if you have general questions or if you want to get in touch with other developers. Other resources • Wikipedia article about WGS84 • Wikipedia article about Geographic coordinate conversion • RFC 2616 .

Sign up to vote on this title
UsefulNot useful