ByID Search

Danger

Query parameters cannot be used to complete aByID search.

FacilityUse By-ID searches using the Root id

Having completed a mode=upcoming-slots query parameter search, the data returned for a specific FacilityUse will always include a URL at the root id. This URL can be used to make a FacilityUse By-IDsearch, which will return all availableSlots for that specific FacilityUse for up to 7-days in the future from today’s date.

Note

The URL for the FacilityUse By-ID route will look like https://search.imin.co/facilities-api/v2/facility-uses/{identifier}.

Slot By-ID searches using the event[].id

Note

The URL for the Slot By-ID route will look like https://search.imin.co/facilities-api/v2/slots/{event[].id } and will include YYYY-MM-DD-THH:MM:SSZ at the end of the URL depending on the startDate of the Slot selected.

In the same mode=upcoming-slots query parameter search, there may also be an event[].id. However, this will only be returned where the FacilityUse has at least one slot available on the startDate specific in the query parameter search. If there are no slots available for a FacilityUseon that day, you will not be able to make a Slot By-ID search.

Caution

You should not expect every FacilityUse in the query parameter search results to have an event[].id. If a FacilityUse has no slots available on a specific day, it will not include any event[].ids.

By-ID and Slots

Tip

Regarding provision of slots via the API when using the By-ID search, there are two options available:

i) FacilityUse By-ID search to return slots for one facility over multiple days: one facility + multiple days + slots.

ii) Slot By-ID search to return one specific slot for one facility on one days: one facility + one day + one slot.

Examples

The following FacilityUse By-ID search will return all slots over the next week for a specific FacilityUse (a badminton court in a sports hall): [to be included once restrictions are lifted].

The following Slot By-ID search will return one slot at a specific time on a specific date for a specific FacilityUse (a badminton court in a sports hall at 4pm on a Tuesday): [to be included once restrictions are lifted].

Tip

The recommended use for the ByID endpoint is in a timetable view. In terms of the user journey, this endpoint is used when a person has found a facility they wish to use (via a query parameter search) and now want to check slot availability over the next week/on a specific day.