De Lijn Kern Open Data Services (v1)

API change history

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

/omleidingen/{referentieOmleiding} - GET

geef de omleiding op basis van zijn referentie id

Try it

Request

Request URL

Request parameters

  • integer

    Format - int32. referentie id van de omleiding

  • (optional)

    de taalcode voor de titel en omschrijving van de omleidingen

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

{
  "titel": "Antwerpen: Werken Brabo 2 Fr. Rooseveltplaats Werken",
  "omschrijving": "Periode : ... Niet-bediende haltes : ... vervanghaltes: ...",
  "periode": {
    "startDatum": "string",
    "eindDatum": "string"
  },
  "lijnrichtingen": [
    {
      "lijnNummerPubliek": "335",
      "entiteitnummer": "3",
      "lijnnummer": "335",
      "richting": {},
      "omschrijving": "Leuven - Aarschot",
      "bestemming": "LEUVEN GASTHUISB.",
      "kleurVoorGrond": "#FFFFFF",
      "kleurAchterGrond": "#991199",
      "kleurAchterGrondRand": "#991199",
      "links": [
        {
          "rel": "string",
          "url": "string"
        }
      ],
      "kleurVoorGrondRand": "#FFFFFF"
    }
  ],
  "haltes": [
    {
      "entiteitnummer": "3",
      "haltenummer": "306938",
      "omschrijving": "Butsel Kerk",
      "omschrijvingLang": "Boutersem Butsel Kerk",
      "gemeentenummer": 57,
      "omschrijvingGemeente": "Leuven",
      "districtCode": "GRI",
      "geoCoordinaat": {
        "latitude": 0.0,
        "longitude": 0.0
      },
      "halteToegankelijkheden": "VISUELE_BEPERKING",
      "hoofdHalte": true,
      "taal": "N",
      "links": [
        {
          "rel": "string",
          "url": "string"
        }
      ]
    }
  ],
  "referentieOmleiding": 0,
  "type": "string",
  "omleidingsDagen": [
    "string"
  ],
  "links": [
    {
      "rel": "string",
      "url": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "titel": {
      "type": "string",
      "description": "Titel van de omleiding",
      "example": "Antwerpen: Werken Brabo 2 Fr. Rooseveltplaats Werken"
    },
    "omschrijving": {
      "type": "string",
      "description": "Omschrijving van de omleiding",
      "example": "Periode : ... Niet-bediende haltes : ... vervanghaltes: ..."
    },
    "periode": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "startDatum": {
              "type": "string",
              "description": "aanvangsdatum en tijdstip van de omleiding",
              "format": "date"
            },
            "eindDatum": {
              "type": "string",
              "description": "einddatum en tijdstip van de omleiding",
              "format": "date"
            }
          }
        },
        {
          "description": "De periode of geldigheidsduur van de omleiding"
        }
      ]
    },
    "lijnrichtingen": {
      "type": "array",
      "items": {
        "required": [
          "entiteitnummer",
          "lijnnummer",
          "richting",
          "omschrijving"
        ],
        "type": "object",
        "properties": {
          "lijnNummerPubliek": {
            "type": "string",
            "description": "publiek lijnnummer",
            "example": "335"
          },
          "entiteitnummer": {
            "type": "string",
            "description": "entiteit nummer",
            "example": "3"
          },
          "lijnnummer": {
            "type": "string",
            "description": "lijn nummer",
            "example": "335"
          },
          "richting": {
            "allOf": [
              {
                "enum": [
                  "HEEN",
                  "TERUG"
                ],
                "type": "string"
              },
              {
                "enum": [
                  "HEEN, TERUG"
                ],
                "description": "richting van de lijn",
                "example": "HEEN"
              }
            ]
          },
          "omschrijving": {
            "type": "string",
            "description": "omschrijving van de lijnrichting",
            "example": "Leuven - Aarschot"
          },
          "bestemming": {
            "type": "string",
            "description": "eindhalte van de lijnrichting",
            "example": "LEUVEN GASTHUISB."
          },
          "kleurVoorGrond": {
            "type": "string",
            "description": "kleur van het lijnnummer op het vignet",
            "example": "#FFFFFF"
          },
          "kleurAchterGrond": {
            "type": "string",
            "description": "achtergrond kleur van het lijn vignet",
            "example": "#991199"
          },
          "kleurAchterGrondRand": {
            "type": "string",
            "description": "kleur van de rand van het lijn vignet",
            "example": "#991199"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              }
            }
          },
          "kleurVoorGrondRand": {
            "type": "string",
            "description": "kleur van de rand van het lijn vignet",
            "example": "#FFFFFF"
          }
        }
      },
      "description": "Lijst van lijnrichtingen die betrokken zijn in deze omleiding"
    },
    "haltes": {
      "type": "array",
      "items": {
        "required": [
          "entiteitnummer",
          "haltenummer",
          "omschrijving",
          "omschrijvingLang",
          "districtCode",
          "taal"
        ],
        "type": "object",
        "properties": {
          "entiteitnummer": {
            "type": "string",
            "description": "nummer entiteit (key waarde)",
            "example": "3"
          },
          "haltenummer": {
            "type": "string",
            "description": "halte nummer (key waarde)",
            "example": "306938"
          },
          "omschrijving": {
            "type": "string",
            "description": "omschrijving van de halte",
            "example": "Butsel Kerk"
          },
          "omschrijvingLang": {
            "type": "string",
            "description": "volledige omschrijving van de halte",
            "example": "Boutersem Butsel Kerk"
          },
          "gemeentenummer": {
            "type": "integer",
            "description": "nummer gemeente (key waarde)",
            "format": "int32",
            "example": 57
          },
          "omschrijvingGemeente": {
            "type": "string",
            "description": "naam van de gemeente waar de halte zich bevindt",
            "example": "Leuven"
          },
          "districtCode": {
            "type": "string",
            "description": "districtcode van het district waar de halte zich bevindt",
            "example": "GRI"
          },
          "geoCoordinaat": {
            "allOf": [
              {
                "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": "Coordinaten van de halte (latitude, langitude)",
                "example": "50.98145261213046,4.823559183763914"
              }
            ]
          },
          "halteToegankelijkheden": {
            "enum": [
              "MOTORISCHE_BEPERKING,MOTORISCH_MET_ASSIST,VISUELE_BEPERKING"
            ],
            "type": "array",
            "items": {
              "enum": [
                "MOTORISCHE_BEPERKING",
                "MOTORISCH_MET_ASSIST",
                "VISUELE_BEPERKING"
              ],
              "type": "string"
            },
            "description": "omschrijving van de toegankelijkheid van een halte",
            "example": "VISUELE_BEPERKING"
          },
          "hoofdHalte": {
            "type": "boolean",
            "description": "is de halte een hoofdhalte (attribuut voor toekomstig gebruik, geeft momenteel null als waarde)",
            "example": true
          },
          "taal": {
            "type": "string",
            "description": "de taal waarin de berichten voor de halte worden weergegeven",
            "example": "N"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string"
                },
                "url": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "description": "Lijst van niet bediende haltes van deze omleiding"
    },
    "referentieOmleiding": {
      "type": "integer",
      "description": "De referentie omleiding is een identificatie(id) van de omleiding",
      "format": "int32"
    },
    "type": {
      "type": "string",
      "description": "Het type van de omleiding zoals bv. werken of evenement"
    },
    "omleidingsDagen": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Geef een lijst van dagen waarop de omleiding van toepassing is"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    }
  }
}

500 Internal Server Error

service of achterliggende systemen niet beschikbaar

404 Not Found

omleiding is niet gevonden

Code samples

@ECHO OFF

curl -v -X GET "https://api.delijn.be/DLKernOpenData/api/v1/omleidingen/{referentieOmleiding}?taalCode={}"
-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["taalCode"] = "{}";
            var uri = "https://api.delijn.be/DLKernOpenData/api/v1/omleidingen/{referentieOmleiding}?" + 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/api/v1/omleidingen/{referentieOmleiding}");

            builder.setParameter("taalCode", "{}");

            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
            "taalCode": "{}",
        };
      
        $.ajax({
            url: "https://api.delijn.be/DLKernOpenData/api/v1/omleidingen/{referentieOmleiding}?" + $.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/api/v1/omleidingen/{referentieOmleiding}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"taalCode={}",
                      ];
    
    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/api/v1/omleidingen/{referentieOmleiding}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'taalCode' => '{}',
);

$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
    'taalCode': '{}',
})

try:
    conn = httplib.HTTPSConnection('api.delijn.be')
    conn.request("GET", "/DLKernOpenData/api/v1/omleidingen/{referentieOmleiding}?%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
    'taalCode': '{}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'taalCode' => '{}'
})
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