Skip to main content

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.

PropertyDescription
uidCatalog unique identifier
idInternal symbolic identifier used in URLs and internal logic
nameHuman-readable name of the catalog
linkURL of the catalog's home page
catalog_typeClassification label describing the type of the catalog (e.g., Geoportal)
statusOperational status (e.g., active, unreachable)
propertiesObject with catalog-specific boolean flags (e.g., transferable_location)
tagsList of metadata keywords (not a directory entry)
topicsList of topical directory entries
langsLanguages supported by the catalog (as directory entries)
access_modeList of strings describing accessibility (e.g., open, restricted)
content_typesList of content types provided (e.g., dataset, service)
coverageGeographic coverage using directory entries for country, subregion, macroregion
apiBoolean indicating whether the catalog provides a usable API
api_statusAPI availability status (e.g., active, broken)
endpointsList of declared API endpoints
identifiersList of catalog identifiers in external registries
softwareObject describing the catalog software used
ownerObject describing the owning organization

Nested Objects

software

Describes the software platform used by the catalog.

PropertyDescription
idInternal identifier
nameSoftware name

owner

Describes the organization that owns the catalog.

PropertyDescription
nameName of the organization
linkLink to the organization’s website
typeOrganization type (a directory entry)
locationGeographic 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.

PropertyDescription
countryCountry as a directory entry
subregionSubregion as a directory entry
macroregionMacroregion as a directory entry
levelNumeric level indicating administrative granularity
macroregionMacroregion (directory entry)
levelNumeric level indicating administrative granularity

endpoints

Each endpoint describes a machine-accessible API.

PropertyDescription
typeEndpoint type (e.g., ckan)
urlAPI URL
versionAPI version

identifiers

External references to the catalog.

PropertyDescription
idRegistry name (e.g., re3data)
urlLink to the external registry entry
valueIdentifier 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
}
}
}