De Lijn Kern Open Data Services (Beta)

API change history

Dit document beschrijft de kern operaties van de Open Data API (Beta version).

geef een initëel, vroeger, later of laatste routeplan

voor een vroeger routeplan dient de parameter tijdstip overeen te komen met het aankomsttijdsip (duurtijd.einde) van de vroegste reisweg, voor een later routeplan dient de parameter tijdstip overeen te komen het het vertrektijdstip (duurtijd.start) van de laatste reisweg

Try it

Request

Request URL

Request parameters

  • string

    latitude en longitude van de vertrek locatie gescheiden door komma bv, 51.056064,3.797336

  • string

    latitude en longitude van de aankomst locatie gescheiden door komma bv, 51.056064,3.797336

  • (optional)
    string

    bepaalt of de aanvraag gaat over een initiële, vroegere, latere of laatste routeplan

  • (optional)
    string

    tijdstip van vertrekken of aankomen in formaat yyyy-MM-dd'T'HH:mm:ss bv. 2016-11-11T22:00:00

  • (optional)
    string

    verwijst het tijdstip naar het moment van vertrek of aankomst

  • (optional)
    array

    Lijst van vervoersopties met als default BUS,TRAM,METRO en TREIN

Request headers

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

Request body

Responses

200 OK

request met succes afgehandeld

Representations

{
  "reiswegen": [
    {
      "bestpassend": true,
      "overstappen": 0,
      "duurtijd": {
        "start": "2016-10-24T10:22:00Z",
        "einde": "2016-10-24T10:22:00Z",
        "duurtijd": "P0DT0H4M0S"
      },
      "reiswegStappen": [
        {
          "vertrekPunt": {
            "links": [
              {
                "rel": "string",
                "url": "string"
              }
            ],
            "id": "string",
            "naam": "string",
            "afstand": 0,
            "geoCoordinaat": "50.98145261213046,4.823559183763914"
          },
          "aankomstPunt": {
            "links": [
              {
                "rel": "string",
                "url": "string"
              }
            ],
            "id": "string",
            "naam": "string",
            "afstand": 0,
            "geoCoordinaat": "50.98145261213046,4.823559183763914"
          },
          "duurtijd": {
            "start": "2016-10-24T10:22:00Z",
            "einde": "2016-10-24T10:22:00Z",
            "duurtijd": "P0DT0H4M0S"
          }
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "url": "string"
    }
  ]
}
{
  "required": [
    "reiswegen"
  ],
  "type": "object",
  "properties": {
    "reiswegen": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "bestpassend": {
            "enum": [
              true,
              false
            ],
            "type": "boolean",
            "description": "geeft aan of de reisweg het best beantwoordt aan het gevraagde routeplan  "
          },
          "overstappen": {
            "type": "integer",
            "description": "geeft het aantal overstappen van deze reisweg gebaseerd op de reiswegstappen",
            "format": "int32"
          },
          "duurtijd": {
            "type": "object",
            "properties": {
              "start": {
                "type": "string",
                "description": "geeft de starttijd van de deze reisweg(stap) in het formmaat yyyy-MM-dd'T'HH:mm:ss",
                "format": "date-time",
                "example": "2016-10-24T10:22:00Z"
              },
              "einde": {
                "type": "string",
                "description": "geeft de aankomsttijd van de deze reisweg(stap) in het formmaat yyyy-MM-dd'T'HH:mm:ss",
                "format": "date-time",
                "example": "2016-10-24T10:22:00Z"
              },
              "duurtijd": {
                "type": "object",
                "properties": {
                  "months": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "hours": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "minutes": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "seconds": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "days": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "xmlschemaType": {
                    "type": "object",
                    "properties": {
                      "namespaceURI": {
                        "type": "string"
                      },
                      "localPart": {
                        "type": "string"
                      },
                      "prefix": {
                        "type": "string"
                      }
                    }
                  },
                  "years": {
                    "type": "integer",
                    "format": "int32"
                  },
                  "sign": {
                    "type": "integer",
                    "format": "int32"
                  }
                }
              }
            }
          }
        }
      },
      "description": "lijst van reiswegen van het gevraagde routeplan"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    }
  }
}

400 Bad Request

ongeldige input waarden in de request

Representations

500 Internal Server Error

service of achterliggende systemen niet beschikbaar

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}?aanvraagType=INITIEEL&tijdstip={string}&vertrekAankomst=VERTREK&vervoersOptie={array}"
-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["aanvraagType"] = "INITIEEL";
            queryString["tijdstip"] = "{string}";
            queryString["vertrekAankomst"] = "VERTREK";
            queryString["vervoersOptie"] = "{array}";
            var uri = "https://api.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}?" + 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.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}");

            builder.setParameter("aanvraagType", "INITIEEL");
            builder.setParameter("tijdstip", "{string}");
            builder.setParameter("vertrekAankomst", "VERTREK");
            builder.setParameter("vervoersOptie", "{array}");

            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
            "aanvraagType": "INITIEEL",
            "tijdstip": "{string}",
            "vertrekAankomst": "VERTREK",
            "vervoersOptie": "{array}",
        };
      
        $.ajax({
            url: "https://api.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}?" + $.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://api.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"aanvraagType=INITIEEL",
                         @"tijdstip={string}",
                         @"vertrekAankomst=VERTREK",
                         @"vervoersOptie={array}",
                      ];
    
    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://api.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'aanvraagType' => 'INITIEEL',
    'tijdstip' => '{string}',
    'vertrekAankomst' => 'VERTREK',
    'vervoersOptie' => '{array}',
);

$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
    'aanvraagType': 'INITIEEL',
    'tijdstip': '{string}',
    'vertrekAankomst': 'VERTREK',
    'vervoersOptie': '{array}',
})

try:
    conn = httplib.HTTPSConnection('api.delijn.be')
    conn.request("GET", "/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}?%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
    'aanvraagType': 'INITIEEL',
    'tijdstip': '{string}',
    'vertrekAankomst': 'VERTREK',
    'vervoersOptie': '{array}',
})

try:
    conn = http.client.HTTPSConnection('api.delijn.be')
    conn.request("GET", "/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}?%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.delijn.be/DLKernOpenData/v1/beta/routeplan/{vertrekLatlng}/{bestemmingLatlng}')

query = URI.encode_www_form({
    # Request parameters
    'aanvraagType' => 'INITIEEL',
    'tijdstip' => '{string}',
    'vertrekAankomst' => 'VERTREK',
    'vervoersOptie' => '{array}'
})
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