Beschrijving
Met deze API is het mogelijk om gegevens uit de BGT dataset te downloaden. Deze BGT-gegevens zijn te downloaden voor gebruik in eigen GIS-software. De BGT-gegevens zijn als extract in GML of GML-light of Stuf-geo formaat te downloaden.
Dit document bevat alleen informatie m.b.t. het gebruik van deze API. De BGT-modeldocumentatie (IMGEO) met bijbehorend schema(xsd) en beschrijvingen van de download formaten kun je vinden op: https://www.geonovum.nl/geo-standaarden/bgt-imgeo.
Een stappenplan voor het downloaden via deze API staat hier beschreven.
Hieronder worden eerst een aantal algemene begrippen en concepten uitgelegd. Vervolgens wordt elk endpoint individueel beschreven.
Full
Met de full endpoints Predefined en Custom kan de meest actuele stand gedownload worden.
Predefined
Een full predefined download is direct beschikbaar om te downloaden, is niet gefilterd op gebied en is niet gefilterd op featuretype.
Custom
Bij een custom download wordt een aanvraag gedaan waarin specifieke filters worden opgegeven m.b.t. de gewenste inhoud van de bestanden. De aanvraag wordt asynchroon behandeld op de server en de status van de aanvraag kan opgevraagd worden. Nadat de aanvraag voorbereid is op de server, kan het bestand gedownload worden.
Filters
Geofilter
In het request voor een Custom download kan (optioneel) een geofilter meegegeven worden. De waarde van dit geofilter moet voldoen aan het Well-known text (WKT) formaat. Alleen Polygon en MultiPolygon objecten zijn hierbij toegestaan, bovendien worden inner rings niet ondersteund. De coördinaten worden geïnterpreteerd volgens EPSG:28992.
Dit geofilter limiteert het gebied waarvoor gegevens in de download wordt opgenomen, maar het filter is niet exact. Dat betekent dat de download een overshoot aan objecten buiten de selectie kan bevatten.
Featuretypes
In het request voor een Custom download moet (verplicht) opgegeven worden welke featuretypes in de download opgenomen moeten worden.
Delta
Delta endpoints zijn ervoor om eenmalig je eigen administratie op te bouwen (initiële levering) en deze periodiek bij te werken met de beschikbare wijzigingen.
Werkwijze
- Een beginstand wordt gedownload met het Delta Custom of Delta Predefined endpoint, door deze aan te roepen zonder parameter delta-id. De download bevat informatie over welke delta-id het betreft.
- Periodiek (bij voorkeur dagelijks) wordt het Delta endpoint aangeroepen om de delta-id's op te halen welke sinds de bij stap 1 bepaalde delta-id zijn ontstaan.
- Voor elke delta-id die in stap 2 gevonden wordt, wordt het Delta Custom of Delta Predefined endpoint aangeroepen met parameter delta-id. De inhoud van deze downloads bevat alleen de mutaties die hebben plaatsgevonden in die betreffende delta.
Predefined
De opzet is hier gelijk aan de full predefined downloads. Echter kan aan het delta endpoint in het request optioneel de parameter delta-id worden opgegeven, zie stap 1 en 3 onder werkwijze.
Custom
De opzet is hier gelijk aan de full custom downloads. Echter kan aan het delta endpoint in het request optioneel de parameter delta-id worden opgegeven, zie stap 1 en 3 onder werkwijze.