FacilityUse
This page describes the FacilityUse type.
Properties
Required properties
| Property | Expected Type | Description |
|---|---|---|
@type | Must always be present and set to | |
@id | A unique URI-based identifier for the record.
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
| |
location |
| The location at which the facility use will take place. Example
|
name | The name of the facility use Example
| |
provider | The organisation responsible for providing the facility Example
| |
url | A URL to a web page (or section of a page) that describes the facility use. Example
|
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.
| Property | Expected Type | Description |
|---|---|---|
facilityType | Array of | 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
|
activity | Array of | DEPRECATED: Use Specifies the physical activity or activities that will take place during a facility use. Example
|
Recommended properties
| Property | Expected Type | Description |
|---|---|---|
description | A plain text description of the facility use, which must not include HTML or other markup. Example
| |
hoursAvailable | Array of | The times the facility use is available |
image | Array of | An image or photo that depicts the facility use, e.g. a photo taken at a previous event. Example
|
offers | Array of | An array of schema:Offer that include the price of booking. Example
|
Optional properties
| Property | Expected Type | Description |
|---|---|---|
accessibilityInformation | Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event. Example
| |
accessibilitySupport | Array of | Used to specify the types of disabilities or impairments that are supported at an event. Example
|
additionalAdmissionRestriction | Array of | Free text restrictions that must be displayed prominently to the user before booking. This property must only contain restrictions not described by Example
|
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
| |
category | Provides a set of tags that help categorise and describe a facility. Example
| |
customerAccountBookingRestriction | Array of | 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
|
event | Array of | An array of slots of availability of this FacilityUse. Example
|
identifier |
| A local non-URI identifier for the resource Example
|
individualFacilityUse | Array of | 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
|
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
|
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:bookingChannel | Array of | The channels through which a booking can be made. |
beta:facilityAttribute | Array of | 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 | DEPRECATED: Please use 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 | Internal location of the event, e.g. Court 1 |
beta:video | Array of | A related video object. |
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