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

Sensor

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Unieke aanduiding van de crowd monitoring sensor.
referentiecode String Unieke code van de crowd monitoring sensor.
naam String Naam van de crowd monitoring sensor.
omschrijving String Omschrijving van de crowd monitoring sensor.
type String Type crowd monitoring sensor.
doel String Doel van crowd monitoring sensor.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
doel Tekst Test op exacte waarde (==)
doel[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
doel[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
doel[isempty] true | false Test of de waarde leeg is (== '' / != '')
doel[not] Test of waarde niet overeenkomt (!=).
doel[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id Tekst Test op exacte waarde (==)
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[not] Test of waarde niet overeenkomt (!=).
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam Tekst Test op exacte waarde (==)
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[isempty] true | false Test of de waarde leeg is (== '' / != '')
naam[not] Test of waarde niet overeenkomt (!=).
naam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving Tekst Test op exacte waarde (==)
omschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
omschrijving[not] Test of waarde niet overeenkomt (!=).
omschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referentiecode Tekst Test op exacte waarde (==)
referentiecode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referentiecode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referentiecode[isempty] true | false Test of de waarde leeg is (== '' / != '')
referentiecode[not] Test of waarde niet overeenkomt (!=).
referentiecode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
type Tekst Test op exacte waarde (==)
type[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
type[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
type[isempty] true | false Test of de waarde leeg is (== '' / != '')
type[not] Test of waarde niet overeenkomt (!=).
type[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).

Locatie

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke aanduiding voor locatie van de crowd monitoring sensor.
geometry Geometry Punt geometrie van de locatie van de crowd monitoring sensor.
sensor String (relatie) Verwijzing naar de crowd monitoring sensor.
referentiecode String Unieke code van de locatie van de crowd monitoring sensor.
naam String Naam van locatie van de van de crowd monitoring sensor.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
geometry GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
id Geheel getal Test op exacte waarde (==)
id[gt] Test op groter dan (>).
id[lt] Test op kleiner dan (<).
id[lte] Test op kleiner dan of gelijk (<=).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[not] Test of waarde niet overeenkomt (!=).
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[gte] Test op groter dan of gelijk (>=).
naam Tekst Test op exacte waarde (==)
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[isempty] true | false Test of de waarde leeg is (== '' / != '')
naam[not] Test of waarde niet overeenkomt (!=).
naam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referentiecode Tekst Test op exacte waarde (==)
referentiecode[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referentiecode[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referentiecode[isempty] true | false Test of de waarde leeg is (== '' / != '')
referentiecode[not] Test of waarde niet overeenkomt (!=).
referentiecode[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sensor.id Tekst Test op exacte waarde (==)
sensor.id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
sensor.id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sensor.id[isempty] true | false Test of de waarde leeg is (== '' / != '')
sensor.id[not] Test of waarde niet overeenkomt (!=).
sensor.id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).

Insluitbare relaties

De volgende velden kunnen ingesloten worden met ?_expandScope=...:

Relatie Tabel Omschrijving
sensor cmsa:sensor

Markering

Een markering bevat de gegevens over de locatie en crowd monitor sensor zelf.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id Integer ☑ Unieke aanduiding voor de markering.
geometry Geometry Punt geometrie van de locatie van de crowd monitoring sensor.
sensor String (relatie) Verwijzing naar de crowd monitoring sensor.
locatie Integer (relatie) Verwijzing naar de locatie van de crowd monitoring sensor.
sensornaam String Naam van de crowd monitoring sensor.
sensortype String Type van de crowd monitoring sensor.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
geometry GeoJSON of GEOMETRY(x y ...) Test op exacte waarde (==)
id Geheel getal Test op exacte waarde (==)
id[gt] Test op groter dan (>).
id[lt] Test op kleiner dan (<).
id[lte] Test op kleiner dan of gelijk (<=).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[not] Test of waarde niet overeenkomt (!=).
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[gte] Test op groter dan of gelijk (>=).
locatie.id Geheel getal Test op exacte waarde (==)
locatie.id[gt] Test op groter dan (>).
locatie.id[lt] Test op kleiner dan (<).
locatie.id[lte] Test op kleiner dan of gelijk (<=).
locatie.id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
locatie.id[not] Test of waarde niet overeenkomt (!=).
locatie.id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
locatie.id[gte] Test op groter dan of gelijk (>=).
sensor.id Tekst Test op exacte waarde (==)
sensor.id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
sensor.id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sensor.id[isempty] true | false Test of de waarde leeg is (== '' / != '')
sensor.id[not] Test of waarde niet overeenkomt (!=).
sensor.id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sensornaam Tekst Test op exacte waarde (==)
sensornaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
sensornaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sensornaam[isempty] true | false Test of de waarde leeg is (== '' / != '')
sensornaam[not] Test of waarde niet overeenkomt (!=).
sensornaam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
sensortype Tekst Test op exacte waarde (==)
sensortype[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
sensortype[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
sensortype[isempty] true | false Test of de waarde leeg is (== '' / != '')
sensortype[not] Test of waarde niet overeenkomt (!=).
sensortype[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).

Insluitbare relaties

De volgende velden kunnen ingesloten worden met ?_expandScope=...:

Relatie Tabel Omschrijving
locatie cmsa:locatie
sensor cmsa:sensor