Catalog card

Purpose

A catalog card is a structured metadata object returned by the GET /registry/catalog/{catalog_id} endpoint of the Dateno REST API.

It describes a single data catalog registered in Dateno and exposes its technical and organisational metadata: access mode, supported endpoints, geographic coverage, owning organisation and software stack. This allows applications to understand how the catalog works and how it can be integrated.

Catalogs are referenced from dataset descriptors and dataset cards via the source object. In those contexts only a short summary of the catalog is available. To obtain the full catalog information, clients should call GET /registry/catalog/{catalog_id} with the uid value from source.

Structure

A catalog card is a JSON object with the following top-level properties.

Property	Description
`uid`	Stable unique identifier of the catalog (e.g. `cdi00002809`)
`id`	Internal slug-like identifier used in URLs and internal logic
`name`	Human-readable name of the catalog
`link`	URL of the catalog’s main web page
`catalog_type`	Classification label for the catalog type (e.g. `Geoportal`)
`status`	Operational status (e.g. `active`, `unreachable`)
`properties`	Object with catalog-specific boolean flags (e.g. `has_doi`)
`api`	Boolean flag indicating whether the catalog exposes a machine-usable API
`api_status`	Status of the catalog API (e.g. `active`, `broken`)
`access_mode`	List of strings describing access (e.g. `open`, `restricted`)
`langs`	List of languages supported by the catalog (directory entries)
`tags`	List of free-text metadata keywords
`topics`	List of subject-matter directory entries describing what the catalog covers
`content_types`	List of content types (e.g. `dataset`, `map_layer`, `service`)
`coverage`	List of geographic coverage objects (see `coverage` below)
`endpoints`	List of declared API endpoints (see `endpoints` below)
`identifiers`	List of identifiers of the catalog in external registries (may be empty)
`owner`	Object describing the owning organisation (see `owner` below)
`software`	Object describing the software platform used by the catalog

Some properties may be empty lists or null when the information is not available.

Nested objects

`software`

Describes the software platform backing the catalog.

Property	Description
`id`	Internal identifier (e.g. `arcgishub`, `ckan`)
`name`	Human-readable software name (e.g. `ArcGIS Hub`)

`owner`

Describes the organisation that owns or operates the catalog.

Property	Description
`name`	Name of the organisation
`link`	URL of the organisation’s web site
`type`	Organisation type (directory entry, e.g. `Regional government`)
`location`	Geographic location of the organisation (see below)

The location object inside owner has the same shape as in coverage: country, subregion, macroregion and level.

`coverage`

Each item in the coverage list describes the geographic coverage of the catalog.

Property	Description
`location`	Object describing the covered area
`location.country`	Country as a directory entry (`id`, `name`)
`location.subregion`	Sub-national region as a directory entry
`location.macroregion`	Macro-region as a directory entry (may be `null` if not applicable)
`location.level`	Numeric level indicating the administrative granularity

`endpoints`

Each element in the endpoints list describes a machine-accessible API or feed.

Property	Description
`type`	Endpoint type (e.g. `dcatap201`, `ckan`, `ogcrecordsapi`, `rss`)
`url`	URL of the API endpoint or feed
`version`	Optional version string; may be `null`

`identifiers`

External references to the catalog in third-party registries.

Property	Description
`id`	Registry identifier (e.g. `re3data`)
`url`	URL of the catalog record in the external registry
`value`	Identifier value of the catalog in that registry

Example

The following example is a real catalog card returned from the test environment for the catalog cdi00000310 (“Government of Alberta open datasets”):

{
  "id": "openalbertaca",
  "uid": "cdi00000310",
  "name": "Government of Alberta open datasets",
  "link": "https://open.alberta.ca",
  "catalog_type": "Open data portal",
  "properties": {
    "transferable_location": true
  },
  "api": true,
  "api_status": "active",
  "access_mode": [
    "open"
  ],
  "langs": [
    {
      "id": "EN",
      "name": "English"
    }
  ],
  "tags": [
    "government",
    "has_api",
    "open data",
    "datasets",
    "alberta",
    "public sector"
  ],
  "content_types": [
    "dataset"
  ],
  "coverage": [
    {
      "location": {
        "country": {
          "id": "CA",
          "name": "Canada"
        },
        "level": 30,
        "subregion": {
          "id": "CA-AB",
          "name": "Alberta"
        },
        "macroregion": {
          "id": "021",
          "name": "Northern America"
        }
      }
    }
  ],
  "endpoints": [
    {
      "type": "ckan:package-search",
      "url": "https://open.alberta.ca/api/3/action/package_search",
      "version": "3"
    },
    {
      "type": "ckan:package-list",
      "url": "https://open.alberta.ca/api/3/action/package_list",
      "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"
    },
    {
      "id": "dataportals.org",
      "url": "http://dataportals.org/portal/alberta_ca",
      "value": "alberta_ca"
    }
  ],
  "owner": {
    "name": "Government of Alberta",
    "link": "https://alberta.ca",
    "type": "Regional government",
    "location": {
      "country": {
        "id": "CA",
        "name": "Canada"
      },
      "level": 30,
      "subregion": {
        "id": "CA-AB",
        "name": "Alberta"
      },
      "macroregion": null
    }
  },
  "software": {
    "id": "ckan",
    "name": "CKAN"
  },
  "status": "active",
  "topics": [
    {
      "id": "REGI",
      "name": "Regions and cities",
      "type": "eudatatheme"
    },
    {
      "id": "GOVE",
      "name": "Government and public sector",
      "type": "eudatatheme"
    },
    {
      "id": "SOCI",
      "name": "Population and society",
      "type": "eudatatheme"
    },
    {
      "id": "ECON",
      "name": "Economy and finance",
      "type": "eudatatheme"
    },
    {
      "id": "Society",
      "name": "Society",
      "type": "iso19115"
    },
    {
      "id": "Economy",
      "name": "Economy",
      "type": "iso19115"
    }
  ]
}

Purpose​

Structure​

Nested objects​

software​

owner​

coverage​

endpoints​

identifiers​

Example​