@openactive/data-models

{ "type": "Dataset", "derivedFrom": "https://schema.org/Dataset", "hasId": true, "sampleId": "https://opendata.fusion-lifestyle.com/OpenActive/", "validationMode": { "RPDEFeed": "noRequired", "BookableRPDEFeed": "noRequired", "DataCatalog": "noRequired", "C1Request": "noRequired", "C1Response": "noRequired", "C1ResponseOrderItemError": "noRequired", "C2Request": "noRequired", "C2Response": "noRequired", "C2ResponseOrderItemError": "noRequired", "PRequest": "noRequired", "PResponse": "noRequired", "PResponseOrderItemError": "noRequired", "BRequest": "noRequired", "BResponse": "noRequired", "BResponseOrderItemError": "noRequired", "OrderProposalPatch": "noRequired", "OrderPatch": "noRequired", "OrdersFeed": "noRequired", "OrderProposalsFeed": "noRequired", "OrderStatus": "noRequired" }, "imperativeConfiguration": { "noRequired": { "requiredFields": [], "recommendedFields": [] } }, "requiredFields": [ "id", "type", "url", "name", "description", "keywords", "license", "distribution", "discussionUrl", "documentation", "inLanguage", "publisher", "schemaVersion" ], "recommendedFields": [ "datePublished", "dateModified", "backgroundImage" ], "inSpec": [ "id", "type", "url", "name", "description", "keywords", "license", "distribution", "discussionUrl", "documentation", "inLanguage", "publisher", "dateModified", "datePublished", "schemaVersion", "backgroundImage", "bookingService", "accessService" ], "description": { "sections": [ { "title": "EARLY RELEASE NOTICE", "paragraphs": [ "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](https://openactive.io/dataset-api-discovery/EditorsDraft/) evolves." ] } ] }, "fields": { "type": { "fieldName": "type", "requiredType": "https://schema.org/Text", "requiredContent": "Dataset" }, "name": { "fieldName": "name", "sameAs": "https://schema.org/name", "requiredType": "https://schema.org/Text", "example": "Acme Leisure Sessions and Facilities", "description": [ "The name of the `Dataset`" ] }, "url": { "fieldName": "url", "sameAs": "https://schema.org/url", "requiredType": "https://schema.org/URL", "description": [ "The URL of the dataset site." ], "example": "https://opendata.fusion-lifestyle.com/OpenActive/" }, "description": { "fieldName": "description", "sameAs": "https://schema.org/description", "requiredType": "https://schema.org/Text", "example": "Near real-time availability and rich descriptions relating to the sessions and facilities available from {OrganisationName}, published using the OpenActive Modelling Specification 2.0.", "description": [ "A plain text description of the `Dataset`, which must not include HTML or other markup." ] }, "keywords": { "fieldName": "keywords", "sameAs": "https://schema.org/keywords", "requiredType": "ArrayOf#https://schema.org/Text", "example": [ "Sessions", "Facilities", "Activities", "Sports", "Physical Activity", "OpenActive" ], "description": [ "Keywords for search engine optimisation" ] }, "license": { "fieldName": "license", "sameAs": "https://schema.org/license", "requiredType": "https://schema.org/URL", "requiredContent": "https://creativecommons.org/licenses/by/4.0/", "example": "https://creativecommons.org/licenses/by/4.0/", "description": [ "The license under which the data is published. OpenActive data must be published under CC-BY 4.0." ] }, "distribution": { "fieldName": "distribution", "sameAs": "https://schema.org/distribution", "model": "ArrayOf#DataDownload", "example": [ { "@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" } ], "description": [ "An array of feeds within the dataset" ] }, "discussionUrl": { "fieldName": "discussionUrl", "sameAs": "https://schema.org/discussionUrl", "requiredType": "https://schema.org/URL", "example": "https://github.com/gladstonemrm/FusionLifestyle/issues", "description": [ "A URL that can be used to raise issues related to the `Dataset` via a public forum." ] }, "documentation": { "fieldName": "documentation", "sameAs": "https://pending.schema.org/documentation", "requiredType": "https://schema.org/URL", "example": "https://permalink.openactive.io/dataset-site/open-data-documentation", "description": [ "A link to documentation related to the `Dataset`, or a link to the OpenActive developer documentation using `https://permalink.openactive.io/dataset-site/open-data-documentation` if no Dataset-specific documentation is available." ] }, "inLanguage": { "fieldName": "inLanguage", "sameAs": "https://schema.org/inLanguage", "requiredType": "ArrayOf#https://schema.org/Text", "example": [ "en-GB" ], "description": [ "An array of languages included in the Dataset's content. Please use one of the language codes from the IETF BCP 47 standard." ] }, "publisher": { "fieldName": "publisher", "sameAs": "https://schema.org/publisher", "model": "#Organization", "description": [ "The organization ultimately responsible for this `Dataset`." ], "example": { "@type": "Organization", "name": "Central Speedball Association", "url": "http://www.speedball-world.com" } }, "dateModified": { "fieldName": "dateModified", "sameAs": "https://schema.org/dateModified", "requiredType": "https://schema.org/DateTime", "description": [ "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": "2018-01-27T12:00:00Z" }, "datePublished": { "fieldName": "datePublished", "sameAs": "https://schema.org/datePublished", "requiredType": "https://schema.org/DateTime", "alternativeTypes": [ "https://schema.org/Date" ], "description": [ "The date this `Dataset` was first published. Can be specified as a schema:Date or schema:DateTime." ], "example": "2018-01-27T12:00:00Z" }, "schemaVersion": { "fieldName": "schemaVersion", "sameAs": "https://schema.org/schemaVersion", "requiredType": "https://schema.org/URL", "example": "https://openactive.io/modelling-opportunity-data/2.0/", "description": [ "Indicates the version of OpenActive Modelling Opportunity Data Specification with which this `Dataset` conforms, by specifying its URL." ] }, "backgroundImage": { "fieldName": "backgroundImage", "sameAs": "https://openactive.io/backgroundImage", "model": "#ImageObject", "description": [ "A background image for the `Dataset`." ], "example": { "@type": "ImageObject", "url": "http://example.com/static/image/speedball_large.jpg" } }, "bookingService": { "fieldName": "bookingService", "sameAs": "https://openactive.io/bookingService", "model": "#BookingService", "description": [ "Information about the Booking System or publishing platform" ] }, "accessService": { "fieldName": "accessService", "sameAs": "http://www.w3.org/ns/dcat#accessService", "model": "#WebAPI", "description": [ "Information about the Open Booking API. Note this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE." ] } } }