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
  • Showing both ScheduledSession and eventSchedule
  • Showing a PartialSchedule only
  1. HINTS & TIPS
  2. Get the Best Out of Search

Displaying Schedule Information

PreviousGet the Best Out of SearchNextURLs and Offering a Call to Action

Last updated 3 years ago

Top tip: if there are ScheduledSessions, any information within the eventSchedule (if present) can be considered supplemental. Only if there are no ScheduledSessions should the PartialSchedule included in the eventSchedule be used to display non-authoritative information about session timings.

Showing both ScheduledSession and eventSchedule

In the event that an EventSeries contains both a ScheduledSession and PartialSchedule/Schedule, we recommend that you only show date/time information from the ScheduledSession, which is authoritative and, therefore, the guaranteed time that the session will occur.

Showing both pieces of information could result in a confusing UX if it is not clear to the user that the PartialSchedule/Schedule information is not a guarantee that it is taking place then.

However, if you wish to present both pieces of information, we recommend you take care clearly render both ScheduledSession andPartialSchedule/Schedule information so that it is obvious to the end user that:

  • The ScheduledSession time is when this particular instance of the session is guaranteed to start; and

  • The PartialSchedule/Schedule time is when future instances of the session may start.

If the information is presented obviously in this way, the end user will get the benefit of knowing more about the session without any ambiguity, which will help them decide if it's the right one for them (e.g. "Perhaps I'll come regularly if I like it. I can't always make the Tuesday, but look! They have sessions on Thursdays, too!").

You should not extrapolate based on the information found in the eventSchedule and communicate to the end user that a session will definitely take place, e.g. every Tuesday and Thursday, as the future ScheduledSessions may tell us otherwise.

Showing a PartialSchedule only

If a ScheduledSession is not present, caution should be exercised when presenting PartialSchedule information to the end user as it only tells us that a session might take place in the future.

If you are presenting only PartialSchedule information to the end user because there is no ScheduledSession, it should be made abundantly clear that:

  • The sessions are not guaranteed to take place; and

  • They should contact the organiser to find out whether it is taking place or not.

For example, we highly recommend you include something like the following: “This session typically takes place on a Tuesday, but we’re not sure if it happens next Tuesday. Please contact the organiser to confirm.”

You could use a popover to include the above information to the end user so that they know that the session information should not be relied upon.

For more details on ScheduledSessions, Schedules and PartialSchedules, please take a look at .

ScheduledSessions and eventSchedules
How a ScheduledSession and an eventSchedule can be rendered to help end users