Tracking API

API change history

Use the Tracking API to return a list of trip records for a specific period.

Get GPS data

Get GPS data entries from specified date range. Also returns continuation token and link to get next data portion Positions for deleted users/vehicles are not returned, but if user/vehicle existed when data was requested and then user/vehicle was removed then data for the user/vehicle requested by a continuation token will be returned.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Date range start. If this parameter is used then "token" parameter shouldn't be used and toDate parameter is required Recommendation: Please use big date ranges (>=4 hours) against small date ranges.

  • (optional)
    string

    Date range end. If this parameter is used then "token" parameter shouldn't be used and fromDate parameter is required Recommendation: Please use big date ranges (>=4 hours) against small date ranges.

  • (optional)
    string

    User's employee number

  • (optional)
    string

    Vehicle's VIN

  • (optional)
    boolean

    Specifies result units

  • (optional)
    string

    Continuation token. If this parameter is specified then other parameters should not be specified

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

Request was executed successfully.

Response headers

  • (optional)
    string

    A link to get next data portion

204 No Content

Returned when no data present.

400 Bad Request

Invalid request from the client. Example: missing required parameter for GET method (which is not part of resource name, the latter will result in 404 error). 400 error should be accompanied by error code returned in the body (see format below).

401 Unauthorized

Unauthorized request.

500 Internal Server Error

This error is always an indication of a bug on the server side, it possibly due to an unhandled exception.

503 Service Unavailable

Service temporarily unavailable, because other services are temporarily unavailable (such as Azure service, required 3rd party service like Google API).

Code samples

@ECHO OFF

curl -v -X GET "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata?fromDate={string}&toDate={string}&employeeNumber={string}&vin={string}&useMetric=false&token={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["fromDate"] = "{string}";
            queryString["toDate"] = "{string}";
            queryString["employeeNumber"] = "{string}";
            queryString["vin"] = "{string}";
            queryString["useMetric"] = "false";
            queryString["token"] = "{string}";
            var uri = "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata");

            builder.setParameter("fromDate", "{string}");
            builder.setParameter("toDate", "{string}");
            builder.setParameter("employeeNumber", "{string}");
            builder.setParameter("vin", "{string}");
            builder.setParameter("useMetric", "false");
            builder.setParameter("token", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "fromDate": "{string}",
            "toDate": "{string}",
            "employeeNumber": "{string}",
            "vin": "{string}",
            "useMetric": "false",
            "token": "{string}",
        };
      
        $.ajax({
            url: "https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"fromDate={string}",
                         @"toDate={string}",
                         @"employeeNumber={string}",
                         @"vin={string}",
                         @"useMetric=false",
                         @"token={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'fromDate' => '{string}',
    'toDate' => '{string}',
    'employeeNumber' => '{string}',
    'vin' => '{string}',
    'useMetric' => 'false',
    'token' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'fromDate': '{string}',
    'toDate': '{string}',
    'employeeNumber': '{string}',
    'vin': '{string}',
    'useMetric': 'false',
    'token': '{string}',
})

try:
    conn = httplib.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/tracking/v1/tracking/gpsdata?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'fromDate': '{string}',
    'toDate': '{string}',
    'employeeNumber': '{string}',
    'vin': '{string}',
    'useMetric': 'false',
    'token': '{string}',
})

try:
    conn = http.client.HTTPSConnection('customerapi-encore.actsoft.com')
    conn.request("GET", "/tracking/v1/tracking/gpsdata?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://customerapi-encore.actsoft.com/tracking/v1/tracking/gpsdata')

query = URI.encode_www_form({
    # Request parameters
    'fromDate' => '{string}',
    'toDate' => '{string}',
    'employeeNumber' => '{string}',
    'vin' => '{string}',
    'useMetric' => 'false',
    'token' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body