Publishing Data
Using data
Open Booking API
Data Model
Specifications
Person
This page describes the Person type.
This type is derived from https://schema.org/Person, 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
Optional 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/people/12345"description
A plain text description of the Person, which must not include HTML or other markup.
Example
"description": "The leader of the coaching team"email
The e-mail address of the person.
This person must have given permission for their personal information to be shared as part of the open data.
Example
"email": "[email protected]"familyName
A last name for the person.
This person must have given permission for their personal information to be shared as part of the open data.
Example
"familyName": "Thompson"gender
Indicates the gender of the person. While
https://schema.org/Male and https://schema.org/Female may be used, text strings are also acceptable for people who do not identify as a binary gender.
Example
"gender": "https://schema.org/Female"givenName
A first name for the person.
This person must have given permission for their personal information to be shared as part of the open data.
Example
"givenName": "Daley"hasAccount
Reference to the CustomerAccount associated with this Customer, for use within the Open Booking API flow.
Note that this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the Customer Accounts proposal evolves.
identifier
A local non-URI identifier for the resource
Example
"identifier": "SB1234"isOpenBookingAllowed
Indicates whether the Seller allows open booking
Example
"isOpenBookingAllowed": "true"jobTitle
The job title of a person
This person must have given permission for their personal information to be shared as part of the open data.
Example
"jobTitle": "Team Captain"legalName
The official name of the organization, e.g. the registered company name.
Example
"legalName": "Central Speedball Ltd"logo
A logo for the person.
Example
"logo": {
"@type": "ImageObject",
"url": "http://example.com/static/image/speedball_large.jpg"
}name
A full name for the person.
This person must have given permission for their personal information to be shared as part of the open data.
Example
"name": "Daley Thompson"sameAs
Lists the URL(s) of the official social media profile pages associated with the person.
Example
"sameAs": "https://example.org/example-org"telephone
The telephone number of the person
This person must have given permission for their personal information to be shared as part of the open data.
Example
"telephone": "01234 567890"url
A URL where more information about the person may be found
Example
"url": "http://www.example.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:formalCriteriaMet
An array of URLs, each of which describe the formal criteria that are met by the organizer.
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 2mo ago
Copy link