Publishing Data
Using data
Open Booking API
Data Model
Specifications
Slot
This page describes the Slot type.
This type is derived from https://schema.org/Event, 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
Required 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/slots/12345"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
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
The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.
Example
"remainingUses": 5startDate
The start date and time of the slot.
Example
"startDate": "2018-01-27T12:00:00Z"Recommended properties
Property
Expected Type
Description
maximumUses
The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.
Example
"maximumUses": 16Optional properties
Property
Expected Type
Description
additionalAdmissionRestriction
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"
]customerAccountBookingRestriction
Free text restrictions to display to the Customer at the browse stage, that may apply when using a Customer Account to make the booking.
Note that this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the Customer Accounts proposal evolves.
Example
"customerAccountBookingRestriction": [
"Gold members only",
"Gym induction required"
]endDate
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
A local non-URI identifier for the resource
Example
"identifier": "SB1234"isOpenBookingWithCustomerAccountAllowed
Indicates that a Customer Account may be used to book that opportunity.
Note that this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the Customer Accounts proposal evolves.
Example
"isOpenBookingWithCustomerAccountAllowed": "true"organizer
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"
}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: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:bookingChannel
The channels through which a booking can be made.
beta:contactPoint
Contact details for an Event, where they are not specifically related to the
organizer or leader.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. This property must contain HTML.
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
isCoached. If not provided is assumed to be false.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
Internal location of the event, e.g. Court 1
beta:sportsActivityLocation
Internal location of the event, e.g. Court 1
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".
Last modified 2mo ago