OpenActive Namespace Vocabulary Terms
This document describes the vocabulary used in the Modelling Opportunity Data specification.
BrokerType
AgentBroker
Enumerated value of BrokerType
NoBroker
ResellerBroker
GenderRestrictionType
Enumerated types for gender restrictions that are applied to Events
NoRestriction
Enumerated value of GenderRestrictionType
MaleOnly
FemaleOnly
OrderCreationStatus
OrderCreationPaymentAuthorized
Enumerated value of OrderCreationStatus
OrderCreationPaymentCaptured
OrderCreationComplete
OrderCreationPaymentDue
OrderProposalStatus
AwaitingSellerConfirmation
Enumerated value of OrderProposalStatus
SellerAccepted
SellerRejected
CustomerRejected
RequiredStatusType
Required
Enumerated value of RequiredStatusType
Optional
Unavailable
TaxMode
TaxGross
Enumerated value of TaxMode
TaxNet
OpenBookingFlowRequirement
OpenBookingIntakeForm
Enumerated value of OpenBookingFlowRequirement
OpenBookingAttendeeDetails
OpenBookingApproval
OpenBookingNegotiation
OpenBookingMessageExchange
OrderItemStatus
SellerCancelled
Enumerated value of OrderItemStatus
CustomerCancelled
OrderItemConfirmed
AttendeeAttended
AttendeeAbsent
BabyChanging
BookingService
BooleanFormFieldSpecification
CancellationNotPermittedError
ChangingFacilities
Creche
CustomerAccount
DropdownFormFieldSpecification
DynamicPayment
Entitlement
FacilityUse
FileUploadFormFieldSpecification
GoneError
HeadlineEvent
IncompleteAttendeeDetailsError
IncompleteBrokerDetailsError
IncompleteCustomerDetailsError
IncompleteIntakeFormError
IncompleteOrderItemError
IncompletePaymentDetailsError
IndividualFacilityUse
InternalApplicationError
InternalLibraryConfigurationError
InternalLibraryError
InternalOpenBookingError
InvalidAPITokenError
InvalidAuthorizationDetailsError
InvalidIntakeFormError
InvalidOpportunityOrOfferIdError
InvalidPaymentDetailsError
Lease
Lockers
MethodNotAllowedError
MissingPaymentDetailsError
NoAPITokenError
NotFoundError
OfferOverride
OpenBookingError
OpportunityCapacityIsReservedByLeaseError
OpportunityHasInsufficientCapacityError
OpportunityIntractableError
OpportunityIsFullError
OpportunityIsInConflictError
OpportunityOfferPairNotBookableError
OrderAlreadyExistsError
OrderCreationFailedError
OrderItemIdInvalidError
OrderItemNotWithinOrderError
OrderProposal
OrderProposalVersionOutdatedError
OrderQuote
ParagraphFormFieldSpecification
Parking
PartialSchedule
PatchContainsExcessivePropertiesError
PatchNotAllowedOnPropertyError
Payment
PrivacyPolicy
ScheduledSession
SellerMismatchError
SellerNotFoundError
SessionSeries
ShortAnswerFormFieldSpecification
Showers
Slot
TaxChargeSpecification
TemporarilyUnableToCreateOrderError
TemporarilyUnableToDeleteOrderError
TemporarilyUnableToProduceOrderQuoteError
TemporarilyUnableToUpdateOrderError
Terms
TermsOfUse
Toilets
TooManyRequestsError
TotalPaymentDueMismatchError
Towels
UnableToProcessOrderItemError
UnacceptableOfferError
UnauthenticatedError
UnexpectedOrderTypeError
UnknownOfferError
UnknownOpportunityError
UnknownOrIncorrectEndpointError
UnknownOrderError
UnnecessaryPaymentDetailsError
statusCode
An integer representing the HTTP status code.
concept
A collection of concepts that are part of this scheme
accessibilityInformation
Provide additional, specific documentation for participants about how disabilities are, or can be supported at the Event.
accessibilitySupport
Used to specify the types of disabilities or impairments that are supported at an event.
activity
Specifies the physical activity or activities that will take place during a Course.
ageRange
Indicates that an event is recommended as being suitable for or is targetted at a specific age range.
genderRestriction
Indicates that an event is restricted to male, female or a mixed audience. This information must be displayed prominently to the user before booking. If a gender restriction isn't specified then applications should assume that an event is suitable for a mixed audience.
level
A general purpose property for specifying the suitability of an event for different participant “levels”. E.g. `Beginner`, `Intermediate`, `Advanced`. Or in the case of martial arts, specific belt requirements.
instanceOfCourse
The description of the Course for which this is a distinct instance.
accountNumber
The customer-facing identifier for the Customer Account.
accessPass
The barcode, QR code, magnetic stripe, or swipe card associated with this Customer Account, within their own namespaces.
hasHiddenEntitlements
Whether there are any additional entitlements (other than those listed in entitlement) or other types of discounts are associated with the Customer Account that will influence pricing, and therefore whether the pricing for the entitlement in the feed should be treated as indicative.
outstandingAction
Outstanding actions on this Customer Account, such as the resolution of outstanding debts or membership renewal. These may prevent the Customer from making bookings.
entitlement
The current valid and active entitlements associated with this customer. Note that expired or inactive entitlements are not included in this list.
backgroundImage
A background image for the `Dataset`.
bookingService
Information about the Booking System or publishing platform
valueOption
Specifies an array of display values for the dropdown.
entitlementType
For the request, this is the value of the @id of the Concept being referenced. For the response, this the full Concept object including the @id and prefLabel.
evidenceRequestAction
Any evidence request associated with the entitlement.
attendeeInstructions
Provides additional notes and instructions for event attendees, for example more information on how to find the event, what to bring, etc. The value of this property must not include HTML or other markup.
ageRestriction
The enforced attendee age range requirement of the Event or Offer, that must be displayed prominently to the user before booking.
additionalAdmissionRestriction
Free text restrictions that must be displayed prominently to the user before booking. This property must only contain restrictions not described by `oa:ageRestriction` or `oa:genderRestriction`.
customerAccountBookingRestriction
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](https://github.com/openactive/customer-accounts) evolves.
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](https://github.com/openactive/customer-accounts) evolves.
isCoached
A boolean property that indicates whether an Event will be coached. This flag allows an Event to be marked as being coached without having to specify a named individual as a coach. This addresses both privacy concerns and also scenarios where the actual coach may only be decided on the day.
leader
Refers to a person (schema:Person) who will be leading an event. E.g. a coach. This is a more specific role than an organiser or a contributor. The person will need to have given their consent for their personal information to be present in the Open Data.
meetingPoint
Instructions for the attendees of an Event about where they should meet the organizer or leader at the start of the event. Some larger locations may have several possible meeting points, so this property provides additional more specific directions.
programme
Indicates that an event will be organised according to a specific Programme.
schedulingNote
Provides a note from an organizer relating to how this Event is scheduled.
facilityType
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](https://github.com/openactive/facility-types/issues/1#issuecomment-853759213).
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).
aggregateFacilityUse
Inverse of the oa:individualFacilityUse property. Relates an oa:IndividualFacilityUse (e.g. an opportunity to play tennis on a specific court) to a oa:FacilityUse (e.g. an opportunity to play tennis at a specific location).
leaseExpires
Expiry DateTime of the Lease in ISO 8601 format
openBookingInAdvance
Indicates whether to accept this offer, a participant must book in advance, whether they must pay on attending, or have option to do either. Values must be one of https://openactive.io/Required, https://openactive.io/Optional or https://openactive.io/Unavailable.
openBookingPrepayment
Indicates whether to accept this offer, a participant must pay in advance, pay when attending, or have the option to do either. Values must be one of https://openactive.io/Required, https://openactive.io/Optional or https://openactive.io/Unavailable.
validFromBeforeStartDate
The duration before the `startDate` for which this `Offer` is valid, given in ISO 8601 format. This is a relatively-defined equivalent of `schema:validFrom`, to allow for `Offer` inheritance.
validThroughBeforeStartDate
The duration before the `startDate` after which the `Offer` is no longer valid, given in ISO 8601 format. This is a relatively-defined equivalent of `schema:validThrough`, to allow for `Offer` inheritance.
latestCancellationBeforeStartDate
The duration before the startDate during which this Offer may not be cancelled, given in ISO 8601 format.
allowCustomerCancellationFullRefund
Whether the opportunity can be cancelled with a full refund at any time before the `startDate`, or before the `latestCancellationBeforeStartDate` if provided.
openBookingFlowRequirement
Can include https://openactive.io/OpenBookingIntakeForm, https://openactive.io/OpenBookingAttendeeDetails, https://openactive.io/OpenBookingApproval, https://openactive.io/OpenBookingNegotiation, https://openactive.io/OpenBookingMessageExchange
eligibleEntitlementType
Offers in open data can be marked as requiring an entitlement type via `eligibleEntitlementType`. The same Offer may be applicable to multiple entitlement types, and the Customer must have at least one matching entitlement type to qualify for the Offer. Note that this property is in EARLY RELEASE AND IS SUBJECT TO CHANGE, as the [Customer Accounts proposal](https://github.com/openactive/customer-accounts) evolves.
instance
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
requestId
Used by technical support for diagnostics purposes.
taxCalculationExcluded
Set to true when business-to-business tax calculation is required by the seller or brokerRole settings, but not supported by the Broker.
brokerRole
Either https://openactive.io/AgentBroker, https://openactive.io/ResellerBroker or https://openactive.io/NoBroker, as agreed in advance between the Broker and Seller.
totalPaymentTax
Breakdown of tax payable for the Order.
payment
The payment associated with the Order by the Broker. It is required for cases where a payment has been taken.
orderCreationStatus
This property is internal to the Broker in this version of the specification.
orderProposalVersion
The unique URL representing this version of the OrderProposal, or the version of the OrderProposal to which this Order is related.
unitTaxSpecification
Breakdown of tax payable for the OrderItem.
accessChannel
Channel through which the user can participate in the Opportunity. Not applicable for an OrderQuote.
cancellationMessage
A message set by the Seller in the event of Opportunity cancellation, only applicable for an `Order` and where the `OrderItem` has `orderItemStatus` set to `https://openactive.io/SellerCancelled`
customerNotice
A message set by the Seller to trigger a notification to the Customer, only applicable for an `Order` and where the `OrderItem` has `orderItemStatus` set to `https://openactive.io/OrderItemConfirmed` or `https://openactive.io/CustomerAttended`
attendeeDetailsRequired
The properties of `schema:Person` that are required to describe an `attendee` for this `OrderItem`.
orderItemIntakeForm
PropertyValueSpecifications that describe fields in the orderItemIntakeForm.
orderItemIntakeFormResponse
PropertyValues that contains a text value responses to the orderItemIntakeForm.
orderProposalStatus
orderSellerNote
orderCustomerNote
lease
The Lease on the OrderItems which lasts for the duration specified by the Booking System.
orderRequiresApproval
Whether the Booking Flow with Approval must be used to book the set of OrderItems included. must be true if any of the OrderItems require approval.
taxMode
Either https://openactive.io/TaxNet or https://openactive.io/TaxGross
isOpenBookingAllowed
Indicates whether the Seller allows open booking or not
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](https://github.com/openactive/customer-accounts) evolves.
paymentProviderId
A reference to the specific Payment Provider that is used.
emergencyContact
Person to contact in case of emergencies related to this Person.
idTemplate
An RFC6570 compliant URI template that can be used to generate a unique identifier (`@id`) for every event described by the schedule. This property is required if the data provider is supporting third-party booking via the Open Booking API, or providing complimentary individual `subEvent`s.
scheduledEventType
The type of event this schedule related to.
facilityUse
`FacilityUse` or `IndividualFacilityUse` that has this `Slot`, either directly embedded or referenced by its `@id`
maximumUses
The maximum available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.
remainingUses
The remaining available courts or pitches at this time. Must be 0 or 1 for an IndividualFacilityUse.
rate
The rate of VAT.
requiresExplicitConsent
accessId
The identifier required to access the `VirtualLocation` from any device, without requiring the URL, e.g. the meeting ID.
endpointUrl
The Base URI of this implementation of the Open Booking API
authenticationAuthority
The location of the OpenID Provider that must be used to access the API.