Het Dataplatform van gemeente Amsterdam gaat het gebruik van een API key bij het gebruik van API's verplicht stellen. Hiermee wil het Dataplatform inzicht krijgen wie gebruik maakt van haar APIs, zodat het Dataplatform kan communiceren over updates en wijzigingen in de API's. Eventuele wijzigingen in de API's kunnen dan tijdig geïmplementeerd worden in uw systemen. Dit gaat gelden voor alle zogenaamde 'DSO API's' van het Dataplatform van gemeente Amsterdam.
Het gebruik van een API key bij de aanroep van een API van het Dataplatform van gemeente Amsterdam is vanaf half september optioneel. In overleg met de dataorganisatie wordt een deadline vastgesteld voor het moment vanaf wanneer de API keys verplicht worden. U kunt de API's van het Dataplatform dan niet meer gebruiken zonder een API key mee te geven.
Dit heeft gevolgen voor uw systemen!
Vraag tijdig een API key aan om uw systemen hierop aan te passen. U kunt met dit formulier een API key aanvragen.
De Basisregistratie | Toegewijde weergaven BAG en BRK bevat informatie nodig voor implementatie op het Data Verkenner platform.
- ID:
- dataverkennerBevatverblijfsobjecten
- Versie:
- None
- Autorisatie:
- Geen; dit is openbare data.
- Licentie:
- -
- Eigenaar:
- Gemeente Amsterdam
- Uitgever:
- Datateam Basis- en Kernregistraties
- Productie:
- Basisinformatie
- Bronhouder:
- OIS | gebruik.basisinformatie@amsterdam.nl
Endpoints
- REST OpenAPI:
- /v1/dataverkenner/bevatverblijfsobjecten
Tabellen
Bevatverblijfsobjecten
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/dataverkenner/bevatverblijfsobjecten/bevatverblijfsobjecten
- CSV-export:
- /v1/dataverkenner/bevatverblijfsobjecten/bevatverblijfsobjecten?_format=csv
- GeoJSON-export:
- /v1/dataverkenner/bevatverblijfsobjecten/bevatverblijfsobjecten?_format=geojson
De volgende velden zijn beschikbaar:
| Veldnaam | Type | Identifier | Omschrijving |
|---|---|---|---|
id
|
String | ☑ | |
verblijfsobjectenId
|
String | Landelijke identificerende sleutel. | |
verblijfsobjectenIdentificatie
|
String | ☑ | Landelijke identificerende sleutel. |
verblijfsobjectenVolgnummer
|
Integer | ☑ | Volgnummer van de nummeraanduiding in de administratie van de bronhouder. |
ligtInPandenId
|
String | Landelijke identificerende sleutel. | |
ligtInPandenIdentificatie
|
String | Landelijke identificerende sleutel. | |
ligtInPandenVolgnummer
|
Integer | Volgnummer van de nummeraanduiding in de administratie van de bronhouder. | |
beginGeldigheid
|
Datetime | De datum waarop de nummeraanduiding geldig is geworden. | |
eindGeldigheid
|
Datetime | De datum waarop de nummeraanduiding niet meer geldig is. |
De volgende query-parameters zijn te gebruiken:
| Parameter | Autorisatie | Mogelijke waarden | Werking |
|---|---|---|---|
beginGeldigheid
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
|
beginGeldigheid[lt]
|
Test op kleiner dan (<). |
||
beginGeldigheid[not]
|
Test of waarde niet overeenkomt (!=). |
||
beginGeldigheid[gte]
|
Test op groter dan of gelijk (>=). |
||
beginGeldigheid[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
beginGeldigheid[gt]
|
Test op groter dan (>). |
||
beginGeldigheid[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
beginGeldigheid[lte]
|
Test op kleiner dan of gelijk (<=). |
||
eindGeldigheid
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
|
eindGeldigheid[lt]
|
Test op kleiner dan (<). |
||
eindGeldigheid[not]
|
Test of waarde niet overeenkomt (!=). |
||
eindGeldigheid[gte]
|
Test op groter dan of gelijk (>=). |
||
eindGeldigheid[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
eindGeldigheid[gt]
|
Test op groter dan (>). |
||
eindGeldigheid[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
eindGeldigheid[lte]
|
Test op kleiner dan of gelijk (<=). |
||
geldigOp
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (==) |
|
id
|
Tekst | Test op exacte waarde (==) |
|
id[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
ligtInPandenId
|
Tekst | Test op exacte waarde (==) |
|
ligtInPandenId[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
ligtInPandenId[not]
|
Test of waarde niet overeenkomt (!=). |
||
ligtInPandenId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
ligtInPandenId[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
ligtInPandenId[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
ligtInPandenIdentificatie
|
Tekst | Test op exacte waarde (==) |
|
ligtInPandenIdentificatie[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
ligtInPandenIdentificatie[not]
|
Test of waarde niet overeenkomt (!=). |
||
ligtInPandenIdentificatie[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
ligtInPandenIdentificatie[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
ligtInPandenIdentificatie[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
ligtInPandenVolgnummer
|
Geheel getal | Test op exacte waarde (==) |
|
ligtInPandenVolgnummer[lt]
|
Test op kleiner dan (<). |
||
ligtInPandenVolgnummer[not]
|
Test of waarde niet overeenkomt (!=). |
||
ligtInPandenVolgnummer[gte]
|
Test op groter dan of gelijk (>=). |
||
ligtInPandenVolgnummer[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
ligtInPandenVolgnummer[gt]
|
Test op groter dan (>). |
||
ligtInPandenVolgnummer[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
ligtInPandenVolgnummer[lte]
|
Test op kleiner dan of gelijk (<=). |
||
verblijfsobjectenId
|
Tekst | Test op exacte waarde (==) |
|
verblijfsobjectenId[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
verblijfsobjectenId[not]
|
Test of waarde niet overeenkomt (!=). |
||
verblijfsobjectenId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
verblijfsobjectenId[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
verblijfsobjectenId[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
verblijfsobjectenIdentificatie
|
Tekst | Test op exacte waarde (==) |
|
verblijfsobjectenIdentificatie[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
verblijfsobjectenIdentificatie[not]
|
Test of waarde niet overeenkomt (!=). |
||
verblijfsobjectenIdentificatie[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
verblijfsobjectenIdentificatie[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
verblijfsobjectenIdentificatie[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
verblijfsobjectenVolgnummer
|
Geheel getal | Test op exacte waarde (==) |
|
verblijfsobjectenVolgnummer[lt]
|
Test op kleiner dan (<). |
||
verblijfsobjectenVolgnummer[not]
|
Test of waarde niet overeenkomt (!=). |
||
verblijfsobjectenVolgnummer[gte]
|
Test op groter dan of gelijk (>=). |
||
verblijfsobjectenVolgnummer[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
verblijfsobjectenVolgnummer[gt]
|
Test op groter dan (>). |
||
verblijfsobjectenVolgnummer[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
verblijfsobjectenVolgnummer[lte]
|
Test op kleiner dan of gelijk (<=). |