FacilityUse
This page describes the FacilityUse type.
Properties
Required properties
@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/facility-uses/12345"
location
Place
- or -
@id reference
The location at which the facility use will take place.
Example
"location": {
"@type": "Place",
"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"
}
provider
The organisation responsible for providing the facility
Example
"provider": {
"@type": "Organization",
"name": "Central Speedball Association",
"url": "http://www.speedball-world.com"
}
url
A URL to a web page (or section of a page) that describes the facility use.
Example
"url": "https://example.com/facility-use/1234"
Required options
Support for the facilityType property has been added to tooling and documentation ahead of inclusion in the next point release of the OpenActive Modelling Opportunity Data specification, as agreed on the W3C call 2021-06-02. On this basis of this discussion, following the next point release, only facilityType will be required.
facilityType
Array of Concept
Specifies the types of facility being described.
NOTE: this property has been added to tooling and documentation ahead of inclusion in the next point release of the OpenActive Modelling Opportunity Data specification, as agreed on the W3C call 2021-06-02.
Example
"facilityType": [
{
"@type": "Concept",
"@id": "https://openactive.io/facility-types#bba8ae59-d152-40bc-85cc-88c5375696d4",
"prefLabel": "Tennis Court",
"inScheme": "https://openactive.io/facility-types"
}
]
activity
Array of Concept
DEPRECATED: Use facilityType instead of activity within FacilityUse and IndividualFacilityUse, as the facilityType controlled vocabulary has been designed specifically for facilities.
Specifies the physical activity or activities that will take place during a facility use.
Example
"activity": [
{
"@type": "Concept",
"@id": "https://openactive.io/activity-list#c0360db0-a817-4bae-9167-40f89b49fc9e",
"prefLabel": "Badminton",
"inScheme": "https://openactive.io/activity-list"
}
]
Recommended properties
description
A plain text description of the facility use, which must not include HTML or other markup.
Example
"description": "An fast paced game that incorporates netball, handball and football."
image
Array of ImageObject
An image or photo that depicts the facility use, e.g. a photo taken at a previous event.
Example
"image": [
{
"thumbnail": "http://example.com/static/image/speedball_thumbnail.jpg",
"@type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}
]
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"
}
Optional properties
accessibilityInformation
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"
}
]
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"
]
attendeeInstructions
Provides additional notes and instructions for users of a facility, for example more information on how to find it, what to bring, etc. The value of this property must not include HTML or other markup.
Example
"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."
category
Provides a set of tags that help categorise and describe a facility.
Example
"category": [
{
"@type": "Concept",
"@id": "https://example.com/reference/categories#Top%20Club%20Level",
"inScheme": "https://example.com/reference/categories",
"prefLabel": "Top Club Level"
}
]
customerAccountBookingRestriction
Array of Text
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"
]
event
Array of Slot
An array of slots of availability of this FacilityUse.
Example
"event": [
{
"@type": "Slot",
"@id": "http://www.example.org/api/facility-uses/432#/event/2018-03-01T10:00:00Z",
"startDate": "2018-03-01T11:00:00Z",
"endDate": "2018-03-01T11:30:00Z",
"duration": "PT30M",
"remainingUses": 3,
"maximumUses": 6
}
]
identifier
Text
- or -
PropertyValue
- or -
Array of PropertyValue
- or -
Integer
A local non-URI identifier for the resource
Example
"identifier": "SB1234"
individualFacilityUse
Array of IndividualFacilityUse
Inverse of the oa:aggregateFacilityUse property. Relates a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location) to an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court).
Example
"individualFacilityUse": [
{
"@type": "IndividualFacilityUse",
"@id": "http://www.example.org/facility-uses/1/individual-facility-uses/1",
"name": "Tennis Court 1"
}
]
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"
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.
beta:facilityAttribute
Array of Concept
Attributes associated with the facility in use. See https://openactive.io/facility-attribute-list/.
beta:facilitySetting
Whether the event or facility is indoor or outdoor.
beta:facilityType
Array of Concept
DEPRECATED: Please use facilityType instead.
The type of facility in use. See https://openactive.io/facility-types/.
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: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:sportsActivityLocation
Array of SportsActivityLocation
Internal location of the event, e.g. Court 1
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 updated