Reports-Analysis API 1.0

API change history

Reports-Analysis API 1.0

GetD14

Try it

Request URL

Request headers

string

TruTac Api Token. See Documentation for futher details.

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

Further help on passing parameters can be found in our guide to parameters.

{
  "filterByDriverIds": [
    "DRIVER-ID-123",
    "DRIVER-ID-789"
  ],
  "recordsAfterDateTime": "2018-01-01T00:00:00",
  "recordsBeforeDateTime": "2018-01-31T23:59:59.999"
}
{
  "type": "object",
  "properties": {
    "filterByDriverIds": {
      "description": "Only Records belonging to Drivers in this array will be returned",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recordsAfterDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities AFTER this date will be returned",
      "type": "string"
    },
    "recordsBeforeDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities BEFORE this date will be returned",
      "type": "string"
    },
    "includeNonCoreVehicles": {
      "description": "If TRUE then Duties associated with Vehicles marked as Non-Core will be included in the result",
      "type": "boolean"
    },
    "filterByDriversWithAveragePointsPerDutyMoreThan": {
      "format": "double",
      "description": "If submitted then the results will be filtered to only show drivers with an average Points Per Duty more than the submitted value",
      "type": "number"
    }
  },
  "example": {
    "filterByDriverIds": [
      "DRIVER-ID-123",
      "DRIVER-ID-789"
    ],
    "recordsAfterDateTime": "2018-01-01T00:00:00Z",
    "recordsBeforeDateTime": "2018-01-31T23:59:59.999Z"
  }
}
{
  "filterByDriverIds": [
    "DRIVER-ID-123",
    "DRIVER-ID-789"
  ],
  "recordsAfterDateTime": "2018-01-01T00:00:00",
  "recordsBeforeDateTime": "2018-01-31T23:59:59.999"
}
{
  "type": "object",
  "properties": {
    "filterByDriverIds": {
      "description": "Only Records belonging to Drivers in this array will be returned",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recordsAfterDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities AFTER this date will be returned",
      "type": "string"
    },
    "recordsBeforeDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities BEFORE this date will be returned",
      "type": "string"
    },
    "includeNonCoreVehicles": {
      "description": "If TRUE then Duties associated with Vehicles marked as Non-Core will be included in the result",
      "type": "boolean"
    },
    "filterByDriversWithAveragePointsPerDutyMoreThan": {
      "format": "double",
      "description": "If submitted then the results will be filtered to only show drivers with an average Points Per Duty more than the submitted value",
      "type": "number"
    }
  },
  "example": {
    "filterByDriverIds": [
      "DRIVER-ID-123",
      "DRIVER-ID-789"
    ],
    "recordsAfterDateTime": "2018-01-01T00:00:00Z",
    "recordsBeforeDateTime": "2018-01-31T23:59:59.999Z"
  }
}
{
  "filterByDriverIds": [
    "DRIVER-ID-123",
    "DRIVER-ID-789"
  ],
  "recordsAfterDateTime": "2018-01-01T00:00:00",
  "recordsBeforeDateTime": "2018-01-31T23:59:59.999"
}
{
  "type": "object",
  "properties": {
    "filterByDriverIds": {
      "description": "Only Records belonging to Drivers in this array will be returned",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "recordsAfterDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities AFTER this date will be returned",
      "type": "string"
    },
    "recordsBeforeDateTime": {
      "format": "date-time",
      "description": "If a valid date (as defined by RFC3339) is submitted then only activities BEFORE this date will be returned",
      "type": "string"
    },
    "includeNonCoreVehicles": {
      "description": "If TRUE then Duties associated with Vehicles marked as Non-Core will be included in the result",
      "type": "boolean"
    },
    "filterByDriversWithAveragePointsPerDutyMoreThan": {
      "format": "double",
      "description": "If submitted then the results will be filtered to only show drivers with an average Points Per Duty more than the submitted value",
      "type": "number"
    }
  },
  "example": {
    "filterByDriverIds": [
      "DRIVER-ID-123",
      "DRIVER-ID-789"
    ],
    "recordsAfterDateTime": "2018-01-01T00:00:00Z",
    "recordsBeforeDateTime": "2018-01-31T23:59:59.999Z"
  }
}

Response 200

Success

