Eindhoven Open Data Portal Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Eindhoven Open Data Portal Connector facilitates seamless integration with the Eindhoven Open Data API, providing access to municipal datasets from the City of Eindhoven, Netherlands. This connector acts as a proxy to streamline data retrieval, supporting actions for querying catalogs, datasets, records, and exporting data in formats like JSON, CSV, Parquet, GPX, and DCAT. It leverages ODSQL for filtering, sorting, and pagination, enabling urban planning, transport, and public service applications with real-time and historical data.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Eindhoven Open Data Portal Connector.

Supported Integration Action Points

getDatasets: Query catalog datasets.
listExportFormats: List export formats for the catalog.
exportDatasets: Export a catalog in the desired format.
exportCatalogCSV: Export a catalog in CSV.
exportCatalogDCAT: Export a catalog in RDF/XML (DCAT).
getDatasetsFacets: List facet values for datasets.
getRecords: Query dataset records.
listDatasetExportFormats: List export formats for a specific dataset.
exportRecords: Export a dataset in the desired format.
exportRecordsCSV: Export a dataset in CSV.
exportRecordsParquet: Export a dataset in Parquet.
exportRecordsGPX: Export a dataset in GPX.
getDataset: Show dataset information.
getRecordsFacets: List dataset facet values (records-level).
getDatasetAttachments: List dataset attachments.
getRecord: Read a single dataset record.

Detailed Integration Documentation

2.1 Get Datasets Retrieval

Action	getDatasets
Purpose	Retrieves available datasets from the Eindhoven catalog, optionally filtered and sorted using various parameters. Serves as the primary entry point for accessing municipal datasets, useful for building urban planning interfaces.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL` environment variable.
Parameters	Required: None Optional: select (string) – Fields to return (e.g., `dataset_id,title`). where (string) – ODSQL condition (e.g., `records_count > 1000`). order_by (string) – Sorting (e.g., `records_count DESC`). limit (integer, default: 10, max: 100) – Number of results. offset (integer, default: 0) – Offset for pagination. refine (string) – Refine by facet (e.g., `publisher:"Eindhoven"`). exclude (string) – Exclude by facet (e.g., `publisher:"Eindhoven"`). lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates. group_by (string) – Group results. include_links (boolean, default: true) – Include links. include_app_metas (boolean, default: false) – Include app metas.
Output	Successful: Returns a JSON object with: links – Array of navigation links. datasets – Array of dataset objects with metas, fields, etc. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Configure the connector with the appropriate base URL. Execute the `getDatasets` action with optional `where="records_count > 1000"` and `limit=20`. Process the response to list available Eindhoven datasets.

2.2 List Export Formats Retrieval

Action	listExportFormats
Purpose	Lists available export formats for the Eindhoven catalog. Helps users identify supported formats for bulk exports.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON object with: links – Array of export format links. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `listExportFormats` action. Review the response to identify available export formats. Use the formats for subsequent export actions.

2.3 Export Datasets Retrieval

Action	exportDatasets
Purpose	Exports the Eindhoven catalog in the desired format, optionally filtered using various parameters. Enables bulk data retrieval for urban analysis.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL` environment variable.
Parameters	Required: format (string) – Export format (e.g., csv, json). Optional: select (string) – Fields to return (e.g., `dataset_id,title`). where (string) – ODSQL condition (e.g., `records_count > 1000`). order_by (string) – Sorting (e.g., `records_count DESC`). group_by (string) – Group results. limit (integer) – Number of results. offset (integer, default: 0) – Offset for pagination. refine (string) – Refine by facet (e.g., `publisher:"Eindhoven"`). exclude (string) – Exclude by facet (e.g., `publisher:"Eindhoven"`). lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportDatasets` action with `format=json` and optional `where="records_count > 1000"`. Save the exported file for analysis. Use the data for Eindhoven urban reporting.

2.4 Export Catalog CSV Retrieval

Action	exportCatalogCSV
Purpose	Exports the Eindhoven catalog in CSV format, with specific configuration options for delimiters and quoting. Supports customized CSV exports for data processing.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL` environment variable.
Parameters	Required: None Optional: delimiter (string, enum: [;, ,, \t, \|], default: 😉 – Field delimiter. list_separator (string, default: ,) – Separator for multivalued strings. quote_all (boolean, default: false) – Force quoting all strings. with_bom (boolean, default: true) – Include Unicode BOM.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportCatalogCSV` action with optional `delimiter=,`. Save the CSV file. Import the data into spreadsheet applications.

2.5 Export Catalog DCAT Retrieval

Action	exportCatalogDCAT
Purpose	Exports the Eindhoven catalog in RDF/XML described with DCAT vocabulary, with options for including exports and using labels. Facilitates metadata interchange using standard vocabularies.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dcat_ap_format (string) – DCAT format variant (e.g., -ap). Optional: include_exports (string) – Datasets exports to expose (e.g., csv,json,geojson). use_labels_in_exports (boolean, default: true) – Use field labels in exports.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportCatalogDCAT` action with optional `include_exports=csv,json`. Save the RDF/XML file. Use the metadata for catalog integration.

2.6 Get Datasets Facets Retrieval

Action	getDatasetsFacets
Purpose	Enumerates facet values for Eindhoven datasets, optionally refined by parameters. Supports guided navigation in large result sets.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: None Optional: facet (string) – Facets to enumerate (e.g., publisher). refine (string) – Refine by facet (e.g., publisher:"Eindhoven"). exclude (string) – Exclude by facet (e.g., publisher:"Eindhoven"). where (string) – ODSQL condition (e.g., records_count > 1000). timezone (string, default: UTC) – Timezone for dates.
Output	Successful: Returns a JSON object with: links – Array of navigation links. facets – Array of facet enumerations with name, count, state, value. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `getDatasetsFacets` action with `facet=publisher`. Process the response to display facet values. Use the facets for refining Eindhoven data searches.

2.7 Get Records Retrieval

Action	getRecords
Purpose	Performs a query on Eindhoven dataset records, optionally filtered and sorted. Retrieves specific municipal data records from a dataset.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string, e.g., geonames-all-cities-with-a-population-1000) – Dataset identifier. Optional: select (string) – Fields to return (e.g., name,population). where (string) – ODSQL condition (e.g., population > 1000000). group_by (string) – Group results. order_by (string) – Sorting (e.g., population DESC). limit (integer, default: 10, max: 100) – Number of results. offset (integer, default: 0) – Offset for pagination. refine (string) – Refine by facet. exclude (string) – Exclude by facet. lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates. include_links (boolean, default: true) – Include links. include_app_metas (boolean, default: false) – Include app metas.
Output	Successful: Returns a JSON object with: total_count – Total number of records. results – Array of record objects. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `getRecords` action with `dataset_id=geonames-all-cities-with-a-population-1000` and optional `where="population > 1000000"`. Review the response to obtain record data. Use the records for Eindhoven urban analysis.

