De Lijn Zoek Open Data Services

API change history

Dit document beschrijft de Zoek operaties van de Open Data APIDit document beschrijft de Zoek operaties van de Open Data API

zoek naar locaties zoals gemeenten, straten, herkenningspunten en haltes

zoek naar locaties zoals gemeenten, straten, herkenningspunten en haltes

Try it

Request

Request URL

Request parameters

  • string

    het zoekargument

  • (optional)
    string

    momenteel niet ondersteund voor lokaties

  • (optional)
    integer

    Format - int32. de start positie in de lijst van gevonden lokaties

  • (optional)
    integer

    Format - int32. het maximaal aantal lokaties aangeleverd door deze service

Request headers

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

Request body

Responses

200 OK

successful operation

Representations

{
  "aantalHits": 51,
  "locaties": [
    {
      "type": "adres",
      "subtype": "hoofdgemeente",
      "deelgemeentes": "Putkapel,Leuven",
      "hoofdgemeente": "Leuven",
      "straat": "Bondgenotenlaan",
      "haltenummer": "303205",
      "huisnummer": "112",
      "omschrijving": "Wilrijk Ziekenh. Academisch Ziekenhuis",
      "geoCoordinaat": "50.98145261213046,4.823559183763914"
    }
  ]
}
{
  "required": [
    "aantalHits",
    "locaties"
  ],
  "type": "object",
  "properties": {
    "aantalHits": {
      "type": "integer",
      "description": "het aantal gevonden locaties die beantwoorden aan het zoekargument",
      "format": "int32",
      "example": 51
    },
    "locaties": {
      "type": "array",
      "items": {
        "required": [
          "subtype",
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "enum": [
              "adres",
              "halte",
              "herkenningspunt",
              "station"
            ],
            "type": "string",
            "description": "geeft het type weer aan van de locatie",
            "example": "adres"
          },
          "subtype": {
            "enum": [
              "hoofdgemeente",
              "deelgemeente",
              "straat",
              "adres",
              "halte",
              "herkenningspunt",
              "station"
            ],
            "type": "string",
            "description": "geeft het subttype weer aan van de locatie binnen een bepaald type",
            "example": "hoofdgemeente"
          },
          "deelgemeentes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "geeft een lijst van namen van deelgemeente voor deze locatie",
            "example": "Putkapel,Leuven"
          },
          "hoofdgemeente": {
            "type": "string",
            "description": "geeft de naam van de hoofdgemeente voor deze locatie",
            "example": "Leuven"
          },
          "straat": {
            "type": "string",
            "description": "geeft de straat voor deze straat locatie",
            "example": "Bondgenotenlaan"
          },
          "haltenummer": {
            "type": "string",
            "description": "geeft haltenummer voor deze halte locatie",
            "example": "303205"
          },
          "huisnummer": {
            "type": "string",
            "description": "geeft huisnummer voor deze adres locatie",
            "example": "112"
          },
          "omschrijving": {
            "type": "string",
            "description": "geeft het naam van de halte, station of herkenningsput voor deze locatie",
            "example": "Wilrijk Ziekenh. Academisch Ziekenhuis"
          },
          "geoCoordinaat": {
            "type": "object",
            "properties": {
              "latitude": {
                "type": "number",
                "description": "bevat de latitude van een geografische locatie",
                "format": "double"
              },
              "longitude": {
                "type": "number",
                "description": "bevat de longitude van een geografische locatie",
                "format": "double"
              }
            }
          }
        }
      },
      "description": "de gevonden locaties die beantwoorden aan het zoekargument"
    }
  }
}

500 Internal Server Error

service of achterliggende systemen niet beschikbaar

Representations

Code samples

@ECHO OFF

curl -v -X GET "https://api.delijn.be/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}?huidigePositie={string}&startIndex=0&maxAantalHits=10"
-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["huidigePositie"] = "{string}";
            queryString["startIndex"] = "0";
            queryString["maxAantalHits"] = "10";
            var uri = "https://api.delijn.be/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}?" + 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/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}");

            builder.setParameter("huidigePositie", "{string}");
            builder.setParameter("startIndex", "0");
            builder.setParameter("maxAantalHits", "10");

            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
            "huidigePositie": "{string}",
            "startIndex": "0",
            "maxAantalHits": "10",
        };
      
        $.ajax({
            url: "https://api.delijn.be/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}?" + $.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/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"huidigePositie={string}",
                         @"startIndex=0",
                         @"maxAantalHits=10",
                      ];
    
    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/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'huidigePositie' => '{string}',
    'startIndex' => '0',
    'maxAantalHits' => '10',
);

$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
    'huidigePositie': '{string}',
    'startIndex': '0',
    'maxAantalHits': '10',
})

try:
    conn = httplib.HTTPSConnection('api.delijn.be')
    conn.request("GET", "/DLZoekOpenData/v1/beta/zoek/locaties/{zoekArgument}?%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
    'huidigePositie': '{string}',
    'startIndex': '0',
    'maxAantalHits': '10',
})

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

query = URI.encode_www_form({
    # Request parameters
    'huidigePositie' => '{string}',
    'startIndex' => '0',
    'maxAantalHits' => '10'
})
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