Recherche d'événements par critères
Via l'API Amienscope, vous avez également la possibilité de requêter des listings d'événements sur des critères spécifiques, afin d'obtenir des listings personnalisés.
Ces listings peuvent prendre comme paramètres de recherche une catégorie, une date de début ("à partir de telle date"), le caractère gratuit ou payant, le type de public visé, et le filtrage sur une forme d'accessibilité.
Requête sur l'API
/search/<category_id>/<timestamp_from>/free|paying|all/<audience_id>/<accessibility_id>
L'identifiant de catégorie est identifiable via la requête de catégories, le type de public visé grâce à la requête des types de publics, et le type d'accessibilité à l'aide de la requête des formes d'accessibilité.
Le caractère gratuit, payant (ou les deux) est définissable sur son segment grâce au critère : free
(événements gratuits uniquement), paying
(événements payants uniquement), ou all
(événements gratuits et payants, sans distinction)
category_id
et audience_id
, il vous est possible d'indiquer que de rechercher "tout" (soit aucune distinction de catégorie ou de type de public). Pour ce faire, remplacez ce segment d'URL par all.Exemples
Les événements de la catégorie Concerts (ID 4), ayant lieu à partir du 13/10/2015, sans distinction de gratuité ou non, visant le Jeune Public (ID 2) :
https://api.amienscope.fr/search/4/1444687200/all/2
Les événements de la catégorie Théâtre (ID 3), ayant lieu à partir du 04/10/2015 à 15h30, payants uniquement, et pour Tout public uniquement (ID 1) :
https://api.amienscope.fr/search/3/1443965400/paying/1
Les événements de toutes catégories confondues, ayant lieu à partir du 19/10/2015, gratuits, et pour tous types de public confondus :
https://api.amienscope.fr/search/all/1445205600/free/all
Les événements de la catégorie Théâtre (ID 3), ayant lieu à partir du 04/10/2015 à 15h30, payants ou gratuits, pour tous types de public confondus, et disposant d'un accès aux personnes à mobilité réduite (forme d'accessibilité ID 1 dans cet exemple) :
https://api.amienscope.fr/search/3/1443965400/all/all/1
Valeurs de retour
Cette requête effectue une requête classique de listing d'une catégorie, par conséquent les champs retournés sont les mêmes que dans un listing catégoriel. Voir le détail sur la page Liste d'événements d'une catégorie.
Pagination et limitation du listing : offset et limit
Par défaut, en l'absence de paramètres de pagination, les listings sont limités à 20 événements à partir du premier.
Dans le cadre d'une navigation par pagination, il vous est possible d'ajouter des paramètres offet et limit à l'URL de la requête afin d'obtenir des listings paginés.
Requête sur l'API
GET /search/<category_id>/<timestamp_from>/free|paying|all/<audience_id>/<accessibility_id>/<offset>,<limit>
Les paramètres offset et limit doivent être des entiers, et obligatoirement passés à l'URL sous le format « offset,limit ».
Par exemple, pour obtenir une liste de 10 événements à partir du 20ème élément, qui ont lieu à compter du 11/10/2015 à 18h00 (timestamp : 1444579200), dans la catégorie « Théâtre » (category ID = 3), qui soient payants, et visant tous les publics (audience ID = 1), sans forme d'accessibilié particulière, la requête effectuée sera la suivante :
https://api.amienscope.fr/search/3/1445005711/paying/1/all/20,10
Voir aussi
- /get/organisers
- Organisateurs d'événements connus de l'API
- /get/events/<id>
- Événements présents dans une catégorie donnée
- /get/from_organiser/<id>
- Événements d'un organisateur donné
- /get/audiences
- Liste des publics visés utilisés par les événements
- /get/event/<id>
- Détail des informations complètes d'un événement spécifique
- /get/updates/<time>
- Événements mis à jour ou modifiés depuis une date donnée
- /get/highlights
- Événements mis en avant par la collectivité (ou « À la Une »)
- /get/recent
- Événements ajoutés le plus récemment
- /get/next
- Prochains événements à venir, sans distinction de catégorie
- /get/popular
- Événements les plus populaires
- /get/accessibilities
- Liste des formes d'accessibilité disponibles
- /get/from_accessibility
- Liste d'événements correspondant à une forme d'accessibilité