2.8 List Dataset Export Formats Retrieval

Action	listDatasetExportFormats
Purpose	Lists available export formats for a specific Eindhoven dataset. Helps users identify supported formats for dataset exports.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier (e.g., geonames-all-cities-with-a-population-1000). Optional: None
Output	Successful: Returns a JSON object with: links – Array of export format links. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `listDatasetExportFormats` action with `dataset_id=geonames-all-cities-with-a-population-1000`. Review the response to identify available export formats. Use the formats for dataset exports.

2.9 Export Records Retrieval

Action	exportRecords
Purpose	Exports an Eindhoven dataset in the desired format, optionally filtered using various parameters. Enables bulk data retrieval from a dataset in a specified format.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. format (string) – Export format (e.g., csv, json). Optional: select (string) – Fields to return. where (string) – ODSQL condition. order_by (string) – Sorting. group_by (string) – Group results. limit (integer) – Number of results. refine, exclude – Facet filters. lang, timezone – Language and timezone. use_labels (boolean, default: false) – Use field labels instead of names. compressed (boolean, default: false) – Compress output. epsg (integer) – EPSG code for spatial reference.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportRecords` action with `dataset_id=geonames-all-cities-with-a-population-1000`, `format=json`, and optional `where="population > 1000000"`. Save the exported file. Use the data for further processing.

2.10 Export Records CSV Retrieval

Action	exportRecordsCSV
Purpose	Exports an Eindhoven dataset in CSV format, with options for delimiters and quoting. Supports customized CSV exports for dataset records.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: delimiter (string, enum: [;, ,, \t, \|], default: 😉 – Field delimiter. list_separator (string, default: ,) – Separator for multivalued strings. quote_all (boolean, default: false) – Force quoting all strings. with_bom (boolean, default: true) – Include Unicode BOM.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportRecordsCSV` action with `dataset_id=geonames-all-cities-with-a-population-1000` and optional `delimiter=,`. Save the CSV file. Import the data into analysis tools.

2.11 Export Records Parquet Retrieval

