FacilityUse

This page describes the FacilityUse type.

Properties

Required properties

Property

Expected Type

Description

type

Text

Must always be present and set to "type": "FacilityUse"

activity

Array of Concept

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" } ]

location

Place

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" }

name

Text

The name of the facility use

Example

"name": "Speedball"

provider

Organization

The organisation responsible for providing the facility

Example

"provider": { "name": "Central Speedball Association", "@type": "Organization", "url": "http://www.speedball-world.com" }

url

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"

Property

Expected Type

Description

id

URL

A unique url based identifier for the record

Example

"id": "https://example.com/facility-use/112345"

description

Text

A free text description of the facility use

Example

"description": "An fast paced game that incorporates netball, handball and football."

hoursAvailable

Array of OpeningHoursSpecification

The times the facility use is available

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

Property

Expected Type

Description

accessibilityInformation

Text

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" } ]

attendeeInstructions

Text

Provides additional notes and instructions for users of a facility. E.g. more information on how to find it, what to bring, etc.

Example

"attendeeInstructions": "The tennis court is locked with a keycode, so please ensure you book online in advance to gain access."

category

Array of Concept - or - Array of Text

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" } ]

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", "name": "Tennis Court 1" } ]

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:facilitySetting

FacilitySettingType

Proposal #1

Whether the event or facility is indoor or outdoor.

beta:facilityType

Array of Concept

Proposal #1

The type of facility in use.

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.

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:sportsActivityLocation

Array of SportsActivityLocation

Proposal #110

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

beta:video

Array of VideoObject

Proposal #88

An 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".