Property

Expected Type

Description

type

Text​

Must always be present and set to "type": "CourseInstance"

activity

Array of Concept​

Specifies the physical activity or activities that will take place during an event.

Example

"activity": [ { "type": "Concept", "id": "https://openactive.io/activity-list#5e78bcbe-36db-425a-9064-bf96d09cc351", "prefLabel": "Bodypump™", "inScheme": "https://openactive.io/activity-list" } ]

location

Place​

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

"location": { "address": { "addressLocality": "New Malden", "addressRegion": "London", "postalCode": "NW5 3DU", "streetAddress": "Raynes Park High School, 46A West Barnes Lane", "type": "PostalAddress" }, "description": "Raynes Park High School in London", "geo": { "latitude": 51.4034423828125, "longitude": -0.2369088977575302, "type": "GeoCoordinates" }, "id": "https://example.com/locations/1234ABCD", "identifier": "1234ABCD", "name": "Raynes Park High School", "telephone": "01253 473934", "type": "Place" }

name

Text​

The name of the event

Example

"name": "Speedball"

offers

Array of Offer​

An array of schema:Offer that include the price of attending.

Example

"offers": [ { "type": "Offer", "identifier": "OX-AD", "name": "Adult", "price": 3.3, "priceCurrency": "GBP", "url": "https://profile.everyoneactive.com/booking?Site=0140&Activities=1402CBP20150217&Culture=en-GB" } ]

organizer

Organization - or - Person​

The person or organization ultimately responsible for an event. An organizer might be an schema:Organization or a schema:Person.

Example

"organizer": { "name": "Central Speedball Association", "type": "Organization", "url": "http://www.speedball-world.com" }

url

URL​

A URL to a web page (or section of a page) that describes the event.

Example

"url": "https://example.com/event/1234"

Property

Expected Type

Description

startDate

DateTime - or - Date​

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.

Example

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

eventSchedule

Array of Schedule​

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.

Example

"eventSchedule": [ { "type": "PartialSchedule", "repeatFrequency": "P1W", "startTime": "20:15", "endTime": "20:45", "byDay": [ "http://schema.org/Tuesday" ] } ]

Property

Expected Type

Description

id

URL​

A unique url based identifier for the record

Example

"id": "https://example.com/event/12345"

ageRange

QuantitativeValue​

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

"ageRange": { "type": "QuantitativeValue", "minValue": 15, "maxValue": 60 }

description

Text​

A free text description of the event

Example

"description": "An fast paced game that incorporates netball, handball and football."

endDate

DateTime - or - Date​

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

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

eventStatus

EventStatusType​

The status of an event. Can be used to indicate rescheduled or cancelled events

Example

"eventStatus": "https://schema.org/EventScheduled"

genderRestriction

GenderRestrictionType​

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

"genderRestriction": "https://openactive.io/FemaleOnly"

image

Array of ImageObject​

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" } ] } ]

leader

Array of Person​

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

"leader": [ { "type": "Person", "familyName": "Smith", "givenName": "Nicole", "gender": "https://schema.org/Male", "id": "https://example.com/locations/1234ABCD/leaders/89", "identifier": 89 } ]

level

Array of Text - or - Array of Concept​

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" ]

maximumAttendeeCapacity

Integer​

The maximum capacity of the Event.

Example

"maximumAttendeeCapacity": 30

remainingAttendeeCapacity

Integer​

The number of places that are still available for the Event.

Example

"remainingAttendeeCapacity": 20

startDate

DateTime - or - Date​

The start date and time of the event. Can be specified as a schema:Date or schema:DateTime.

Example

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

Property

Expected Type

Description

@context

URL - or - Array of URL​

This must be included in the top-most entity in the JSON model.

Example

"@context": "https://openactive.io/"

accessibilityInformation

Text​

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

Array of Concept​

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" } ]

attendeeInstructions

Text​

Provides additional notes and instructions for event attendees. E.g. more information on how to find the event, what to bring, etc.

Example

"attendeeInstructions": "Ensure you bring trainers and a bottle of water."

category

Array of Concept - or - Array of Text​

Provides a set of tags that help categorise and describe an event, e.g. its intensity, purpose, etc.

Example

"category": [ "High Intensity" ]

contributor

Array of Person​

A Person who contributes to the facilitation of the Event.

Example

"contributor": [ { "type": "Person", "familyName": "Smith", "givenName": "Nicole", "id": "https://example.com/locations/1234ABCD/leaders/89", "identifier": 89 } ]

duration

Duration​

The duration of the event given in [ISO8601] format.

Example

"duration": "PT1H"

eventSchedule

Array of Schedule​

A an array of oa:Schedule or oa:PartialSchedule, which represents a recurrence pattern.

Example

"eventSchedule": [ { "type": "PartialSchedule", "repeatFrequency": "P1W", "startTime": "20:15", "endTime": "20:45", "byDay": [ "http://schema.org/Tuesday" ] } ]

identifier

Text - or - PropertyValue - or - Array of PropertyValue - or - Integer​

A local non-URI identifier for the resource

Example

"identifier": "SB1234"

isAccessibleForFree

Boolean​

Whether the Event is accessible without charge.

Example

"isAccessibleForFree": "true"

isCoached

Boolean​

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

"isCoached": "true"

meetingPoint

Text​

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

"meetingPoint": "At the entrance to the park"

potentialAction

Array of Action​

The possible actions that a user may make. e.g. Book.

Example

"potentialAction": [ { "name": "Book", "target": { "encodingType": "application/vnd.openactive.v1.0+json", "httpMethod": "POST", "type": "EntryPoint", "url": "https://example.com/orders" }, "type": "Action" } ]

programme

Brand​

Indicates that an event will be organised according to a specific Programme.

Example

"programme": { "type": "Brand", "name": "Play Ball!", "url": "http://example.org/brand/play-ball" }

schedulingNote

Text​

Provides a note from an organizer relating to how this Event is scheduled.

Example

"schedulingNote": "This event doesn't run during school holidays"

subEvent

Array of Event​

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

Event​

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