Drivers API 1.0

API change history

Drivers API 1.0

A list of the available Driver Calendar Entry types

A list of the available Driver Calendar Entry types

Try it

Request URL

Request headers

string

TruTac Api Token. See Documentation for futher details.

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.

Response 200

Records for Driver Calendar Entry Types found and returned successfully

{
  "fixedEntryTypes": [
    "Available",
    "Compassionate Leave",
    "Exempted Vehicle",
    "Holiday",
    "Pat/Mat Leave",
    "Rest",
    "Sick",
    "Unpaid Sick",
    "Vacation",
    "Week Holiday",
    "Week Sick"
  ],
  "savedVariableEntries": [
    "Training Day",
    "Route 76"
  ]
}
{
  "type": "object",
  "properties": {
    "fixedEntryTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "savedVariableEntries": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Response 400

An invalid or missing input parameter will result in a bad request

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

Response 500

An unexpected error occurred, should not return sensitive information

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

Code samples

@ECHO OFF

curl -v -X GET "https://api.trulinks.co.uk/drivers/v1/api/drivers-calendar-entry-types"
-H "TT-Api-Key: {TruTac api token}"
-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/drivers/v1/api/drivers-calendar-entry-types?" + 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://api.trulinks.co.uk/drivers/v1/api/drivers-calendar-entry-types");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("TT-Api-Key", "{TruTac api token}");
            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/drivers/v1/api/drivers-calendar-entry-types?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("TT-Api-Key","{TruTac api token}");
                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://api.trulinks.co.uk/drivers/v1/api/drivers-calendar-entry-types";
    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:@"GET"];
    // Request headers
            [_request setValue:@"{TruTac api token}" forHTTPHeaderField:@"TT-Api-Key"];
            [_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/drivers/v1/api/drivers-calendar-entry-types');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.trulinks.co.uk')
    conn.request("GET", "/drivers/v1/api/drivers-calendar-entry-types?%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': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.trulinks.co.uk')
    conn.request("GET", "/drivers/v1/api/drivers-calendar-entry-types?%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/drivers/v1/api/drivers-calendar-entry-types')


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