WebAPI

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 Dataset API Discovery specification evolves.
This type is derived from https://pending.schema.org/WebAPI, 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
​Text​
Must always be present and set to "@type": "WebAPI"
conformsTo
Array of URL​
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
​URL​
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
​URL​
The base URL of the Open Booking API

Example
"endpointURL": "https://example.bookingsystem.com/api/openbooking"
landingPage
​URL​
The web page the broker uses to obtain access to the API, e.g. via a web form.

Example
"landingPage": "https://exampleforms.com/get-me-an-api-access-key"
name
​Text​
The name of the WebAPI

Example
"name": "Acme Leisure Sessions and Facilities"
Recommended properties
Property
Expected Type
Description
documentation
​URL​
A link to documentation related to the Dataset, or a link to the OpenActive developer documentation if no Dataset-specific documentation is available.

Example
"documentation": "https://developer.openactive.io"
termsOfService
​URL​
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
​URL​
The location of the OpenID Provider or other relevant authentication authority that must be used to access the API.

Example
"authenticationAuthority": "https://auth.bookingsystem.com"
description
​Text​
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."
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".

VirtualLocation

Next - Specifications

Specifications Overview

Last modified 3mo ago

Copy link

Contents

EARLY RELEASE NOTICE

Properties

Required properties

Recommended properties

Optional properties