Property

Expected Type

Description

@type

Text​

Must always be present and set to "@type": "Slot"

@id

URL​

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/slots/12345"

duration

Duration​

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

Example

"duration": "PT1H"

facilityUse

FacilityUse​

FacilityUse or IndividualFacilityUse that has this Slot, either directly embedded or referenced by its @id

Example

"facilityUse": "https://example.com/facility-use/1"

offers

Array of Offer​

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

Example

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

remainingUses

Integer​

The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.

Example

"remainingUses": 5

startDate

DateTime​

The start date and time of the slot.

Example

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

Property

Expected Type

Description

maximumUses

Integer​

The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.

Example

"maximumUses": 16

Property

Expected Type

Description

additionalAdmissionRestriction

Array of Text​

Free text restrictions that must be displayed prominently to the user before booking. This property must only contain restrictions not described by oa:ageRestriction or oa:genderRestriction.

Example

"additionalAdmissionRestriction": [ "Participants younger than 12 must be accompanied by an adult", "Participants must be comfortable standing for long periods of time" ]

endDate

DateTime​

The end date and time of the slot.

It is recommended that publishers provide either an schema:endDate or a schema:duration for an slot.

Example

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

identifier

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

A local non-URI identifier for the resource

Example

"identifier": "SB1234"

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": { "@type": "Organization", "@id": "https://id.bookingsystem.example.com/organizers/1", "name": "Central Speedball Association", "url": "http://www.speedball-world.com" }

Property

Expected Type

Description

beta:affiliatedLocation

Place​

​Proposal #227​

The physical location affiliated with the virtual event, for example the original location of the event before it was moved online.

beta:attendeeCount

Integer​

​Proposal #274​

For events that have an unlimited number of tickets, captures the number of attendees (actual attendance).

beta:bookingChannel

Array of BookingChannelType​

​Proposal #161​

The channels through which a booking can be made.

beta:contactPoint

ContactPoint​

​Proposal #113​

Contact details for an Event, where they are not specifically related to the organizer or leader.

beta:distance

QuantitativeValue​

​Proposal #275​

The distance of a run, cycle or other activity. Must also include units.

beta:donationPaymentUrl

URL​

​Proposal #234​

The URL of the webpage where the activity provider accepts donations.

beta:estimatedDuration

QuantitativeValue​

​Proposal #201​

A property that allows an Event duration to be represented as a range (e.g. 0-30mins, 30-60mins, 60-90mins, 90+).

beta:facilitySetting

FacilitySettingType​

​Proposal #1​

Whether the event or facility is indoor or outdoor.

beta:formattedDescription

Text​

​Proposal #276​

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.

beta:isFirstSessionAccessibleForFree

Boolean​

​Proposal #232​

A property that indicates whether the first session is free.

beta:isInteractivityPreferred

Boolean​

​Proposal #230​

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

Boolean​

​Proposal #71​

A property that indicates whether the event is led by a virtual coach. Only relevant if an event isCoached. If not provided is assumed to be false.

beta:isWheelchairAccessible

Boolean​

​Proposal #166​

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​

​Proposal #204​

Duration before the event for which the associated Offers are valid

beta:participantSuppliedEquipment

RequiredStatusType​

​Proposal #229​

Indicates whether the participant must or may supply equipment for use in the Event.

beta:registrationCount

Integer​

​Proposal #273​

For events that have an unlimited number of tickets, captures the number of registrations (intention to attend).

beta:sportsActivityLocation

Array of SportsActivityLocation​

​Proposal #110​

Internal location of the event, e.g. Court 1

beta:sportsActivityLocation

Array of SportsActivityLocation​

​Proposal #110​

Internal location of the event, e.g. Court 1

beta:video

Array of VideoObject​

​Proposal #88​

A related video object.

beta:virtualLocation

VirtualLocation​

​Proposal #224​

Describes a means of electronic access to a shared virtual space.