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
@type
 Text​
 Must always be present and set to "@type": "Slot"
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"
Required options
While these properties are marked as optional/recommended in the Modelling Specification, one of these must be provided when surfacing a slot through an RPDE feed to ensure that the slots can be processed correctly by data consumers.
Property
Expected Type
Description
@id
 URL​
A unique url based identifier for the record

Example
"@id": "https://example.com/slot/12345"
identifier
 Text
 - or -
PropertyValue
 - or -
Array of PropertyValue
 - or -
Integer​
A local non-URI identifier for the resource

Example
"identifier": "SB1234"
Recommended properties
Property
Expected Type
Description
@id
 URL​
A unique url based identifier for the record

Example
"@id": "https://example.com/slot/12345"
maximumUses
 Integer​
The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.

Example
"maximumUses": 16
Optional properties
Property
Expected Type
Description
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",
  "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
 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 #12​
For events that have an unlimited number of tickets, captures the number of attendees (actual attendance).
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 #3​
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 #2​
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 #13​
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.
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".

Showers

TaxChargeSpecification

Last updated 4 weeks ago

Property	Expected Type	Description
@type	`Text`	Must always be present and set to `"@type": "Slot"`
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
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", "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 #12 For events that have an unlimited number of tickets, captures the number of attendees (actual attendance).
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 #3 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 #2 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 #13 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.