CourseInstance
This type is derived from https://schema.org/CourseInstance, 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.
Property | Expected Type | Description |
type | | Must always be present and set to |
activity | Array of | Specifies the physical activity or activities that will take place during an event. Example
|
location | The location at which the event will take place. Or, in the case of events that may span multiple locations, the initial meeting or starting point. It is recommended that locations should be specified as a Place complete with a fully described geographic location and/or address. If only an address is available then this should be described as a PostalAddress. Applications may use schema:Text to provide a more general description of a location ("In Victoria Park, near the lake"), but this is not recommended: consuming applications will be unable to help users discover opportunities based on their location. Example
| |
name | | The name of the event Example
|
offers | Array of | An array of schema:Offer that include the price of attending. Example
|
organizer | | The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person. Example
|
url | | A URL to a web page (or section of a page) that describes the event. Example
|
While these properties are marked as optional in the specification, a data publisher must provide either a startDate or specify an eventSchedule for an event.
Property | Expected Type | Description |
startDate | The start date and time of the event. Can be specified as a schema:Date or schema:DateTime. Example
| |
eventSchedule | Array of | A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern. Example
|
Property | Expected Type | Description |
id | | A unique url based identifier for the record Example
|
ageRange | Indicates that an event is suitable for a specific age range. If only a single age is specified then this is assumed to be a minimum age. Age ranges can be specified as follows: 18-30 Example
| |
description | | A free text description of the event Example
|
endDate | The end date and time of the event. Can be specified as a schema:Date or schema:DateTime It is recommended that publishers provide either an schema:endDate or a schema:duration for an event. Example
| |
eventStatus | The status of an event. Can be used to indicate rescheduled or cancelled events Example
| |
genderRestriction | Indicates that an event is restricted to male, female or a mixed audience. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience Example
| |
image | Array of | An image or photo that depicts the event, e.g. a photo taken at a previous event. Example
|
leader | Array of | Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data. Example
|
level | A general purpose property for specifying the suitability of an event for different participant “levels”. E.g. Example
| |
maximumAttendeeCapacity | The maximum capacity of the Event. Example
| |
remainingAttendeeCapacity | The number of places that are still available for the Event. Example
| |
startDate | The start date and time of the event. Can be specified as a schema:Date or schema:DateTime. Example
|
Property | Expected Type | Description |
accessibilityInformation | | Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event. Example
|
accessibilitySupport | Array of | Used to specify the types of disabilities or impairments that are supported at an event. Example
|
attendeeInstructions | | Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc. Example
|
category | Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc. Example
| |
contributor | Array of | A Person who contributes to the facilitation of the Event. Example
|
duration | The duration of the event given in [ISO8601] format. Example
| |
eventAttendanceMode | The eventAttendanceMode of an event indicates whether it occurs online, offline, or a mix. Example
| |
eventSchedule | Array of | A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern. Example
|
identifier | | A local non-URI identifier for the resource Example
|
isAccessibleForFree | Whether the Event is accessible without charge. Example
| |
isCoached | A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day. Example
| |
maximumVirtualAttendeeCapacity | Indicates the maximum number of connections to a shared virtual space. Example
| |
meetingPoint | | Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions. Example
|
programme | Indicates that an event will be organised according to a specific Programme. Example
| |
schedulingNote | | Provides a note from an organizer relating to how this Event is scheduled. Example
|
subEvent | Array of | Relates a parent event to a child event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A child event might be a specific instance of an Event within a schedule |
superEvent | Relates a child event to a parent event. Properties describing the parent event can be assumed to apply to the child, unless otherwise specified. A parent event might specify a recurring schedule, of which the child event is one specific instance |
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:affiliatedLocation | The physical location affiliated with the virtual event, for example the original location of the event before it was moved online. | |
beta:attendeeCount | For events that have an unlimited number of tickets, captures the number of attendees (actual attendance). | |
beta:course | This course for which this is an offering. | |
beta:distance | The distance of a run, cycle or other activity. Must also include units. | |
beta:donationPaymentUrl | | The URL of the webpage where the activity provider accepts donations. |
beta:estimatedDuration | A property that allows an Event duration to be represented as a range (e.g. 0-30mins, 30-60mins, 60-90mins, 90+). | |
beta:facilitySetting | Whether the event or facility is indoor or outdoor. | |
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. |
beta:isFirstSessionAccessibleForFree | A property that indicates whether the first session is free. | |
beta:isInteractivityPreferred | Indicates whether the virtual event is interactive (e.g. Zoom with participant microphones and cameras on), or is just a one-way broadcast (e.g. Facebook Live, Instagram Live, Zoom with participant microphones and cameras off). | |
beta:isVirtuallyCoached | A property that indicates whether the event is led by a virtual coach. Only relevant if an event | |
beta:isWheelchairAccessible | A property that details whether the event is suitable for wheelchair access. Placed on Event as this field could be used to detail whether the Event is suitable, as well as the Place. | |
beta:offerValidityPeriod | Duration before the event for which the associated Offers are valid | |
beta:participantSuppliedEquipment | Indicates whether the participant must or may supply equipment for use in the Event. | |
beta:registrationCount | For events that have an unlimited number of tickets, captures the number of registrations (intention to attend). | |
beta:sportsActivityLocation | Array of | Internal location of the event, e.g. Court 1 |
beta:video | Array of | An related video object. |
beta:virtualLocation | Describes a means of electronic access to a shared virtual space. |
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".
