WebService API

DriverTech offers an API to allow Clients to use their own back end systems instead of or in addition to the FleetWatcher Web Portal.

This API, known as the FleetWatcher API, is comprised of secure enterprise ready Web Services hosted by servers and networks designed for high availability. The services included in the FleetWatcher API are based upon the same core types as defined in the XSD/WSDL ensuring consistency. Also included is verbose error and exception reporting to speed initial development and enhance the ability to resolve problems programmatically.

Service Detail

Service Release Overview

Development Resources

Should you have any questions regarding the services or need assistance please contact Web Service Support via Email

Feel free to contact us for assistance in getting the most out of these Services!

Documentation is provided in the following locations:

• On each service page - Top Level Operation Information
• Within the XSD via annotations - Low Level Detail
  You may find this XSD Primer XSD Primer helpful
• Other documents referenced by the service pages - White papers, etc

Tools and Utilities

Applications which can display an XSD Graphically:

• Altova XML Spy
• Liquid Studio
• Stylus Studio XSD Editor
• XSD Diagram - Free but limited (does not display enum values etc)
• Stackoverflow List of various apps
• You may send recommendations to the development team

During development of web services it can be very valuable to issue test requests before writing any code:

• A free tool called SoapUI

Data Sourcing Strategies

To prevent disruption by both intentional and unintentional DOS type of 'attacks' your requests will be rate limted as follows:

• Inbound (from Device->DataCenter->You) data requests by Company+User+Operation to not more than 1 every 1000ms
• Outbound (from You->DataCenter->Device) is rate-limited by Company+User+Operation to not more than 1 every 300ms

Guidelines for continual polling of various data types

shortPollSleep = 5                                 							//Required sleep amount when polling again immediately
longPollSleep = Storage.GetLongPollSleep("operationName")            		//3hours - Configurable long wait period
batchSize = Storage.GetBatchSize("operationName")                			//1000 - Configurable batch size per operation/request type
currentMaxIndexReceived = Storage.GetLastPollingValue("operationName")      //Storage area to keep track of last polled value

While(true)
{
    response = X_GetByIndex(currentMaxIndexReceived, batchSize)
    currentMaxIndexReceived = MAX(response.Items.Id)            			//Get MAX(object) for query type (i.e. Int for ByIndex, DateTime for other types)
        Storage.SetLastPollingValue("operationName", currentMaxIndexReceived)    //Persist the value to durable storage to allow the app to continue after a restart
    if(COUNT(response.Items) >= batchSize)                					//Are there more records?
                    sleep(shortPollSleep)        							//Immediately call again to get next batch to catch up as there are more 'in the queue'
    else
                    sleep(longPollSleep)
}