winkelgebieden - API specificatie

Gemeente Amsterdam

Originele specificatie (JSON)

API documentatie

winkelgebieden (0.0.1)

Download OpenAPI specification:Download

E-mail: datapunt@amsterdam.nl License: Terms of Service

Winkelgebieden

API Usage Documentation

winkelgebieden

winkelgebieden_winkelgebieden_list_2

Authorizations:

oauth2

query Parameters

_count	boolean Include a count of the total result set and the number of pages.Only works for responses that return a page.
_expand	boolean Allow to expand relations.
_expandScope	string Comma separated list of named relations to expand.
_fields	string Comma-separated list of fields to display
_format	string Enum: "json" "csv" "geojson" Select the export format
_pageSize	integer Number of results to return per page.
_sort	string Which field to use when ordering the results.
categorie	string Exact; text
categorie[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
categorie[isempty]	boolean Whether the field is empty or not.
categorie[isnull]	boolean Whether the field has a NULL value or not.
categorie[like]	string Matches text using wildcards (? and *).
categorie[not]	Array of strings Exclude matches; text
categorienaam	string Exact; text
categorienaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
categorienaam[isempty]	boolean Whether the field is empty or not.
categorienaam[isnull]	boolean Whether the field has a NULL value or not.
categorienaam[like]	string Matches text using wildcards (? and *).
categorienaam[not]	Array of strings Exclude matches; text
code	string Exact; text
code[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
code[isempty]	boolean Whether the field is empty or not.
code[isnull]	boolean Whether the field has a NULL value or not.
code[like]	string Matches text using wildcards (? and *).
code[not]	Array of strings Exclude matches; text
concentratiegebiedcode	string Exact; text
concentratiegebiedcode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
concentratiegebiedcode[isempty]	boolean Whether the field is empty or not.
concentratiegebiedcode[isnull]	boolean Whether the field has a NULL value or not.
concentratiegebiedcode[like]	string Matches text using wildcards (? and *).
concentratiegebiedcode[not]	Array of strings Exclude matches; text
concentratiegebiednaam	string Exact; text
concentratiegebiednaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
concentratiegebiednaam[isempty]	boolean Whether the field is empty or not.
concentratiegebiednaam[isnull]	boolean Whether the field has a NULL value or not.
concentratiegebiednaam[like]	string Matches text using wildcards (? and *).
concentratiegebiednaam[not]	Array of strings Exclude matches; text
gebied	string Exact; text
gebied[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebied[isempty]	boolean Whether the field is empty or not.
gebied[isnull]	boolean Whether the field has a NULL value or not.
gebied[like]	string Matches text using wildcards (? and *).
gebied[not]	Array of strings Exclude matches; text
gebiedscode	string Exact; text
gebiedscode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebiedscode[isempty]	boolean Whether the field is empty or not.
gebiedscode[isnull]	boolean Whether the field has a NULL value or not.
gebiedscode[like]	string Matches text using wildcards (? and *).
gebiedscode[not]	Array of strings Exclude matches; text
gebiedsnaam	string Exact; text
gebiedsnaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebiedsnaam[isempty]	boolean Whether the field is empty or not.
gebiedsnaam[isnull]	boolean Whether the field has a NULL value or not.
gebiedsnaam[like]	string Matches text using wildcards (? and *).
gebiedsnaam[not]	Array of strings Exclude matches; text
geometry	string GeoJSON \| GEOMETRY(...)
geometry[contains]	string GeoJSON \| GEOMETRY(...)
geometry[intersects]	string GeoJSON \| GEOMETRY(...)
geometry[isnull]	string Whether the field has a NULL value or not.
geometry[not]	string GeoJSON \| GEOMETRY(...)
id	integer Exact; number
id[gt]	integer Greater than; number
id[gte]	integer Greater than or equal to; number
id[in]	Array of integers Matches any value from a comma-separated list: val1,val2,valN.
id[isnull]	boolean Whether the field has a NULL value or not.
id[lt]	integer Less than; number
id[lte]	integer Less than or equal to; number
id[not]	Array of integers Exclude matches; number
oppervlakte	number Exact; number
oppervlakte[gt]	number Greater than; number
oppervlakte[gte]	number Greater than or equal to; number
oppervlakte[in]	Array of numbers Matches any value from a comma-separated list: val1,val2,valN.
oppervlakte[isnull]	boolean Whether the field has a NULL value or not.
oppervlakte[lt]	number Less than; number
oppervlakte[lte]	number Less than or equal to; number
oppervlakte[not]	Array of numbers Exclude matches; number
page	integer A page number within the paginated result set.
wijk	string Exact; text
wijk[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
wijk[isempty]	boolean Whether the field is empty or not.
wijk[isnull]	boolean Whether the field has a NULL value or not.
wijk[like]	string Matches text using wildcards (? and *).
wijk[not]	Array of strings Exclude matches; text
winkelgebiedcode	string Exact; text
winkelgebiedcode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
winkelgebiedcode[isempty]	boolean Whether the field is empty or not.
winkelgebiedcode[isnull]	boolean Whether the field has a NULL value or not.
winkelgebiedcode[like]	string Matches text using wildcards (? and *).
winkelgebiedcode[not]	Array of strings Exclude matches; text

header Parameters

Accept-Crs	string Accept-Crs header for Geo queries
Content-Crs	string Content-Crs header for Geo queries
X-Api-Key	string Api Key for statistical purposes, not for authentication

Responses

Response samples

Content type

application/hal+json

{"page": {"number": 3,
"size": 20,
"totalElements": 5,
"totalPages": 3
},
"_links": {"self": {"href": "https://api.data.amsterdam.nl/v1/.../resource/?page=3"
},
"next": {"href": "https://api.data.amsterdam.nl/v1/.../resource/?page=4"
},
"previous": {"href": "https://api.data.amsterdam.nl/v1/.../resource/?page=2"
}
},
"_embedded": {"winkelgebieden": [{"_links": {"schema": "http://example.com",
"self": {"href": "http://example.com",
"title": "string",
"id": -9223372036854776000
}
},
"id": -9223372036854776000,
"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"gebiedscode": "string",
"gebiedsnaam": "string",
"code": "string",
"oppervlakte": 0,
"winkelgebiedcode": "string",
"concentratiegebiedcode": "string",
"concentratiegebiednaam": "string",
"wijk": "string",
"gebied": "string",
"categorie": "string",
"categorienaam": "string"
}
]
}
}

winkelgebieden_winkelgebieden_retrieve_2

Authorizations:

oauth2

path Parameters

required

string^[^/]+$

query Parameters

_expand	boolean Allow to expand relations.
_expandScope	string Comma separated list of named relations to expand.
_fields	string Comma-separated list of fields to display
_format	string Enum: "json" "csv" "geojson" Select the export format
_sort	string Which field to use when ordering the results.
categorie	string Exact; text
categorie[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
categorie[isempty]	boolean Whether the field is empty or not.
categorie[isnull]	boolean Whether the field has a NULL value or not.
categorie[like]	string Matches text using wildcards (? and *).
categorie[not]	Array of strings Exclude matches; text
categorienaam	string Exact; text
categorienaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
categorienaam[isempty]	boolean Whether the field is empty or not.
categorienaam[isnull]	boolean Whether the field has a NULL value or not.
categorienaam[like]	string Matches text using wildcards (? and *).
categorienaam[not]	Array of strings Exclude matches; text
code	string Exact; text
code[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
code[isempty]	boolean Whether the field is empty or not.
code[isnull]	boolean Whether the field has a NULL value or not.
code[like]	string Matches text using wildcards (? and *).
code[not]	Array of strings Exclude matches; text
concentratiegebiedcode	string Exact; text
concentratiegebiedcode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
concentratiegebiedcode[isempty]	boolean Whether the field is empty or not.
concentratiegebiedcode[isnull]	boolean Whether the field has a NULL value or not.
concentratiegebiedcode[like]	string Matches text using wildcards (? and *).
concentratiegebiedcode[not]	Array of strings Exclude matches; text
concentratiegebiednaam	string Exact; text
concentratiegebiednaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
concentratiegebiednaam[isempty]	boolean Whether the field is empty or not.
concentratiegebiednaam[isnull]	boolean Whether the field has a NULL value or not.
concentratiegebiednaam[like]	string Matches text using wildcards (? and *).
concentratiegebiednaam[not]	Array of strings Exclude matches; text
gebied	string Exact; text
gebied[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebied[isempty]	boolean Whether the field is empty or not.
gebied[isnull]	boolean Whether the field has a NULL value or not.
gebied[like]	string Matches text using wildcards (? and *).
gebied[not]	Array of strings Exclude matches; text
gebiedscode	string Exact; text
gebiedscode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebiedscode[isempty]	boolean Whether the field is empty or not.
gebiedscode[isnull]	boolean Whether the field has a NULL value or not.
gebiedscode[like]	string Matches text using wildcards (? and *).
gebiedscode[not]	Array of strings Exclude matches; text
gebiedsnaam	string Exact; text
gebiedsnaam[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
gebiedsnaam[isempty]	boolean Whether the field is empty or not.
gebiedsnaam[isnull]	boolean Whether the field has a NULL value or not.
gebiedsnaam[like]	string Matches text using wildcards (? and *).
gebiedsnaam[not]	Array of strings Exclude matches; text
geometry	string GeoJSON \| GEOMETRY(...)
geometry[contains]	string GeoJSON \| GEOMETRY(...)
geometry[intersects]	string GeoJSON \| GEOMETRY(...)
geometry[isnull]	string Whether the field has a NULL value or not.
geometry[not]	string GeoJSON \| GEOMETRY(...)
id	integer Exact; number
id[gt]	integer Greater than; number
id[gte]	integer Greater than or equal to; number
id[in]	Array of integers Matches any value from a comma-separated list: val1,val2,valN.
id[isnull]	boolean Whether the field has a NULL value or not.
id[lt]	integer Less than; number
id[lte]	integer Less than or equal to; number
id[not]	Array of integers Exclude matches; number
oppervlakte	number Exact; number
oppervlakte[gt]	number Greater than; number
oppervlakte[gte]	number Greater than or equal to; number
oppervlakte[in]	Array of numbers Matches any value from a comma-separated list: val1,val2,valN.
oppervlakte[isnull]	boolean Whether the field has a NULL value or not.
oppervlakte[lt]	number Less than; number
oppervlakte[lte]	number Less than or equal to; number
oppervlakte[not]	Array of numbers Exclude matches; number
wijk	string Exact; text
wijk[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
wijk[isempty]	boolean Whether the field is empty or not.
wijk[isnull]	boolean Whether the field has a NULL value or not.
wijk[like]	string Matches text using wildcards (? and *).
wijk[not]	Array of strings Exclude matches; text
winkelgebiedcode	string Exact; text
winkelgebiedcode[in]	Array of strings Matches any value from a comma-separated list: val1,val2,valN.
winkelgebiedcode[isempty]	boolean Whether the field is empty or not.
winkelgebiedcode[isnull]	boolean Whether the field has a NULL value or not.
winkelgebiedcode[like]	string Matches text using wildcards (? and *).
winkelgebiedcode[not]	Array of strings Exclude matches; text

header Parameters

Accept-Crs	string Accept-Crs header for Geo queries
Content-Crs	string Content-Crs header for Geo queries
X-Api-Key	string Api Key for statistical purposes, not for authentication

Responses

Response samples

Content type

application/hal+json

{"_links": {"schema": "http://example.com",
"self": {"href": "http://example.com",
"title": "string",
"id": -9223372036854776000
}
},
"id": -9223372036854776000,
"geometry": {"type": "Point",
"coordinates": [0,
0
]
},
"gebiedscode": "string",
"gebiedsnaam": "string",
"code": "string",
"oppervlakte": 0,
"winkelgebiedcode": "string",
"concentratiegebiedcode": "string",
"concentratiegebiednaam": "string",
"wijk": "string",
"gebied": "string",
"categorie": "string",
"categorienaam": "string"
}