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
  • FacilityUse + Slots
  • FacilityUse + IndividualFacilityUses + Slots
  1. platform products
  2. Search
  3. imin Facilities API

FacilityUses and IndividualFacilityUses

What, where, and when a particular facility can be used can be represented in two ways in the Facilities API:

  1. FacilityUse + Slots

  2. FacilityUse + IndividualFacilityUses + Slots

Which format is used to describe facilities is determined by the underlying data structure provided to us by the data provider.

FacilityUse + Slots

This structure is simpler and easier to consume but does not provide the granularity of the other structure. A FacilityUse will have an event property that contains an array of Slots.

An example of this structure can be seen below:

{
    "type": "FacilityUse",
    "name": "Alexandra Palace Badminton Courts",
    "location": {
        "type": "Place",
        ...
    }
    ...
    "event": [
        {
            "type": "Slot",
            "startDate": "2022-09-10T12:30:00Z"
            ...
            "remainingUses": 4
            "imin:checkoutUrlTemplate": "{Checkout URL}"
        },
        {
            "type": "Slot",
            "startDate": "2022-09-10T13:30:00Z"
            ...
            "remainingUses": 3,
            "imin:checkoutUrlTemplate": "{Checkout URL}"
        },
    ]
}

FacilityUse + IndividualFacilityUses + Slots

This structure has more granularity but is slightly more complicated to consume. It has an additional layer between the FacilityUse and the Slot called an IndividualFacilityUse. This layer represents specific court/pitch facilities that sit within the more general facility. Within these IndividualFacilityUses will be the Slots that corresponds to that specific court/pitch.

An example of this data structure is:

{
    "type": "FacilityUse",
    "name": "Alexandra Palace Badminton Courts",
    "location": {
        "type": "Place",
        ...
    }
    ...
   "event": [
       {
        "type": "IndividualFacilityUse",
        "name": "Court 1",
        "event": [
            {
                "type": "Slot",
                "startDate": "2022-09-10T12:30:00Z"
                ...
                "remainingUses": 1,
                "imin:checkoutUrlTemplate": "{Checkout URL}"
            },
        ]
       },
       {
        "type": "IndividualFacilityUse",
        "name": "Court 2",
        "event": [
            {
                "type": "Slot",
                "startDate": "2022-09-10T12:30:00Z"
                ...
                "remainingUses": 1,
                "imin:checkoutUrlTemplate": "{Checkout URL}"
            },
            {
                "type": "Slot",
                "startDate": "2022-09-10T1:30:00Z"
                ...
                "remainingUses": 1,
                "imin:checkoutUrlTemplate": "{Checkout URL}"
            },
        ]
       }
   ] 
}

More information about Slots can be found here Slots and more information about imin:checkoutUrlTemplate and Slot booking can be found here Facilities Slot Booking

PreviousSlot By-IDNextSlots

Last updated 2 years ago