Dataset

This page describes the Dataset 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 almost 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/Dataset, 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": "Dataset"
@id
 URL​
A unique url based identifier for the record

Example
"@id": "https://opendata.fusion-lifestyle.com/OpenActive/12345"
description
 Text​
A plain text description of the Dataset, which must not include HTML or other markup.

Example
"description": "Near real-time availability and rich descriptions relating to the sessions and facilities available from {OrganisationName}, published using the OpenActive Modelling Specification 2.0."
discussionUrl
 URL​
A URL that can be used to raise issues related to the Dataset via a public forum.

Example
"discussionUrl": "https://github.com/gladstonemrm/FusionLifestyle/issues"
distribution
 Array of DataDownload​
An array of feeds within the dataset

Example
"distribution": [
  {
    "@type": "DataDownload",
    "name": "FacilityUse",
    "additionalType": "https://openactive.io/FacilityUse",
    "encodingFormat": "application/vnd.openactive.rpde+json; version=1",
    "contentUrl": "https://opendata.leisurecloud.live/api/feeds/fusion-lifestyle-fl-live-facility-uses"
  }
]
documentation
 URL​
A link to documentation related to the Dataset, or a link to the OpenActive developer documentation if no Dataset-specific documentation is available.

Example
"documentation": "https://developer.openactive.io"
inLanguage
 Array of Text​
An array of languages included in the Dataset's content. Please use one of the language codes from the IETF BCP 47 standard.

Example
"inLanguage": [
  "en-GB"
]
keywords
 Array of Text​
Keywords for search engine optimisation

Example
"keywords": [
  "Sessions",
  "Facilities",
  "Activities",
  "Sports",
  "Physical Activity",
  "OpenActive"
]
license
 URL​
 Must always be present and set to "license": "https://creativecommons.org/licenses/by/4.0/"
name
 Text​
The name of the Dataset

Example
"name": "Acme Leisure Sessions and Facilities"
publisher
 Organization​
The organization ultimately responsible for this Dataset.

Example
"publisher": {
  "@type": "Organization",
  "name": "Central Speedball Association",
  "url": "http://www.speedball-world.com"
}
schemaVersion
 URL​
Indicates the version of OpenActive Modelling Opportunity Data Specification with which this Dataset conforms, by specifying its URL.

Example
"schemaVersion": "https://openactive.io/modelling-opportunity-data/2.0/"
url
 URL​
The URL of the dataset site.

Example
"url": "https://opendata.fusion-lifestyle.com/OpenActive/"
Recommended properties
Property
Expected Type
Description
backgroundImage
 ImageObject​
A background image for the Dataset.

Example
"backgroundImage": {
  "@type": "ImageObject",
  "url": "http://example.com/static/image/speedball_large.jpg"
}
dateModified
 DateTime​
The date this Dataset was last updated. For RPDE feeds this may simply be the date and time that the Dataset Site was rendered, which may be cached.

Example
"dateModified": "2018-01-27T12:00:00Z"
datePublished
 DateTime
 - or -
Date​
The date this Dataset 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
accessService
 WebAPI​
Information about the Open Booking API. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE.
bookingService
 BookingService​
Information about the Booking System or publishing platform
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".

DataDownload

DropdownFormFieldSpecification

Last updated 1 week ago

Property	Expected Type	Description
@type	`Text`	Must always be present and set to `"@type": "Dataset"`
@id	`URL`	A unique url based identifier for the record Example `"@id": "https://opendata.fusion-lifestyle.com/OpenActive/12345"`
description	`Text`	A plain text description of the `Dataset`, which must not include HTML or other markup. Example `"description": "Near real-time availability and rich descriptions relating to the sessions and facilities available from {OrganisationName}, published using the OpenActive Modelling Specification 2.0."`
discussionUrl	`URL`	A URL that can be used to raise issues related to the `Dataset` via a public forum. Example `"discussionUrl": "https://github.com/gladstonemrm/FusionLifestyle/issues"`
distribution	Array of `DataDownload`	An array of feeds within the dataset Example `"distribution": [ { "@type": "DataDownload", "name": "FacilityUse", "additionalType": "https://openactive.io/FacilityUse", "encodingFormat": "application/vnd.openactive.rpde+json; version=1", "contentUrl": "https://opendata.leisurecloud.live/api/feeds/fusion-lifestyle-fl-live-facility-uses" } ]`
documentation	`URL`	A link to documentation related to the `Dataset`, or a link to the OpenActive developer documentation if no Dataset-specific documentation is available. Example `"documentation": "https://developer.openactive.io"`
inLanguage	Array of `Text`	An array of languages included in the Dataset's content. Please use one of the language codes from the IETF BCP 47 standard. Example `"inLanguage": [ "en-GB" ]`
keywords	Array of `Text`	Keywords for search engine optimisation Example `"keywords": [ "Sessions", "Facilities", "Activities", "Sports", "Physical Activity", "OpenActive" ]`
license	`URL`	Must always be present and set to `"license": "https://creativecommons.org/licenses/by/4.0/"`
name	`Text`	The name of the `Dataset` Example `"name": "Acme Leisure Sessions and Facilities"`
publisher	`Organization`	The organization ultimately responsible for this `Dataset`. Example `"publisher": { "@type": "Organization", "name": "Central Speedball Association", "url": "http://www.speedball-world.com" }`
schemaVersion	`URL`	Indicates the version of OpenActive Modelling Opportunity Data Specification with which this `Dataset` conforms, by specifying its URL. Example `"schemaVersion": "https://openactive.io/modelling-opportunity-data/2.0/"`
url	`URL`	The URL of the dataset site. Example `"url": "https://opendata.fusion-lifestyle.com/OpenActive/"`

Property	Expected Type	Description
backgroundImage	`ImageObject`	A background image for the `Dataset`. Example `"backgroundImage": { "@type": "ImageObject", "url": "http://example.com/static/image/speedball_large.jpg" }`
dateModified	`DateTime`	The date this `Dataset` was last updated. For RPDE feeds this may simply be the date and time that the Dataset Site was rendered, which may be cached. Example `"dateModified": "2018-01-27T12:00:00Z"`
datePublished	`DateTime` - or - `Date`	The date this `Dataset` was first published. Can be specified as a schema:Date or schema:DateTime. Example `"datePublished": "2018-01-27T12:00:00Z"`