The imin Platform
2.0.0
2.0.0
  • Introduction to the imin Platform
  • Using the Platform
    • imin's Platform Products
    • Authentication
    • Our Platform Data
      • Understanding Responses
      • Namespaces and Extensions
      • Defensive Data Consumption
      • Mocking the Interface
  • platform products
    • Search
      • imin Events API
        • Events API Reference
        • Virtual & Physical Sessions
        • Concepts
          • EventSeries
          • ScheduledSessions and eventSchedules
          • Activities and Collections
            • Activities
            • Activity Concept Collections
          • Accessibility Support
          • Prices
        • Filters
          • Modes
          • Age Ranges
          • Dates and Times
          • Activities and Concept Collections
          • High Frequency Sessions
      • imin Facilities API
        • Query Parameter Search
          • Mandatory Query Parameters
            • mode=discovery-geo
            • mode=upcoming-slots
          • Optional Query Parameters
        • ByID Search
          • FacilityUse By-ID
          • Slot By-ID
        • FacilityUses and IndividualFacilityUses
        • Slots
        • Facilities Slot Booking
      • imin Places API [BETA]
        • Example Request & Response
    • Firehose
      • Introduction to the Firehose
      • Accessing the Firehose
      • Firehose Usage Policy & Restrictions
      • Firehose and Search
      • Bookable Firehose Feeds
      • Bookable Sellers Feed
      • Attribution Catalog Endpoint
    • Live Timetables
      • Pre-Requisites: Open Data Feeds
      • The Onboarding Process
        • 1. Ensuring your Data Offers the Best User Experience
        • 2. Setting up and Embedding your First Timetable
        • 3. Setting up the Rest of your Timetables
        • 4. Activating Booking via Guest Checkout
      • Features Available Upon Request
      • Styling the Live Timetables
      • FAQs
    • Data Dashboard
  • incorporating book and pay
    • imin Branded Checkout
      • Introduction
      • Setup
        • Information We Require From You
        • Actions You Need to Complete
      • Authenticated Checkout
        • Testing [BETA]
        • 👪Group Booking [BETA]
      • Standalone Checkout
      • Firehose and Checkout [BETA]
        • Loading the Checkout via Firehose
    • imin Booking Platform
      • Customer Account Management
        • Create Customer Account
        • Update Customer Account
        • Get Customer Account
        • Delete Customer Account
        • Example Scenario
        • Payment Card Management
        • Linked Accounts
        • Entitlement
          • Evidence Requests
          • Entitlement Pricing in Search
          • Entitlement Pricing in Checkout
        • Access Pass
        • Webhooks
      • Orders
        • Order History
        • Order (by ID)
        • Cancellations & Refunds
      • Upcoming OrderItems
      • Receipt (by ID)
  • imin and booking systems
    • Seller Onboarding
      • API
  • HINTS & TIPS
    • Get the Best Out of Search
      • Displaying Schedule Information
      • URLs and Offering a Call to Action
      • Searching by Activity
      • Your Search Results and HighFrequencySessions
      • Customer Specific Images
  • Info for Data Publishers
    • Your RPDE Feed & the imin Platform [BETA]
      • Providing Places Data [BETA]
      • Providing Schedule Information [BETA]
Powered by GitBook
On this page
  • How does it work?
  • The Firehose @id will not resolve
  • Cross-Referencing Endpoints
  1. platform products
  2. Firehose

Introduction to the Firehose

PreviousFirehoseNextAccessing the Firehose

Last updated 1 year ago

How does it work?

Unlike the , the Firehose is not a search API. It is a "feed" that is compatible with the and published using the .

The Firehose has two "types" of data, each of which has 'parent' and 'child' feeds:

  • Events are split into SessionSeries and ScheduledSessions. These concepts are explained .

  • Facilities are split into FacilityUses and Slots. These concepts are explained .

Terms of use for access to the imin Firehose differ from the standard terms. Please see .

The Firehose @id will not resolve

The @ids found in Firehose (e.g. ) are merely an identifier that is guaranteed to be unique.

The Firehose @id does not need to actually resolve to an object.

Cross-Referencing Endpoints

A SessionSeries will have one or more ScheduledSessions and a FacilityUse will have one or more Slots. Additionally some Slots relate to an IndividualFacilityUse within a FacilityUse. In order to link the data together:

  • ScheduledSession <-> SessionSeries

    • The ScheduledSession's data.superEvent must match the SessionSeries' data["@id"].

  • Slot <-> FacilityUse

    • For FacilityUses with the individualFacilityUse property, then:

      • The Slot's data.facilityUse must match one of the FacilityUse's data.individualFacilityUse[]["@id"] IDs. This Slot will relate to a single court (e.g. Badminton Court 3).

    • For FacilityUses without the individualFacilityUse property, then:

      • The Slot's data.facilityUse must match the FacilityUse's data["@id"]. This Slot will represent an aggregation of courts (e.g. 6 badminton courts available)

imin Events API
OpenActive Modelling Specification
OpenActive Paging Specification
here
here
Firehose Usage Policy & Restrictions
https://firehose.imin.co/firehose/facility-uses/pulsedursley-FacilityUse-PULSEGYM