Publishing Data
Using data
Open Booking API
Data Model
Specifications
Place
This page describes the Place type.
This type is derived from https://schema.org/Place, 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
Required options
While these properties are marked as recommended in the specification, a data publisher must provide as much detail in both
address and geo for an event as possible.Property
Expected Type
Description
address
A structured PostalAddress object for the Place.
Ideally the address should be provided using the PostalAddress structured format. Google Reserve requires https://schema.org/PostalAddress and will not accept plain text addresses.
Example
"address": {
"@type": "PostalAddress",
"streetAddress": "Raynes Park High School, 46A West Barnes Lane",
"addressLocality": "New Malden",
"addressRegion": "London",
"postalCode": "NW5 3DU",
"addressCountry": "GB"
}geo
The geo coordinates of the Place.
Example
"geo": {
"latitude": 51.4034423828125,
"longitude": -0.2369088977575302,
"@type": "GeoCoordinates"
}Recommended 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://id.bookingsystem.example.com/places/12345"amenityFeature
An array listing the Ammenities of the Place.
Example
"amenityFeature": [
{
"name": "Changing Facilities",
"value": true,
"@type": "ChangingFacilities"
},
{
"name": "Showers",
"value": false,
"@type": "Showers"
},
{
"name": "Lockers",
"value": true,
"@type": "Lockers"
},
{
"name": "Towels",
"value": false,
"@type": "Towels"
},
{
"name": "Creche",
"value": false,
"@type": "Creche"
},
{
"name": "Parking",
"value": true,
"@type": "Parking"
}
]description
A plain text description of the Place, which must not include HTML or other markup.
Example
"description": "Raynes Park High School in London"image
An image or photo that depicts the place, 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"
}
]Optional properties
Property
Expected Type
Description
containedInPlace
The place within which this Place exists
Example
"containedInPlace": {
"@type": "Place",
"url": "https://www.everyoneactive.com/centres/Middlesbrough-Sports-Village",
"name": "Middlesbrough Sports Village"
}containsPlace
Places that exist within this place
Example
"containsPlace": {
"@type": "Place",
"url": "https://www.everyoneactive.com/centres/Center-Parcs-Sports-Plaza",
"name": "Center Parcs Sports Plaza"
}identifier
A local non-URI identifier for the resource
Example
"identifier": "SB1234"specialOpeningHoursSpecification
Explicitly override general opening hours brought in scope by
schema:openingHoursSpecification.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: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.
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 1mo ago