DataCatalog

This page describes the DataCatalog type.

EARLY RELEASE NOTICE

This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. It is mostly stable, as it based entirely on schema.org. HOWEVER, IT IS STILL SUBJECT TO CHANGE, as the Dataset API Discovery specification evolves.

This type is derived from https://schema.org/DataCatalog, which means that any of this type's properties within schema.org may also be used. Note however the properties on this page must be used in preference if a relevant property is available.

Properties

Required properties

Property

Expected Type

Description

@type

Text

Must always be present and set to "@type": "DataCatalog"

@id

URL

A unique url based identifier for the record

Example

"@id": "https://opendata.leisurecloud.live/api/datacatalog12345"

license

URL

Must always be present and set to "license": "https://creativecommons.org/licenses/by/4.0/"

name

Text

The name of the DataCatalog

Example

"name": "Acme Leisure Sessions and Facilities"

publisher

Organization

The organization ultimately responsible for maintaining this DataCatalog.

Example

"publisher": { "name": "Central Speedball Association", "type": "Organization", "url": "http://www.speedball-world.com" }

Required options

The DataCatalog must include either hasPart if it is a collection of smaller DataCatalogs, or dataset if it is a collection of dataset sites.

Property

Expected Type

Description

hasPart

Array of URL

The URLs of each smaller DataCatalog within this DataCatalog collection.

Example

"hasPart": [ "https://opendata.leisurecloud.live/api/datacatalog", "https://openactivedatacatalog.legendonlineservices.co.uk/api/DataCatalog" ]

dataset

Array of URL

The URLs of the dataset sites within this DataCatalog.

Example

"dataset": [ "https://opendata.exercise-anywhere.com/", "https://www.participant.co.uk/participant/openactive/" ]

Property

Expected Type

Description

datePublished

DateTime - or - Date

The date this DataCatalog was first published. Can be specified as a schema:Date or schema:DateTime.

Example

"datePublished": "2018-01-27T12:00:00Z"

Optional properties

Property

Expected Type

Description

dataset

Array of URL

The URLs of the dataset sites within this DataCatalog.

Example

"dataset": [ "https://opendata.exercise-anywhere.com/", "https://www.participant.co.uk/participant/openactive/" ]

dateModified

DateTime

The date this DataCatalog was last updated.

Example

"dateModified": "2018-01-27T12:00:00Z"

hasPart

Array of URL

The URLs of each smaller DataCatalog within this DataCatalog collection.

Example

"hasPart": [ "https://opendata.leisurecloud.live/api/datacatalog", "https://openactivedatacatalog.legendonlineservices.co.uk/api/DataCatalog" ]

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution License (CC-BY V4.0), and code samples are licensed under the MIT License, for anyone to access, use and share; using attribution "OpenActive".