[
  {
    "infringementDetails": [
      {
        "infringementCode": 306,
        "description": "Working for more than 6 hours without a valid break from 09:32 to 06:20",
        "infringementDate": {
          "date": "2018-01-26T09:15:00",
          "formatted": "Fri 26/01/2018"
        }
      },
      {
        "infringementCode": 204,
        "description": "4.30 hour rule infringement from 01/01/2018 17:08 to 02/01/2018 03:08",
        "infringementOccuredAt": {
          "date": "2018-01-02T01:50:00",
          "formatted": "01:50"
        },
        "infringementDate": {
          "date": "2018-01-01T17:08:00",
          "formatted": "Mon 01/01/2018"
        },
        "info": "Driven for 05:15 hours over a period of 10:00 with insufficient break"
      }
    ],
    "dataRows": [
      {
        "date": {
          "date": "2018-03-01T00:00:00",
          "formatted": "Thu 01/03/18"
        },
        "registration": "No Chart/Record found"
      },
      {
        "date": {
          "date": "2018-03-14T00:00:00",
          "formatted": "Wed 14/03/18"
        },
        "registration": "ABC 123",
        "startLocation": "HOME",
        "endLocation": "HOME",
        "startOdo": 208853,
        "endOdo": 209016,
        "odoKms": 163,
        "traceKms": 163,
        "startTime": {
          "date": "2018-03-14T04:59:00",
          "formatted": "04:59"
        },
        "endTime": {
          "date": "2018-03-14T11:49:00",
          "formatted": "11:49"
        },
        "drive": {
          "minutes": 194,
          "formatted": "3:14"
        },
        "other": {
          "minutes": 150,
          "formatted": "2:30"
        },
        "poa": {
          "minutes": 0,
          "formatted": "0:00"
        },
        "rest": {
          "minutes": 66,
          "formatted": "1:06"
        },
        "dutyTime": {
          "minutes": 410,
          "formatted": "6:50"
        },
        "dailyRest": {
          "minutes": 1020,
          "formatted": "17:10"
        },
        "avgSpeed": 50
      }
    ],
    "driverId": "DRIVER-ID",
    "driverName": "Fellowes Harry",
    "category": "CATEGORY 123 ABC",
    "employmentNumber": "EMPLOYMENT NUMBER"
  }
]
{
  "uniqueItems": false,
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "weeklyRests": {
        "uniqueItems": false,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "weeklyRestStart": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "weeklyRestEnd": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "weeklyRestTotal": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "weeklyRestFormatted": {
              "type": "string"
            }
          }
        }
      },
      "infringementDetails": {
        "uniqueItems": false,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "infringementCode": {
              "format": "int32",
              "type": "integer"
            },
            "description": {
              "type": "string"
            },
            "dutyBeforeInfringement": {
              "type": "string"
            },
            "infringementOccuredAt": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "dutyAfterInfringement": {
              "type": "string"
            },
            "infringementDate": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "info": {
              "type": "string"
            },
            "possibleFixedPenalties": {
              "format": "int32",
              "type": "integer"
            }
          }
        }
      },
      "compensations": {
        "uniqueItems": false,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "compensationFrom": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "compensationDueBy": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "compensationAmountOwedTotal": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "compensationFormatted": {
              "type": "string"
            }
          }
        }
      },
      "fortnightlyDrive": {
        "type": "object",
        "properties": {
          "fortnightlyDriveStart": {
            "type": "object",
            "properties": {
              "date": {
                "format": "date-time",
                "type": "string"
              },
              "formatted": {
                "type": "string"
              }
            }
          },
          "fortnightlyDriveEnd": {
            "type": "object",
            "properties": {
              "date": {
                "format": "date-time",
                "type": "string"
              },
              "formatted": {
                "type": "string"
              }
            }
          },
          "fortnightlyDriveTotal": {
            "type": "object",
            "properties": {
              "minutes": {
                "format": "int32",
                "type": "integer"
              },
              "formatted": {
                "type": "string"
              }
            }
          },
          "fortnightlyDriveFormatted": {
            "type": "string"
          }
        }
      },
      "dataRows": {
        "uniqueItems": false,
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "date": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "registration": {
              "type": "string"
            },
            "startLocation": {
              "type": "string"
            },
            "endLocation": {
              "type": "string"
            },
            "startOdo": {
              "format": "int32",
              "type": "integer"
            },
            "endOdo": {
              "format": "int32",
              "type": "integer"
            },
            "odoKms": {
              "format": "int32",
              "type": "integer"
            },
            "traceKms": {
              "format": "int32",
              "type": "integer"
            },
            "startTime": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "endTime": {
              "type": "object",
              "properties": {
                "date": {
                  "format": "date-time",
                  "type": "string"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "drive": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "other": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "poa": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "rest": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "dutyTime": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "dailyRest": {
              "type": "object",
              "properties": {
                "minutes": {
                  "format": "int32",
                  "type": "integer"
                },
                "formatted": {
                  "type": "string"
                }
              }
            },
            "splitDailyRest": {
              "type": "boolean"
            },
            "avgSpeed": {
              "format": "int32",
              "type": "integer"
            },
            "doubleManned": {
              "type": "boolean"
            }
          }
        }
      },
      "driverId": {
        "type": "string"
      },
      "driverName": {
        "type": "string"
      },
      "division": {
        "type": "string"
      },
      "category": {
        "type": "string"
      },
      "agency": {
        "type": "string"
      },
      "employmentNumber": {
        "type": "string"
      }
    }
  }
}

Response 400

Bad Request

{
  "errorMessage": "string",
  "error": {}
}
{
  "type": "object",
  "properties": {
    "errorMessage": {
      "type": "string"
    },
    "error": {
      "type": "object"
    }
  }
}

Response 500

Server Error

{
  "statusCode": 0
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer",
      "readOnly": true
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14"
-H "TT-Api-Key: {TruTac api token}"
-H "Content-Type: application/json"
-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("TT-Api-Key", "{TruTac api token}");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("TT-Api-Key", "{TruTac api token}");
            request.setHeader("Content-Type", "application/json");
            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
        };
      
        $.ajax({
            url: "https://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("TT-Api-Key","{TruTac api token}");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
            [_request setValue:@"{TruTac api token}" forHTTPHeaderField:@"TT-Api-Key"];
            [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
            [_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://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'TT-Api-Key' => '{TruTac api token}',
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'TT-Api-Key': '{TruTac api token}',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.trulinks.co.uk')
    conn.request("POST", "/analysis-reports/v1/api/driver-d14?%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
    'TT-Api-Key': '',
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.trulinks.co.uk')
    conn.request("POST", "/analysis-reports/v1/api/driver-d14?%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://api.trulinks.co.uk/analysis-reports/v1/api/driver-d14')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['TT-Api-Key'] = '{TruTac api token}'
request['Content-Type'] = 'application/json'
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