City of Zurich 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 City of Zurich Open Data Portal Connector facilitates seamless integration with the City of Zurich Open Data Portal API, powered by CKAN v3. This connector enables access to 834 datasets covering topics such as government, transport, economy, society, environment, and technology from the City of Zurich, Switzerland. It supports dataset searches, metadata retrieval, resource access, and DCAT exports in JSON, Turtle, XML, and JSON-LD formats, with optional API token authentication for modifying actions, streamlining urban data applications.

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the City of Zurich Open Data Portal Connector.
Supported Integration Action Points

packageListGet: List all dataset IDs.
packageSearchGet: Search for datasets.
packageShow: Retrieve details for a specific dataset.
resourceShow: Retrieve details for a specific resource.
catalogJson: Export catalog in DCAT JSON.
catalogTtl: Export catalog in Turtle RDF.
catalogXml: Export catalog in XML RDF.
catalogJsonld: Export catalog in JSON-LD.

Detailed Integration Documentation

2.1 Package List Get Retrieval

Action	packageListGet
Purpose	Retrieves a list of all dataset (package) IDs in the Zurich Open Data Portal, supporting pagination for catalog exploration. Serves as the primary entry point for discovering available datasets.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable. Optionally, provide an API token for authentication via the Authorization header.
Parameters	Required: None Optional: limit (integer, 0-1000) – Maximum number of results. offset (integer, min: 0) – Starting index for pagination.
Output	Successful: Returns a JSON object with: success – True. result – Array of dataset IDs (strings). help – Action documentation. Failure: Returns error details (e.g., success: false, error with message and `__type`).
Workflow Example	Configure the connector with the appropriate base URL and optional API token. Execute the `packageListGet` action with `limit=50`. Process the response to list dataset IDs for further queries.

2.2 Package Search Get Retrieval

Action	packageSearchGet
Purpose	Searches for datasets using Solr query syntax, supporting faceting, sorting, and pagination. Enables targeted discovery of Zurich-specific datasets like transport or environment.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable. Optionally, provide an API token for authentication.
Parameters	Required: None Optional: q (string, default: ":") – Full-text search query. fq (string, e.g., "tags:transport") – Filter query. sort (string, default: "metadata_modified desc") – Sort order. rows (integer) – Number of results. start (integer) – Pagination start. facet.field (string) – Facet fields. facet.limit (integer) – Facet limit.
Output	Successful: Returns a JSON object with: success – True. result – Object with `count`, `facets` (title and items array), and `results` (array of package objects with id, name, title, notes, resources, tags, groups). help – Action documentation. Failure: Returns error details (e.g., 400: Bad request).
Workflow Example	Execute the `packageSearchGet` action with `q=transport` and `rows=20`. Review search results and facets. Use for filtering datasets by topic.

2.3 Package Show Retrieval

Action	packageShow
Purpose	Retrieves detailed information for a specific dataset, including resources, tags, and metadata. Supports evaluation for urban applications like transport planning.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable. Optionally, provide an API token for authentication.
Parameters	Required: id (string) – Dataset ID or name. Optional: include_private (boolean) – Include private datasets.
Output	Successful: Returns a JSON object with: success – True. result – Package object (id, name, title, notes, resources array with url, format, description; tags array; groups array; license_id; metadata_created, metadata_modified). help – Action documentation. Failure: Returns error details (e.g., 404: Dataset not found).
Workflow Example	Execute the `packageShow` action with `id=transport-dataset-id`. Review package details and resources. Use for data integration planning.

2.4 Resource Show Retrieval

Action	resourceShow
Purpose	Retrieves details for a specific resource within a dataset, such as URL and format, enabling direct data access.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable. Optionally, provide an API token for authentication.
Parameters	Required: id (string) – Resource ID. Optional: None
Output	Successful: Returns a JSON object with: success – True. result – Resource object (id, url, format, description, hash, mimetype, size, created, last_modified). help – Action documentation. Failure: Returns error details (e.g., 404: Resource not found).
Workflow Example	Execute the `resourceShow` action with `id=resource-id`. Retrieve the resource URL for download. Use for fetching specific data files.

2.5 Catalog JSON Retrieval

Action	catalogJson
Purpose	Exports the entire Zurich Open Data catalog metadata in DCAT JSON format for interoperability and catalog integration.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns a JSON object with DCAT catalog data. Failure: Returns error details.
Workflow Example	Execute the `catalogJson` action. Save the DCAT JSON file. Use for metadata harvesting.

2.6 Catalog TTL Retrieval

Action	catalogTtl
Purpose	Exports the catalog metadata in Turtle RDF format for semantic web applications.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns RDF Turtle data. Failure: Returns error details.
Workflow Example	Execute the `catalogTtl` action. Process the Turtle file. Use for linked data integration.

2.7 Catalog XML Retrieval

Action	catalogXml
Purpose	Exports the catalog metadata in XML RDF format for standardized metadata exchange.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns RDF XML data. Failure: Returns error details.
Workflow Example	Execute the `catalogXml` action. Save the XML file. Use for catalog federation.

2.8 Catalog JSON-LD Retrieval

Action	catalogJsonld
Purpose	Exports the catalog metadata in JSON-LD format for modern web and semantic applications.
Configuration	Ensure the connector is configured with the base URL via the `CONNECTOR_ENV_ZURICHOPENDATAPORTAL_BASE_URL` environment variable.
Parameters	Required: None Optional: None
Output	Successful: Returns JSON-LD object with `@context` and `@graph`. Failure: Returns error details.
Workflow Example	Execute the `catalogJsonld` action. Process the JSON-LD file. Use for API documentation or semantic queries.

Workflow Creation with the Connector

Example Workflow: Urban Transport Data Analysis

List and Search Datasets	Use the `packageListGet` action to fetch all dataset IDs. Execute the `packageSearchGet` action with `q=transport` to find relevant datasets.
Retrieve Dataset and Resource Details	Use the `packageShow` action with a selected dataset ID to get metadata. Use the `resourceShow` action to access data files.
Export Catalog Metadata	Use the `catalogJson` action to export DCAT metadata for integration. Integrate data into a GCP dashboard for transport trend analysis.

This workflow enables applications to provide users with access to Zurich’s open data, enhancing urban planning, transport optimization, and public service insights.

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