Agentschap Digitaal Vlaanderen DownloadService API Description

Introduction

This service provides an API to place custom orders for products in the download catalogue of Agentschap Digitaal Vlaanderen.

The product catalogue is accessible by means of the "categories", "products" and "selectionentities" resources, which are open to anyone. To access the "order" resource however, one must be authenticated. Please refer to the API Authorization site for more information on how to use OAuth 2.0. Note that authorization is applicable on a per-product level. Access the "categories" and "products" resources authenticated to retrieve an indication of whether or not the user is allowed to download a certain product.

To configure an order one must provide at least the id of the product, the file format and the file type (full or diff). Furthermore one may restrict the downloaded data to a certain geographical area (custom or predefined) or to a certain time period. A single order may contain one or more order items.

Upon successfull validation of the order configuration one receives an order id. This id may be used to poll for order completion: the HEAD method provides a lightweight check for the order status, while the GET method returns all details of the order. When the order has completed, one may download the resulting zip file.