Action	exportRecordsParquet
Purpose	Exports an Eindhoven dataset in Parquet format, with options for compression. Supports efficient storage and querying of large municipal datasets.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: parquet_compression (string, enum: [snappy, zstd], default: snappy) – Compression algorithm.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportRecordsParquet` action with `dataset_id=geonames-all-cities-with-a-population-1000` and optional `parquet_compression=zstd`. Save the Parquet file. Use the data in big data processing frameworks.

2.12 Export Records GPX Retrieval

Action	exportRecordsGPX
Purpose	Exports an Eindhoven dataset in GPX format, with options for name and description fields. Supports geospatial data export for GPS and urban mapping applications.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: name_field (string) – Field for GPX name attribute. description_field_list (string) – Fields for GPX description. use_extension (boolean, default: true) – Use extension tag for attributes.
Output	Successful: Returns a file. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `exportRecordsGPX` action with `dataset_id=geonames-all-cities-with-a-population-1000` and optional `name_field=name`. Save the GPX file. Use the data in mapping or navigation tools.

2.13 Get Dataset Retrieval

Action	getDataset
Purpose	Returns information about a specific Eindhoven dataset, including metadata and endpoints. Provides detailed dataset metadata for urban application integration.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: select (string, e.g., metas,title) – Fields to return. lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates. include_links (boolean, default: true) – Include links. include_app_metas (boolean, default: false) – Include app metas.
Output	Successful: Returns a JSON object with: dataset_id – Dataset identifier. metas – Object with default metadata (records_count, modified, etc.). fields – Array of field objects (label, type, name, etc.). features – Array of features (e.g., analyze, geo). Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).

2.14 Get Records Facets Retrieval

Action	getRecordsFacets
Purpose	Enumerates facet values for records in a specific Eindhoven dataset, returning a list of values for each facet. Helps implement guided navigation or drill-down filters in large datasets.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: facet (string) – Facet field to enumerate (e.g., cou_name_en). refine (string) – Refine by facet (e.g., timezone:"Europe/Paris"). exclude (string) – Exclude by facet (e.g., timezone:"America"). where (string) – ODSQL condition (e.g., population > 1000000). lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates.
Output	Successful: links – Array of navigation links. facets – Array of facet enumerations (name, facets list with count, state, name, value). Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `getRecordsFacets` action with `dataset_id=geonames-all-cities-with-a-population-1000` and `facet=cou_name_en`. Process the response to display country facets. Use the facet values to refine record searches interactively.

2.15 Get Dataset Attachments Retrieval

Action	getDatasetAttachments
Purpose	Returns a list of all available attachments for a specified Eindhoven dataset. Supports file downloads such as ZIPs, reports, or supplementary datasets.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. Optional: None
Output	Successful: links – Array of navigation links. attachments – Array of attachment objects (href, metas including mime-type, title, url, id). Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `getDatasetAttachments` action with `dataset_id=geonames-all-cities-with-a-population-1000`. Review the response to list available files (e.g., cities1000.zip). Download the attachment for offline data use or archiving.

2.16 Get Record Retrieval

Action	getRecord
Purpose	Reads a single dataset record from a specific Eindhoven dataset using its unique identifier. Enables precise record lookup or detail view in applications.
Configuration	Ensure the connector is configured with the base URL via `CONNECTOR_ENV_EINDHOVENOPENDATA_BASE_URL`.
Parameters	Required: dataset_id (string) – Dataset identifier. record_id (string) – Record identifier. Optional: select (string, e.g., name,population,timezone) – Fields to return. lang (string, default: en) – Language for labels. timezone (string, default: UTC) – Timezone for dates.
Output	Successful: Returns a JSON object representing the record with: Field values (e.g., name, population, timezone, etc.). Metadata such as _id, _timestamp, _links. Failure: Returns error details (e.g., `message`, `error_code: ODSQLError`).
Workflow Example	Execute the `getRecord` action with `dataset_id=geonames-all-cities-with-a-population-1000` and `record_id=2798031`. Review the record details (e.g., city information for “Fraire”). Display or process the retrieved record in your application.

Workflow Creation with the Connector

Example Workflow: Urban Infrastructure Planning

Retrieve Datasets	Use the `getDatasets` action with optional `refine=publisher:"Eindhoven"` to fetch a list of available municipal datasets. Identify target datasets (e.g., `geonames-all-cities-with-a-population-1000`).
Query Dataset Information	Execute the `getDataset` action with `dataset_id=geonames-all-cities-with-a-population-1000` to fetch dataset metadata. Process the response to understand fields and features.
Fetch Records	Use the `getRecords` action with `dataset_id=geonames-all-cities-with-a-population-1000` and optional `where="population > 1000000"` to retrieve records. Display the records in a user interface.
Perform Data Export	Use the `exportRecords` action with `dataset_id=geonames-all-cities-with-a-population-1000`, `format=csv`, and optional `where="population > 1000000"` to export data. Integrate the exported data into infrastructure planning or archiving applications.

This workflow enables applications to provide users with accurate Eindhoven dataset exploration, querying, and export capabilities, enhancing urban development and decision-making.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking