Filters - General
Available filters
Any combination of the below filters is possible, but it is of course possible to combine them in such a way as to return no results. A session must match every filter supplied in order to be returned in the results.
activityactivity.prefLabelactivity[member-of]accessibilitySupportaccessibilitySupport.prefLabelsubEvent.startDate[local-time-gte]subEvent.startDate[local-time-lte]subEvent.startDate[day-of-week]subEvent.startDate[gte]subEvent.startDate[lte]genderRestrictionageRange[include-range]ageRange.maxAge[lte]ageRange.minAge[gte]limitpagelocation.geo[radial]sortintegrationIdintegrationId[not]categorycategory[not]category.prefLabelcategory.prefLabel[not]offers.imin:publicAdultPrice[gte]offers.imin:publicAdultPrice[lte]imin:accessibilityWheelchairAccessoffers.imin:membershipRequiredtype
Example: integrationId=fusion&ageRange.minAge[gte]=16&genderRestriction=Female
The following would be a valid session given these filters:
{ "type": "Event", "id": "https://search.imin.co/v2/sessions/opensessions-2378#!/subEvent/2018-09-10T18:00:00Z", "_integrationId": "opensessions", "name": "MSA Women's Basketball", "potentialAction": [], "level": [], "maximumAttendeeCapacity": null, "accessibilitySupport": [], "accessibilityInformation": null, "attendeeInstructions": null, "description": "Open to all females aged 16+. All levels welcome. \nQualified female coach - come to play, get fit, socialise, and learn new skills. \nPlease wear good trainers and bring plenty of water.\n£5 PAYG\n\nTERM TIME ONLY\n\nPreparation\n\nWear good trainers and bring plenty of water.", "identifier": "opensessions-2378", "activity": [ { "type": "Concept", "prefLabel": "Basketball" } ], "category": [], "genderRestriction": { "id": "http://openactive.io/ns#Female", "identifier": "Female", "name": "Female only", "type": "GenderRestrictionType" }, "imin:specialRequirements": [], "imin:accessibilityWheelchairAccess": false, "leader": [ { "type": "Person", "name": "Yashmin Harun", "gender": null, "identifier": null, "email": "info.muslimahsports@gmail.com" } ], "url": "https://www.opensessions.io/#/Organisation/SessionDetail?OrganisationId=1291&SessionId=2378", "location": { "type": "Place", "name": null, "address": { "type": "PostalAddress", "streetAddress": "Aldborough Road South, Redbridge, Ilford, IG3 8EU, GB", "addressCountry": "GB", "postalCode": "IG3 8EU" }, "geo": { "type": "GeoCoordinates", "latitude": 51.565299, "longitude": 0.092181 }, "identifier": null, "amenityFeature": [] }, "eventSchedule": {}, "ageRange": { "type": "QuantitativeValue", "minValue": 16 }, "offers": { "type": "AggregateOffer", "imin:publicAdultPrice": null, "imin:publicJuniorPrice": null, "priceCurrency": "GBP", "offers": [ { "type": "Offer", "price": 5, "priceCurrency": "GBP", "acceptedPaymentMethod": [ "http://purl.org/goodrelations/v1#Cash" ], "imin:membershipRequired": false } ] }, "organizer": [ { "type": "Organization", "telephone": "07738701564", "url": null, "name": null, "email": null } ], "image": [ { "type": "ImageObject", "url": "http://opensessions.io/API/Content/Session/Session_20180705142029.jpg", "thumbnail": [ { "type": "ImageObject", "url": "http://opensessions.io/API/Content/Session/Session_20180705142029.jpg" } ] } ], "subEvent": [ { "type": "Event", "startDate": "2018-09-10T18:00:00Z", "endDate": "2018-09-10T19:30:00Z", "potentialAction": [], "id": "https://search.imin.co/v2/sessions/opensessions-2378#!/subEvent/2018-09-10T18:00:00Z" } ]}Filters that accept multiple values
Several filters can be supplied multiple values, which will be applied to the results as disjunctions. This means that a session matching any one of the values will be considered valid.
Example: activity=c0360db0-a817-4bae-9167-40f89b49fc9e&activity=f2ea7405-6098-4378-b0fe-4e398a659fc4
This filter will bring back sessions with either Tennis or Badminton as an activity. They need not match both. The following would be a valid session:
{ "url": "https://clubspark.lta.org.uk/TennisTuesdays", "name": "Tennis Tuesdays", "type": "Event", "level": [ { "id": "https://search.imin.co/ns#Beginner", "name": "Beginner", "type": "LevelType" }, { "id": "https://search.imin.co/ns#Intermediate", "name": "Intermediate", "type": "LevelType" }, { "id": "https://search.imin.co/ns#Advanced", "name": "Advanced", "type": "LevelType" } ], "offers": { "type": "AggregateOffer", "offers": [ { "name": "Single session", "type": "Offer", "price": 13, "identifier": "SINGLE", "priceCurrency": "GBP" } ], "priceCurrency": "GBP", "imin:publicAdultPrice": 13 }, "@context": [ "https://www.openactive.io/ns/oa.jsonld", "https://search.imin.co/ns/imin.jsonld", "https://www.openactive.io/ns-beta/oa.jsonld" ], "activity": [ { "id": "https://openactive.io/activity-list/#f2ea7405-6098-4378-b0fe-4e398a659fc4", "type": "Concept", "inScheme": "https://openactive.io/activity-list/activity-list.jsonld", "notation": "tennis", "prefLabel": "Tennis", "definition": "Tennis involves hitting a ball over a net using a racket.", "identifier": "f2ea7405-6098-4378-b0fe-4e398a659fc4", "topConceptOf": "https://openactive.io/activity-list/activity-list.jsonld" } ], "ageRange": { "type": "QuantitativeValue", "unitCode": "ANN" }, "category": [], "location": { "geo": { "type": "GeoCoordinates", "latitude": 51.500976, "longitude": -0.204315 }, "name": "Holland Park", "type": "Place", "address": { "type": "PostalAddress", "postalCode": "W8 6LU", "addressRegion": "Middlesex", "streetAddress": "The Stable Yard\r\nIlchester Place", "addressCountry": "GB", "addressLocality": "Kensington" }, "identifier": "958abb2d-b150-44a8-a309-c39aa9827818", "amenityFeature": [] }, "isCoached": true, "identifier": "lta-4c84c06d-1e98-415c-9d18-3110f2c6b7d1", "description": "Each week's session focuses on a different area of the game and you will improve your ability with a mixture of skills training from professional coaches and match play with other women at your level. We provide the courts, rackets and coaches - you get the fun and can be competitive as you want, without feeling under pressure.", "genderRestriction": { "id": "http://openactive.io/ns#Female", "identifier": "Female", "name": "Female only", "type": "GenderRestrictionType" }, "_integrationId": "lta", "potentialAction": [], "accessibilitySupport": [], "imin:specialRequirements": [], "leader": [], "organizer": [], "image": [], "id": "https://search.imin.co/v2/sessions/lta-4c84c06d-1e98-415c-9d18-3110f2c6b7d1#!/subEvent/2018-09-11T18:00:00Z", "subEvent": [ { "type": "Event", "startDate": "2018-09-11T18:00:00Z", "endDate": "2018-09-11T19:00:00Z", "potentialAction": [], "id": "https://search.imin.co/v2/sessions/lta-4c84c06d-1e98-415c-9d18-3110f2c6b7d1#!/subEvent/2018-09-11T18:00:00Z" } ]}The filters that accept multiple values are:
activityactivity.prefLabelactivity[member-of]accessibilitySupportaccessibilitySupport.prefLabelsubEvent.startDate[day-of-week]genderRestrictionintegrationIdintegrationId[not]categorycategory[not]category.prefLabelcategory.prefLabel[not]