OpenActive Developers
Data ValidatorDataset DashboardW3C Community Group
  • Welcome to our community
  • Publishing Data
    • Data Feeds
      • How an RPDE data feed works
      • Types of RDPE feed
      • Implementing RPDE
      • Testing RPDE feeds
      • Scaling RPDE feeds
    • Activity list references
    • Including geo coordinates
    • Schedules
    • Dataset Sites
    • Virtual Events
    • On-Demand Events
    • Opening Hours
    • Data Quality
  • Using data
    • Harvesting opportunity data
      • Large Integers in JavaScript
    • Tutorial: Consuming an RPDE feed
    • Attribution
  • Open Booking API
    • Key Decisions
    • Implementing booking
    • Testing booking
      • Configuring Test Suite
      • Implementing the Test Interface
        • Test Interface Actions
        • Create Opportunity Endpoint
      • Random Mode: Generating Test Opportunity Data
      • Running Test Suite
      • Generating the Conformance Certificate
  • Data Model
    • Data Model Overview
    • @context and JSON-LD
    • Types Reference
      • Action
      • AudioObject
      • BabyChanging
      • Barcode
      • BookingService
      • BooleanFormFieldSpecification
      • Brand
      • ChangingFacilities
      • ConceptScheme
      • Concept
      • CourseInstance
      • Course
      • Creche
      • CustomerAccount
      • DataCatalog
      • DataDownload
      • Dataset
      • DropdownFormFieldSpecification
      • DynamicPayment
      • Entitlement
      • EventSeries
      • Event
      • FacilityUse
      • FileUploadFormFieldSpecification
      • GeoCoordinates
      • HeadlineEvent
      • ImageObject
      • IndividualFacilityUse
      • InternalApplicationError
      • InternalLibraryConfigurationError
      • InternalLibraryError
      • Lease
      • LocationFeatureSpecification
      • Lockers
      • MediaObject
      • OfferOverride
      • Offer
      • OnDemandEvent
      • OpenBookingError
      • OpeningHoursSpecification
      • OrderItem
      • OrderProposal
      • OrderQuote
      • Order
      • Organization
      • ParagraphFormFieldSpecification
      • Parking
      • PartialSchedule
      • Payment
      • Person
      • Place
      • PostalAddress
      • PriceSpecification
      • PrivacyPolicy
      • PropertyValueSpecification
      • PropertyValue
      • QuantitativeValue
      • Schedule
      • ScheduledSession
      • SessionSeries
      • ShortAnswerFormFieldSpecification
      • Showers
      • Slot
      • SportsActivityLocation
      • TaxChargeSpecification
      • TermsOfUse
      • Terms
      • Toilets
      • Towels
      • VideoObject
      • VirtualLocation
      • WebAPI
  • Specifications
    • Specifications Overview
  • Useful links
    • Data Visualiser
    • Data Validator
    • Dataset Dashboard
    • Non-technical Guidance
  • OpenActive on GitHub
    • Overview
    • Activity List
    • Community
    • Controlled Vocabularies
    • Dataset Publication
    • Documentation
    • Implementation Support
    • Programmes
    • RPDE
    • SKOS
    • Specifications
    • Validators
Powered by GitBook
On this page
  • EARLY RELEASE NOTICE
  • Properties
  • Required properties
  • Recommended properties
  • Optional properties
Edit on GitHub
  1. Data Model
  2. Types Reference

WebAPI

This page describes the WebAPI type.

PreviousVirtualLocationNextSpecifications Overview

Last updated 11 months ago

EARLY RELEASE NOTICE

This class represents a draft that is designed to inform the OpenActive specification work with implementation feedback. IT IS SUBJECT TO CHANGE, as the evolves.

This type is derived from , 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

Property
Expected Type
Description

@type

Must always be present and set to "@type": "WebAPI"

conformsTo

Indicates the version and profiles of OpenActive Open Booking Specification with which this WebAPI conforms, by specifying these as URLs.

Example

"conformsTo": [ "https://openactive.io/open-booking-api/1.0/#core" ]

endpointDescription

The Open API document associated with this version of the Open Booking API

Example

"endpointDescription": "https://openactive.io/open-booking-api/1.0/swagger.json"

endpointUrl

The Base URI of this implementation of the Open Booking API

Example

"endpointUrl": "https://example.bookingsystem.com/api/openbooking"

landingPage

The URL of a web page that the Broker may use to obtain access to the API, e.g. via a web form.

Example

"landingPage": "https://exampleforms.com/get-me-an-api-access-key"

name

The name of the WebAPI

Example

"name": "Acme Leisure Sessions and Facilities"

Recommended properties

Property
Expected Type
Description

documentation

A link to documentation related to how to use the Open Booking API, or a link to the OpenActive developer documentation using https://permalink.openactive.io/dataset-site/open-booking-api-documentation if no system-specific documentation is available.

Example

"documentation": "https://permalink.openactive.io/dataset-site/open-booking-api-documentation"

termsOfService

A link to terms of service related to the use of this API.

Example

"termsOfService": "https://example.bookingsystem.com/terms"

Optional properties

Property
Expected Type
Description

authenticationAuthority

The location of the OpenID Provider that must be used to access the API.

Example

"authenticationAuthority": "https://auth.bookingsystem.com"

description

A plain text description of the Dataset, which must not include HTML or other markup.

Example

"description": "Near real-time availability and rich descriptions relating to the sessions and facilities available from {OrganisationName}, published using the OpenActive Modelling Specification 2.0."

Array of

Except as otherwise noted, the content of this page is licensed under the , and code samples are licensed under the , for anyone to access, use and share; using attribution "".

Dataset API Discovery specification
https://pending.schema.org/WebAPI
Creative Commons Attribution License (CC-BY V4.0)
MIT License
OpenActive
Text
URL
URL
URL
URL
Text
URL
URL
URL
Text