Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Livesearch
spaceKeyPRODOC
sizelarge
additionalpage excerpt
placeholderWhat can I help you with?

 


Section
Column
width65%

Overview

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.

Table of Contents

Service Detail

Children Display
alltrue
depth1
excerpttrue
excerptTypesimple

Column
width34%
Service Release Status
ServiceVersionRev. DateUpgrade Info
Administration 2.0.
102
10603/
10
24/
2018
2022 Release Notes
Data 2.1.8202/28/2018 Release Notes
Reports 2.0.10011/01/2017 Release Notes
DEPRECATING
Data v2.02.0.8003/12/20182.0 -> 2.1
DEPRECATED
Data v2.0.Test2.0.8005/21/2013

2.0ut -> 2.1

Data v1.41.4.5005/20/20131.2,1.4 -> 2.1
PreRelease2.0.7505/20/2013PR -> 2.1

Service Integration

Implementation Overview

...

Guidelines for continual polling of various data types

TypeRecommendedMaximum FrequencyNotes
DataService: InboundMessages5 minutes1 minutesDrain Queue processing may be applied
DataService: InboundFiles10 minutes1 minutesDrain Queue processing may be applied
DataService: TrailerEventsvaries1 minutesDrain Queue processing may be applied
DataService: HosTotals1 hours1 minutesHosTotals can be continually calculated on the client between polling intervals
Its possible to retreive only those which have been updated since the last request
DataService: HosLogs6 hours1 hoursDrain Queue processing may be applied
DataService: HosUnassignedDriving30 minutes5 minutes
 

ReportsService: ALL6 hours1 hoursDrain Queue processing may be applied


Continual Polling pseudo code example

Code Block
languagec#
titleDrain Queue Pseudo Code Example
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)
}

 


Development Resources 
Anchor
DevelopmentResources
DevelopmentResources

...

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

A free tool called SoapUI