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
Table 1 voor de end-to-end test.
De volgende velden zijn beschikbaar:
Veldnaam | Type | Identifier | Omschrijving |
---|---|---|---|
key
|
Integer | Primary Key. | |
id
|
Integer | ☑ | Uniek id in order to test SCD. |
active
|
Boolean | Test boolean values, set to TRUE for active FALSE for inactive. | |
dateIngest
|
Datetime | Timestamp of ingestion into this table UTC. | |
dateGenerated
|
Datetime | Timestamp of data generation UTC. | |
comment
|
String | Comment field. | |
binarycolumn
|
String | Test to send binary data. | |
json
|
Json | ||
json.jsonFoo
|
Object | String type JSON field. | |
json.jsonFoo.jsonFooBar
|
String | ||
geo
|
Point | Geometrie van het type POINT van een locatie in RD stelsel (epsg:28992) | |
random
|
String | Veld 1 voor willekeurige data. | |
random2
|
String | Veld 2 voor willekeurige data. |
De volgende query-parameters zijn te gebruiken:
Parameter | Autorisatie | Mogelijke waarden | Werking |
---|---|---|---|
active
|
true | false |
Test op exacte waarde (== ) |
|
active[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
binarycolumn
|
Tekst | Test op exacte waarde (== ) |
|
binarycolumn[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
binarycolumn[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
binarycolumn[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
binarycolumn[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
binarycolumn[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
comment
|
Tekst | Test op exacte waarde (== ) |
|
comment[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
comment[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
comment[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
comment[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
comment[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
dateGenerated
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
|
dateGenerated[lt]
|
None | Test op kleiner dan (< ). |
|
dateGenerated[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
dateGenerated[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
dateGenerated[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
dateGenerated[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
dateGenerated[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dateGenerated[gt]
|
None | Test op groter dan (> ). |
|
dateIngest
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
|
dateIngest[lt]
|
None | Test op kleiner dan (< ). |
|
dateIngest[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
dateIngest[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
dateIngest[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
dateIngest[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
dateIngest[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dateIngest[gt]
|
None | Test op groter dan (> ). |
|
geo
|
GeoJSON of POINT(x y ...) |
Test op exacte waarde (== ) |
|
id
|
Geheel getal | Test op exacte waarde (== ) |
|
id[lt]
|
None | Test op kleiner dan (< ). |
|
id[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
id[gt]
|
None | Test op groter dan (> ). |
|
id[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
id[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
key
|
Geheel getal | Test op exacte waarde (== ) |
|
key[lt]
|
None | Test op kleiner dan (< ). |
|
key[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
key[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
key[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
key[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
key[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
key[gt]
|
None | Test op groter dan (> ). |
|
random
|
Tekst | Test op exacte waarde (== ) |
|
random[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
random[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
random[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
random[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
random[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
random2
|
Tekst | Test op exacte waarde (== ) |
|
random2[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
random2[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
random2[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
random2[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
random2[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
Table 2 most simple test.
De volgende velden zijn beschikbaar:
Veldnaam | Type | Identifier | Omschrijving |
---|---|---|---|
id
|
Integer | ☑ | Some id. |
date
|
Datetime | Some timestamp in UTC. | |
comment
|
String | Comment field. |
De volgende query-parameters zijn te gebruiken:
Parameter | Autorisatie | Mogelijke waarden | Werking |
---|---|---|---|
comment
|
Tekst | Test op exacte waarde (== ) |
|
comment[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
comment[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
comment[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
comment[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
comment[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
date
|
yyyy-mm-dd of yyyy-mm-ddThh:mm[:ss[.ms]] |
Test op exacte waarde (== ) |
|
date[lt]
|
None | Test op kleiner dan (< ). |
|
date[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
date[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
date[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
date[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
date[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
date[gt]
|
None | Test op groter dan (> ). |
|
id
|
Geheel getal | Test op exacte waarde (== ) |
|
id[lt]
|
None | Test op kleiner dan (< ). |
|
id[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
id[gt]
|
None | Test op groter dan (> ). |
|
id[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
id[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |