Catalog Card
Purpose
A catalog card is a structured metadata object returned by the Fetch Single Catalog request. It describes a single catalog that is registered in Dateno.
Catalog cards provide detailed technical and organizational metadata about the catalog, including access mode, supported endpoints, geographic coverage, owner information, and software used. They enable developers and applications to explore catalog structure, capabilities, and integration options.
Catalogs are referenced in dataset descriptors and dataset cards via the source
object. In these contexts, only a brief summary of the catalog is provided. To retrieve full details, your application can call the Fetch Single Catalog request using the uid
value.
Structure
A catalog card is a JSON object with the following standard top-level properties.
Property | Description |
---|---|
uid | Catalog unique identifier |
id | Internal symbolic identifier used in URLs and internal logic |
name | Human-readable name of the catalog |
link | URL of the catalog's home page |
catalog_type | Classification label describing the type of the catalog (e.g., Geoportal) |
status | Operational status (e.g., active , unreachable ) |
properties | Object with catalog-specific boolean flags (e.g., transferable_location ) |
tags | List of metadata keywords (not a directory entry) |
topics | List of topical directory entries |
langs | Languages supported by the catalog (as directory entries) |
access_mode | List of strings describing accessibility (e.g., open , restricted ) |
content_types | List of content types provided (e.g., dataset , service ) |
coverage | Geographic coverage using directory entries for country, subregion, macroregion |
api | Boolean indicating whether the catalog provides a usable API |
api_status | API availability status (e.g., active , broken ) |
endpoints | List of declared API endpoints |
identifiers | List of catalog identifiers in external registries |
software | Object describing the catalog software used |
owner | Object describing the owning organization |
Nested Objects
software
Describes the software platform used by the catalog.
Property | Description |
---|---|
id | Internal identifier |
name | Software name |
owner
Describes the organization that owns the catalog.
Property | Description |
---|---|
name | Name of the organization |
link | Link to the organization’s website |
type | Organization type (a directory entry) |
location | Geographic location with country, subregion, macroregion (all directory entries) |
coverage
Describes the catalog’s geographic coverage using directory-based location components.
Each location
object includes the following properties.
Property | Description |
---|---|
country | Country as a directory entry |
subregion | Subregion as a directory entry |
macroregion | Macroregion as a directory entry |
level | Numeric level indicating administrative granularity |
macroregion | Macroregion (directory entry) |
level | Numeric level indicating administrative granularity |
endpoints
Each endpoint describes a machine-accessible API.
Property | Description |
---|---|
type | Endpoint type (e.g., ckan ) |
url | API URL |
version | API version |
identifiers
External references to the catalog.
Property | Description |
---|---|
id | Registry name (e.g., re3data ) |
url | Link to the external registry entry |
value | Identifier value in the registry |
Example
{
"uid": "cdi00000310",
"id": "openalbertaca",
"name": "Government of Alberta open datasets",
"link": "https://open.alberta.ca",
"catalog_type": "Open data portal",
"status": "active",
"properties": {
"transferable_location": true
},
"tags": [
"government",
"has_api"
],
"topics": [
{
"id": "REGI",
"name": "Regions and cities",
"type": "eudatatheme"
}
],
"langs": [
{
"id": "EN",
"name": "English"
}
],
"access_mode": [
"open"
],
"content_types": [
"dataset"
],
"coverage": [
{
"location": {
"country": {
"id": "CA",
"name": "Canada"
},
"subregion": {
"id": "CA-AB",
"name": "Alberta"
},
"macroregion": {
"id": "021",
"name": "Northern America"
},
"level": 30
}
}
],
"api": true,
"api_status": "active",
"endpoints": [
{
"type": "ckan:package-search",
"url": "https://open.alberta.ca/api/3/action/package_search",
"version": "3"
},
{
"type": "ckan",
"url": "https://open.alberta.ca/api/3",
"version": "3"
}
],
"identifiers": [
{
"id": "re3data",
"url": "https://www.re3data.org/repository/r3d100012944",
"value": "r3d100012944"
}
],
"software": {
"id": "ckan",
"name": "CKAN"
},
"owner": {
"name": "Government of Alberta",
"link": "https://alberta.ca",
"type": "Regional government",
"location": {
"country": {
"id": "CA",
"name": "Canada"
},
"subregion": {
"id": "CA-AB",
"name": "Alberta"
},
"macroregion": null,
"level": 30
}
}
}