https://example.com/openactive/
."staticAssetsPathUrl"
references the location of your self-hosted assets, without a trailing slash (/
) (this can be a relative or absolute URL).https://example.com/openactive/
."jsonld"
property at the root of the JSON itself (i.e. serialised JSON embedded in the original deserialised object). This is important as it is used to populate the machine-readable <script type="application/ld+json">
tag within the generated HTML - view the source of this page to see an example."staticAssetsPathUrl"
property at the root of the JSON to the relative URL of the directory containing your self-hosted assets, without a trailing slash (/
). Note this must take place after the "jsonld"
property is set above so that this property is not included in the machine-readable JSON-LD.organisationName
e.g. "Better",datasetDocumentationUrl
e.g. "https://permalink.openactive.io/dataset-site/open-data-documentation" (which should be used if no system-specific documentation is available)organisationLegalEntity
e.g. "GLL"organisationPlainTextDescription
e.g. "Established in 1993, GLL is the largest UK-based charitable social enterprise delivering leisure, health and community services. Under the consumer facing brand Better, we operate 258 public Sports and Leisure facilities, 88 libraries, 10 children’s centres and 5 adventure playgrounds in partnership with 50 local councils, public agencies and sporting organisations. Better leisure facilities enjoy 46 million visitors a year and have more than 650,000 members."organisationEmail
e.g. "[email protected]"openBookingAPIDocumentationUrl
e.g. "https://permalink.openactive.io/dataset-site/open-booking-api-documentation" (which should be used if no system-specific documentation is available)datasetDiscussionUrl
- the URL of the GitHub issues board for the dataset. If your customers are sufficiently large, you will need to create a GitHub issues board for each customer, either manually or automatically. See here for an example of Gladstone's GitHub organization containing a GitHub issues board for each customer.datasetDocumentationUrl
- as a booking system you should provide at least a single page on your website that explains the OpenActive feeds. Each customer may have the option of providing their own documentation for their dataset site that links to this, or just linking to your documentation direct. If you do not have your own documentation page, you can just link to "https://developer.openactive.io/".openBookingAPIRegistrationUrl
(in library settings) or accessService.landingPage
(in raw Dataset JSON-LD) Open Booking API Access Request Form (Multi-seller systems)Name: ______________________________Email: ______________________________Organisation name: ______________________________☑️ I understand our data protection obligations, and our technical obligations as a Broker as specified in the Open Booking API specification☑️ Our organisation holds a valid Cyber Essentials (or equivalent) certification and we understand our information security obligations☑️ Our organisation has already successfully integrated with the OpenActive Reference Implementation, and understands how an OpenActive integration works☑️ I agree to integrate with Sellers only with their explicit consent as granted via OpenID Connect, and understand that access to the Booking System does not guarantee access to Sellers, which is at their own individual discretion.☑️ I understand that payment reconciliation must be agreed with each seller individually.
Open Booking API Access Request Form (Single-seller systems)Name: ______________________________Email: ______________________________Phone number: ______________________________Organisation name: ______________________________Use case and business case for integration: ______________________________☑️ I understand our data protection obligations, and our technical obligations as a Broker as specified in the Open Booking API specification☑️ Our organisation holds a valid Cyber Essentials (or equivalent) certification and we understand our information security obligations☑️ Our organisation has already successfully integrated with the OpenActive Reference Implementation, and understands how an OpenActive integration works
openBookingAPITermsOfServiceUrl
(in library settings) or accessService.termsOfService
(in raw Dataset JSON-LD)testSuiteCertificateUrl
(in library settings) or bookingService.hasCredential
(in raw Dataset JSON-LD)platformSoftwareVersion
in library settings, or bookingService.softwareVersion
in raw Dataset JSON-LD should be omitted in this case.platformSoftwareVersion
in library settings, or bookingService.softwareVersion
in Dataset JSON.discussionUrl
is the url of the GitHub issues board for that specific dataset site.dataset
array), presented within a DataCatalog
wrapper following a specific format. An example of a live Data Catalog from the Gladstone system can be found here, and another example here.DataCatalog
is conformant, using the "Data Catalog" mode.dataset
array.hasPart
array.