Attribution Catalog Endpoint
Last updated
Last updated
It is a licensing requirement (see 3.7.2 of our ) that any frontend that displays open data form the imin Platform must include the relevant open data attribution alongside it.
The Attribution Catalog Endpoint returns metadata of all OpenActive Datasets available through the imin Platform.
In keeping with the design philosophy of the Firehose API, the endpoints includes metadata for all datasets available through the imin Platform:
As with other imin endpoints, you must provide a valid API key as the X-API-KEY
request header.
The items within the Attribution Catalog Endpoint will include at least the following properties:
The data items within the Firehose feeds include the following properties:
The value of the data.imin:dataSource.identifier
in the Firehose feeds can be matched against the value of identifier
in the Attribution Catalog Endpoint, and hence can be used to dereference the complete data for the Dataset
.
The attribution should be included somewhere on the page where the data appears (i.e. the session or facility page).
The following HTML is recommended for attribution on any opportunity page, based on the data in the Dataset
retrieved above:
For a Firehose feed opportunity that includes a Dataset.identifier
as follows:
The following matching data should be retrieved from the Attribution Catalog Endpoint:
And rendered into the following HTML for display to the user:
Which is displayed as follows:
It is a licensing requirement (see 3.7.2 of our ) that any frontend that displays open data from the imin Platform must include the relevant open data attribution alongside it.
For example, for data from Everyone Active, the attribution should be hyperlinked as follows somewhere on a page displaying that data, as stipulated at the bottom of its Dataset Site at :
Source:
Source: