Introductie API Keys

Het Dataplatform van de gemeente Amsterdam gaat het gebruik van een identificatie key bij het aanroepen van haar API's vanaf 1 februari 2024 verplicht stellen. Vanaf 1 februari 2024 kun je de API's van het Dataplatform niet meer zonder een key gebruiken. Vraag tijdig een key aan via dit aanvraagformulier. Doe je dit niet, dan werkt je applicatie of website vanaf 1 februari 2024 niet meer. Dit geldt voor alle API's die op deze pagina gedocumenteerd zijn.

Door de API key kunnen we contact houden met de gebruikers van onze API's. Zo kunnen we gebruikers informeren over updates. Daarnaast krijgen we hiermee inzicht in het gebruik van de API's en in wie welke dataset via de API bevraagt. Ook voor dataeigenaren is dit waardevolle informatie.

Meer info:
Pagina API key aanvragen
Technische documentatie
Vragen? Mail naar dataplatform@amsterdam.nl

Endpoints

Tabellen

Bevatverblijfsobjecten

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[lte] None Test op kleiner dan of gelijk (<=).
beginGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
beginGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
beginGeldigheid[gte] None Test op groter dan of gelijk (>=).
beginGeldigheid[lt] None Test op kleiner dan (<).
beginGeldigheid[not] None Test of waarde niet overeenkomt (!=).
beginGeldigheid[gt] None Test op groter dan (>).
eindGeldigheid yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] Test op exacte waarde (==)
eindGeldigheid[lte] None Test op kleiner dan of gelijk (<=).
eindGeldigheid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
eindGeldigheid[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
eindGeldigheid[gte] None Test op groter dan of gelijk (>=).
eindGeldigheid[lt] None Test op kleiner dan (<).
eindGeldigheid[not] None Test of waarde niet overeenkomt (!=).
eindGeldigheid[gt] None Test op groter dan (>).
geldigOp <code>yyyy-mm-dd</code> of <code>yyyy-mm-ddThh:mm[:ss[.ms]]</code> Test op exacte waarde (==)
id Tekst Test op exacte waarde (==)
id[isempty] true of false Test of de waarde leeg is (== '' / != '')
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] None Test of waarde niet overeenkomt (!=).
ligtInPandenId Tekst Test op exacte waarde (==)
ligtInPandenId[isempty] true of false Test of de waarde leeg is (== '' / != '')
ligtInPandenId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligtInPandenId[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligtInPandenId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ligtInPandenId[not] None Test of waarde niet overeenkomt (!=).
ligtInPandenIdentificatie Tekst Test op exacte waarde (==)
ligtInPandenIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
ligtInPandenIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligtInPandenIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligtInPandenIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
ligtInPandenIdentificatie[not] None Test of waarde niet overeenkomt (!=).
ligtInPandenVolgnummer Geheel getal Test op exacte waarde (==)
ligtInPandenVolgnummer[lte] None Test op kleiner dan of gelijk (<=).
ligtInPandenVolgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
ligtInPandenVolgnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
ligtInPandenVolgnummer[gte] None Test op groter dan of gelijk (>=).
ligtInPandenVolgnummer[lt] None Test op kleiner dan (<).
ligtInPandenVolgnummer[not] None Test of waarde niet overeenkomt (!=).
ligtInPandenVolgnummer[gt] None Test op groter dan (>).
verblijfsobjectenId Tekst Test op exacte waarde (==)
verblijfsobjectenId[isempty] true of false Test of de waarde leeg is (== '' / != '')
verblijfsobjectenId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectenId[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectenId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verblijfsobjectenId[not] None Test of waarde niet overeenkomt (!=).
verblijfsobjectenIdentificatie Tekst Test op exacte waarde (==)
verblijfsobjectenIdentificatie[isempty] true of false Test of de waarde leeg is (== '' / != '')
verblijfsobjectenIdentificatie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectenIdentificatie[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectenIdentificatie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
verblijfsobjectenIdentificatie[not] None Test of waarde niet overeenkomt (!=).
verblijfsobjectenVolgnummer Geheel getal Test op exacte waarde (==)
verblijfsobjectenVolgnummer[lte] None Test op kleiner dan of gelijk (<=).
verblijfsobjectenVolgnummer[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
verblijfsobjectenVolgnummer[isnull] true of false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
verblijfsobjectenVolgnummer[gte] None Test op groter dan of gelijk (>=).
verblijfsobjectenVolgnummer[lt] None Test op kleiner dan (<).
verblijfsobjectenVolgnummer[not] None Test of waarde niet overeenkomt (!=).
verblijfsobjectenVolgnummer[gt] None Test op groter dan (>).