Publishing Data
Using data
Open Booking API
Data Model
Specifications
Course
This page describes the Course type.
This type is derived from https://schema.org/Course, 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
Optional properties
Property
Expected Type
Description
@id
A unique URI-based identifier for the record.
@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 RFC3986.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://api.example.com/courses/12345"accessibilityInformation
Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.
Example
"accessibilityInformation": "This route has been British Cycling assessed as an accessible route, meaning it is suitable for the majority of adaptive bikes. The route will have no or low levels of traffic, there will be plenty of space and will have a good surface throughout. If you have any questions about using this route on an adaptive bike on this ride, please use visit https://www.letsride.co.uk/accessibility or call 0123 456 7000 and ask for the Recreation team."accessibilitySupport
Used to specify the types of disabilities or impairments that are supported at an event.
Example
"accessibilitySupport": [
{
"@type": "Concept",
"@id": "https://openactive.io/accessibility-support#1393f2dc-3fcc-4be9-a99f-f1e51f5ad277",
"prefLabel": "Visual impairment",
"inScheme": "https://openactive.io/accessibility-support"
}
]activity
Specifies the physical activity or activities that will take place during a Course.
Example
"activity": [
{
"@id": "https://openactive.io/activity-list#fbdc35a8-3dd0-40ee-a7ca-6ff40b3e5f90",
"@type": "Concept",
"prefLabel": "Netball",
"inScheme": "https://openactive.io/activity-list"
}
]ageRange
Indicates that an event is recommended as being suitable for or is targetted at a specific age range.
Example
"ageRange": {
"@type": "QuantitativeValue",
"minValue": 50,
"maxValue": 60
}author
The person or organization who designed the Course. An author might be an schema:Organization or a schema:Person.
This property may reference the
@id of the organizer of the CourseInstance within which this Course is embedded, to reduce data duplication.
Example
"author": {
"@type": "Organization",
"@id": "https://id.bookingsystem.example.com/organizers/1",
"name": "Central Speedball Association",
"url": "http://www.speedball-world.com"
}category
Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.
Example
"category": [
"High Intensity"
]description
A plain text description of the Course, which must not include HTML or other markup.
Example
"description": "Netball Youth Camps give junior netballers the chance to get together with their friends and take to the court in the holidays!The camp is a non-residential holiday camp providing ‘Nothing but Netball’; not only will there be top quality coaching and fun netball activities but there is even an opportunity to meet and be inspired by an elite player.If you are a junior netball lover (or the parent of one!) these are an unmissable holiday activity."genderRestriction
Indicates that an event is restricted to male, female or a mixed audience. This information must be displayed prominently to the user before booking. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience.
Example
"genderRestriction": "https://openactive.io/FemaleOnly"identifier
A local non-URI identifier for the resource
Example
"identifier": "BR1234"image
An image or photo that depicts the event, e.g. a photo taken at a previous event.
Example
"image": [
{
"@type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg",
"thumbnail": [
{
"@type": "ImageObject",
"url": "http://example.com/static/image/speedball_thumbnail.jpg"
}
]
}
]level
A general purpose property for specifying the suitability of an event for different participant “levels”. E.g.
Beginner, Intermediate, Advanced. Or in the case of martial arts, specific belt requirements.
Example
"level": [
"Beginner"
]url
A definitive canonical URL for the Course.
Example
"url": "http://www.speedball-world.com/beginners-course"Beta Extension properties
These properties are defined in the OpenActive Beta Extension. The OpenActive Beta Extension is defined as a convenience to help document properties that are in active testing and review by the community. Publishers should not assume that properties in the beta namespace will either be added to the core specification or be included in the namespace over the long term.
Property
Expected Type
Description
beta:formattedDescription
Sometimes a description is stored with formatting (e.g. href, bold, italics, embedded YouTube videos). This formatting can be useful for data consumers. This property must contain HTML.
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".
Last modified 3mo ago
Copy link