OpenActive Developers
Data ValidatorDataset DashboardW3C Community Group
  • Welcome to our community
  • Publishing Data
    • Data Feeds
      • How an RPDE data feed works
      • Types of RDPE feed
      • Implementing RPDE
      • Testing RPDE feeds
      • Scaling RPDE feeds
    • Activity list references
    • Including geo coordinates
    • Schedules
    • Dataset Sites
    • Virtual Events
    • On-Demand Events
    • Opening Hours
    • Data Quality
  • Using data
    • Harvesting opportunity data
      • Large Integers in JavaScript
    • Tutorial: Consuming an RPDE feed
    • Attribution
  • Open Booking API
    • Key Decisions
    • Implementing booking
    • Testing booking
      • Configuring Test Suite
      • Implementing the Test Interface
        • Test Interface Actions
        • Create Opportunity Endpoint
      • Random Mode: Generating Test Opportunity Data
      • Running Test Suite
      • Generating the Conformance Certificate
  • Data Model
    • Data Model Overview
    • @context and JSON-LD
    • Types Reference
      • Action
      • AudioObject
      • BabyChanging
      • Barcode
      • BookingService
      • BooleanFormFieldSpecification
      • Brand
      • ChangingFacilities
      • ConceptScheme
      • Concept
      • CourseInstance
      • Course
      • Creche
      • CustomerAccount
      • DataCatalog
      • DataDownload
      • Dataset
      • DropdownFormFieldSpecification
      • DynamicPayment
      • Entitlement
      • EventSeries
      • Event
      • FacilityUse
      • FileUploadFormFieldSpecification
      • GeoCoordinates
      • HeadlineEvent
      • ImageObject
      • IndividualFacilityUse
      • InternalApplicationError
      • InternalLibraryConfigurationError
      • InternalLibraryError
      • Lease
      • LocationFeatureSpecification
      • Lockers
      • MediaObject
      • OfferOverride
      • Offer
      • OnDemandEvent
      • OpenBookingError
      • OpeningHoursSpecification
      • OrderItem
      • OrderProposal
      • OrderQuote
      • Order
      • Organization
      • ParagraphFormFieldSpecification
      • Parking
      • PartialSchedule
      • Payment
      • Person
      • Place
      • PostalAddress
      • PriceSpecification
      • PrivacyPolicy
      • PropertyValueSpecification
      • PropertyValue
      • QuantitativeValue
      • Schedule
      • ScheduledSession
      • SessionSeries
      • ShortAnswerFormFieldSpecification
      • Showers
      • Slot
      • SportsActivityLocation
      • TaxChargeSpecification
      • TermsOfUse
      • Terms
      • Toilets
      • Towels
      • VideoObject
      • VirtualLocation
      • WebAPI
  • Specifications
    • Specifications Overview
  • Useful links
    • Data Visualiser
    • Data Validator
    • Dataset Dashboard
    • Non-technical Guidance
  • OpenActive on GitHub
    • Overview
    • Activity List
    • Community
    • Controlled Vocabularies
    • Dataset Publication
    • Documentation
    • Implementation Support
    • Programmes
    • RPDE
    • SKOS
    • Specifications
    • Validators
Powered by GitBook
On this page
  • EARLY RELEASE NOTICE
  • Properties
  • Required properties
  • Required options
  • Recommended properties
  • Optional properties
Edit on GitHub
  1. Data Model
  2. Types Reference

DataCatalog

This page describes the DataCatalog type.

PreviousCustomerAccountNextDataDownload

Last updated 11 months ago

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 evolves.

This type is derived from , 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

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

@id

A unique URI-based identifier for the record.

The primary purpose of the URI format in this context is to provide natural namespacing for the identifier. Hence, the URI itself may not resolve to a valid endpoint, but must use a domain name controlled by the resource owner (the organisation responsible for the OpenActive open data feed).

Example

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

license

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

name

The name of the DataCatalog

Example

"name": "Acme Leisure Sessions and Facilities"

publisher

The organization ultimately responsible for maintaining this DataCatalog.

Example

"publisher": { "@type": "Organization", "name": "Central Speedball Association", "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

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

The URLs of the dataset sites within this DataCatalog.

Example

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

Recommended properties

Property
Expected Type
Description

datePublished

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

dateModified

The date this DataCatalog was last updated.

Example

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

@id properties are used as identifiers for compatibility with JSON-LD. The value of such a property must always be an absolute URI that provides a stable globally unique identifier for the resource, as described in .

Array of

Array of

- or -

Except as otherwise noted, the content of this page is licensed under the , and code samples are licensed under the , for anyone to access, use and share; using attribution "".

Dataset API Discovery specification
https://schema.org/DataCatalog
Creative Commons Attribution License (CC-BY V4.0)
MIT License
OpenActive
Text
URL
RFC3986
URL
Text
Organization
URL
URL
DateTime
Date
DateTime