ns-beta

Beta OpenActive Namespace Vocabulary Terms

This is the beta namespace for the OpenActive Vocabulary, as defined in the Modelling Opportunity Data Specification.

This namespace can be used by publishers experimenting with new properties that are likely to be added to the core specification.

It 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.

This namespace MUST be referenced using the URL "https://openactive.io/ns-beta" (which will return the JSON-LD definition if the Accept header contains application/ld+json), and is designed to be used in conjunction with the "https://openactive.io/" namespace.

Note that properties listed here must have associated proposals in one of the specification repositories. To suggest a new property, please file a proposal here.

Example use

{
  "@context": [
    "https://openactive.io/",
    "https://openactive.io/ns-beta"
  ],
  "type": "SessionSeries",
  "name": "Tai chi Class",
  "description": "You need to be strong to attend.",
  "beta:formattedDescription": "You need to be <b>strong</b> to attend.",
  "url": "http://www.example.org/events/1",
  "location": {
    "type": "Place",
    "name": "ExampleCo Gym Kingswood",
    "address": {
      "type": "PostalAddress",
      "streetAddress": "1 High Street",
      "addressLocality": "Kingswood",
      "addressRegion": "South Gloucestershire",
      "postalCode": "BS1 4SD",
      "addressCountry": "GB"
    }
  }
}

Namespace

Properties

(Class) Property Expected Type Proposal Description
(oa:FacilityUse)
beta:sportsActivityLocation
schema:SportsActivityLocation #110 The specific array of SportsActivityLocation related to the FacilityUse, usually within the location.
(schema:Course)
beta:logo
schema:ImageObject #164 An associated logo for a course.
(schema:CourseInstance)
beta:course
schema:Course #164 This course for which this is an offering.
(schema:Event)
beta:attendeeCount
schema:Integer #12 For events that have an unlimited number of tickets, captures the number of attendees (actual attendance).
(schema:Event)
beta:availability
schema:Text #9 For data publishers not wishing to disclose the granular availability of their sessions openly.
(schema:Event)
beta:distance
schema:QuantitativeValue #3 The distance of a run, cycle or other activity. Must also include units.
(schema:Event)
beta:estimatedDuration
schema:QuantitativeValue #201 A property that allows an Event duration to be represented as a range (e.g. 0-30mins, 30-60mins, 60-90mins, 90+).
(schema:Event)
beta:formattedDescription
schema:Text #2 Sometimes a description is stored with formatting (e.g. href, bold, italics, embedded YouTube videos). This formatting can be useful for data consumers.
(schema:Event)
beta:isWheelchairAccessible
schema:Boolean #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.
(schema:Event)
beta:registrationCount
schema:Integer #13 For events that have an unlimited number of tickets, captures the number of registrations (intention to attend).
(schema:Offer)
beta:availableChannel
beta:AvailableChannelType #161 The channels through which a booking can be made.

Classes

Class subClass Proposal Description
beta:AvailableChannelType schema:Enumeration #161 An enumeration of channels through which a booking can be made.

Enumeration Values

Type Value Proposal Description
beta:AvailableChannelType https://openactive.io/ns-beta#OnlinePrepayment #161 Bookings can be made and paid for online.
beta:AvailableChannelType https://openactive.io/ns-beta#OpenBookingPrepayment #161 Bookings can be made via the Open Booking API.
beta:AvailableChannelType https://openactive.io/ns-beta#TelephoneAdvanceBooking #161 Bookings can be made but not paid for in advance by telephone.
beta:AvailableChannelType https://openactive.io/ns-beta#TelephonePrepayment #161 Bookings can be made and paid for in advance by telephone.
schema:BusinessEntityType https://openactive.io/ns-beta#Member #80 Indicates that a customer (eligableCustomerType) is a member of the business.