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
  1. platform products
  2. Live Timetables
  3. The Onboarding Process

1. Ensuring your Data Offers the Best User Experience

The data stored within your LMS can be displayed directly on the Live Timetables. However, you may wish to tweak or enhance what is being shown to deliver the best user experience for your website.

It may take a several minutes or longer for the changes you are applying to take effect and update the open data feed.

Gladstone

Gladstone offer a specific platform called OpenActive Data Manager to help you enhance and augment the data in your OpenActive data feed - such as grouping activities together, adding richer descriptions, or even images.

Here's what you need to do (* = denotes that this step is a minimum requirement for use of the Live Timetables)

  1. Log into Data Manager using the username and password provided to you by Gladstone

  2. Fill out the fields within Organisation

  3. *Go to the Places tab, and for each of your locations, add an accurate full address and / or move the pin to the correct point on the map. Whilst here, you can fill out the other fields for each location - this will help other users of your data to better display your locations.

  4. Go to Event Series, and create all the different types of activity you offer. For example you can create a "HIIT" template. You'll use this in the next step.

    • A key thing to do here is to make sure the OpenActive Activity Reference is selected - the Live Timetables are able to display / exclude activities based on activity type.

    • Please see note below about Swimming and Gym timetables.

  5. Go to Event Series Mapping, and you can select groupings of sessions, and then associate them with the template you made in the previous step. For example, you select "HIIT Mon 3pm David", "HIIT Tues 4pm Linda" and "6pm HIIT Sat" and click Associate, selecting your HIIT template from the options, to associate those particular activity IDs with your HIIT template. Do this for as many groupings as you find helpful.

  6. Go to the FacilityUses tab, and ensure that each Facility Use (a bookable space in your centres, e.g. badminton court) has the correct OpenActive Activity Reference associated with it - the Live Timetables use this to group certain Facility Uses together. If there is no OpenActive Activity Reference, then it might not be displayed at all by the Live Timetables.

If you are looking to create Swim timetables, you will need to use Data Manager to make sure all swimming activities that you wish to display are correctly labelled with the OpenActive activity type "Swimming".

For Gym timetables, you will need to do the same, using the OpenActivity type "Gym Workout"

Only activities marked as "WebBookable" within Gladstone will be available through the open data feed and visible in the Data Manager

Legend

There are a few steps you need to complete within Legend in order to use the Live Timetables properly.

These are all documented within the Legend Bytes customer knowledge base. Specifically:

  • ensure your Clubs have the lattitude, longtitude and service url set within Club Properties. You can use Google Maps to find the lattitide and longtitude for your sites

  • Follow the steps in Legend Bytes for setting our OpenActive configurations

  • Follow the steps in Legend Bytes for ensuring classes and activities are visible (or not) depending on your requirements.

  • Follow the steps in Legend Bytes for setting the correct OpenActive activity type for your classes and activities. The Live Timetable uses these categorisations when including / excluding activities from specific timetables.

If you are looking to create Swim timetables, you will need to make sure all swimming activities that you wish to display are correctly labelled with the OpenActive activity type "Swimming".

For Gym timetables, you will need to do the same, using the OpenActivity type "Gym Workout"

PreviousThe Onboarding ProcessNext2. Setting up and Embedding your First Timetable

Last updated 1 year ago