Skip to content

Commit

Permalink
GITBOOK-272: Adding a line to introduce 'listings' vs. 'bookable' data.
Browse files Browse the repository at this point in the history
  • Loading branch information
nickevansuk authored and gitbook-bot committed Sep 14, 2023
1 parent 1a339b6 commit bb0194b
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* [Virtual Events](publishing-data/virtual-events.md)
* [On-Demand Events](publishing-data/on-demand-events.md)
* [Opening Hours](publishing-data/opening-hours.md)
* [Data Quality](publishing-data/data-quality.md)

## Using data

Expand Down Expand Up @@ -113,6 +114,7 @@

## Useful links

* [Data Visualiser](https://visualiser.openactive.io/)
* [Data Validator](https://validator.openactive.io)
* [Dataset Dashboard](http://status.openactive.io)
* [Non-technical Guidance](https://www.openactive.io/getting-started/)
Expand Down
44 changes: 42 additions & 2 deletions docs/publishing-data/data-feeds/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,49 @@

## Overview

To take advantage of the OpenActive ecosystem of data users, data must be published via open data feeds.
OpenActive is an initiative that promotes the use of open data to help people become more active. It aims to make opportunities to be active as discoverable as possible, similar to how one might find a hotel room or flight online.

OpenActive is primarily concerned with feeds of "opportunity data" – that is, information about when, where and what activities are taking place.

These feeds must be published using the [OpenActive Real-time Paged Data Exchange (RPDE) specification](https://openactive.io/realtime-paged-data-exchange/), which provides a mechanism to allow systems to synchronise database state in near-realtime.

## Listing-only vs Bookable Opportunity Data

OpenActive supports two levels of user interaction with this data, and a data publisher must choose which level they wish to implement:

1. **Listing-only Opportunity Data**:
* Data that includes near-real-time up-to-date details about a physical activity opportunity that can be discovered by potential participants. Listing data typically includes information like the type of activity, time, location, price, provider and availability.
* The main goal of this data is to allow potential participants to find opportunities that match their interests and availability, and are actually happening.
* However, the listing data itself doesn't enable users to reserve or book a place in the activity directly. It's more of an informative listing that helps people discover available opportunities.
* **Implementation requirements:** opportunity data RPDE feeds that include deep-link URLs to the opportunity within the listing or booking system.
2. **Bookable Opportunity Data**:
* This refers to data and functionality that allows potential participants to not only discover an activity but also to reserve or book a place directly through a platform or application.
* It enables integration with booking systems to allow real-time availability checking and booking.
* Offering bookable data can lead to an increase in participation since it makes the process more streamlined for users — they can find and book an activity all in one place.
* **Implementation requirements:** opportunity data RPDE feeds and the Open Booking API.

In summary, while "listing-only" data offers up-to-date information about physical activity opportunities, "bookable" data takes it a step further by allowing direct reservations or bookings. The implementation of both provides a seamless experience from discovery to participation.

## Primary sources

Opportunity data must always be published from **primary sources** (e.g. the booking system that an organiser uses to manage their own activities) rather than **secondary sources** (e.g. a third-party survey of organisers or web form which captures the sessions they are currently running)

Publishing data from primary sources rather than secondary sources is essential for several reasons:

1. **Accuracy**: Primary sources provide data directly from the organiser or provider of opportunity, which means it's more likely to be accurate and up-to-date. Secondary sources such as surveys and forms are usually not thoroughly reviewed by providers. Much less care and attention is taken when filling in these forms than on the activity provider's own website and booking system.
2. **Timeliness**: Activities, classes, and schedules often change. Primary sources like booking systems are updated in real-time, so the information is always current. Relying on secondary sources would mean periodic data collection, which can become quickly outdated.
3. **Scalability**: As the number of activity providers grows, it becomes increasingly expensive for secondary sources to maintain a large set of data. Primary sources do not require any such central maintenance overhead.
4. **Data richness**: Primary sources can often provide a richer dataset, including details about availability, pricing, venue facilities, instructor qualifications, and more. This can offer a more complete picture for end-users, helping them make informed decisions.
5. **Reduced burden**: For activity providers, integrating their primary booking or management systems once with OpenActive can reduce the burden of repeatedly reporting data or filling out surveys. It's a "set it and forget it" approach, which is more efficient in the long run.
6. **Trustworthiness**: Data users and consumers will trust data more when they know it's coming directly from the source and is current. This trustworthiness is likely to increase the adoption of applications and platforms that use OpenActive data, and increase consumer confidence of data from our sector.

In conclusion, while secondary sources can be useful for certain insights or research purposes, for an initiative like OpenActive, which aims to provide real-time, accurate, and comprehensive data about physical activity opportunities, relying on primary sources is much more effective and efficient.






These feeds must be published using the OpenActive Realtime Paged Data Exchange (RPDE) specification, which provides a mechanism to allow systems to synchronise database state in near-realtime.

{% content-ref url="how-a-data-feed-works.md" %}
[how-a-data-feed-works.md](how-a-data-feed-works.md)
Expand Down
13 changes: 13 additions & 0 deletions docs/publishing-data/data-quality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Data Quality

As OpenActive continues to scale, the range of data publishers and the number and variety of opportunities for sport and physical activity has expanded significantly. 

Feedback from data users has highlighted areas of improvement for the end-user experience when searching for activities. Additionally, the initiative needs a consistent approach to assess how OpenActive data could support new use cases. 

The [OpenActive Data Quality Reporting Framework](https://docs.google.com/document/d/1LplQ1UmssmgOw61k7JNqfPyaJ6qOYSp1SC19iL0gC9g/edit?usp=sharing) outlines our approach to data quality across the initiative.

The [Data Visualiser](https://visualiser.openactive.io/) allows you to explore data quality for a specific feed.

The initial focus is on ensuring the "what", "where" and "when" of opportunities is clearly defined in the data, to meet the main use cases of discovery and booking.

However, this is an area of ongoing work and additional metrics will be developed in collaboration with the [OpenActive W3C Community Group](https://w3c.openactive.io/).

0 comments on commit bb0194b

Please sign in to comment.