Événements mis à jour
Les événements mis à jour sont les événements qui ont connu une modification de leurs informations ou de leur statut, depuis une date donnée qui sera fournie dans la requête.
Cette requête peut être utilisée par exemple si vous souhaitez mettre à jour les données de votre application en ne requêtant que les éléments qui ont été modifiés (ou qui ont été supprimés/archivés) afin de limiter le volume des données à récupérer et à traiter.
La requête prend comme argument un timestamp UNIX qui est la date à partir de laquelle vous souhaitez les événement mis à jour.
Requête sur l'API
https://api.amienscope.fr/get/updates/<timestamp_from>
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.
Les événements issus de cette requête sont ordonnés par date de prochaine représentation croissante.
Exemple
Pour obtenir une liste des événements modifiés ou mis à jour depuis le 10/10/2015 à 14:30:20 (timestamp UNIX : 1444480220), la requête effectuée sera :
https://api.amienscope.fr/get/updates/1444428000
État des événements : event_status_id
event_status_id | event_status_label | Événement visible du public ? |
---|---|---|
1 |
En attente de publication | Non |
2 |
Publié | Oui |
3 |
Annulé | Oui |
5 |
Supprimé | Non |
6 |
Archivé | Non |
L'état (ou statut) d'un événement est caractérisé par son champ event_status_id. Cet identifiant numérique indique l'état de l'événement, illustré par le champ event_status_label qui lui est textuel et lisible.
Si votre application ne comporte pas de mise en cache des événements en local, il y a de fortes chances pour que vous n'ayez même pas besoin de cette requête dédiée aux événements mis à jour.
Limitation du listing à une catégorie spécifique
Dans le cas où vous souhaiteriez n'obtenir les événements mis à jour ou modifiés que sur une catégorie donnée, il suffira d'ajouter en fin d'URL l'identifiant de cette catégorie (obtenu par requête sur les catégories) pour limiter le listing aux mises à jour sur cette catégorie uniquement.
Requête sur l'API
GET https://api.amienscope.fr/get/updates/<timestamp_from>/<category_id>
Par exemple, pour obtenir les événements mis à jour, modifiés, ou dont le statut a été modifié depuis 10/10/2015 à 14:30:20 (timestamp UNIX : 1444480220), limité à la catégorie Concert (ID 4), on effectuera la requête suivante :
https://api.amienscope.fr/get/updates/1444428000/20,10
Pagination du listing : offset et limit
À la différence des autres requêtes de listings (qui, en l'absence de paramètre de pagination dans l'URL, sont limitées à 20 événements à partir du premier, et remontent un maximum de 50 éléments), cette requête remonte un listing complet sans limitation si aucun paramètre de pagination n'est renseigné dans l'URL.
Si toutefois vous souhaitez obtenir la liste des événements mis à jour depuis une date donnée, et qui cette fois serait paginée, il vous est possible d'ajouter des paramètres offet et limit à l'URL de la requête afin d'obtenir des listings fractionnés.
De ce fait, si par exemple vous souhaitez un listing paginé pour cette requête, et obtenir les 20 premiers éléments, il sera obligatoire de renseigner le paramètre /0,20 en fin d'URL. Sans ce paramètre, la requête renverra un listing complet de tous les événements mis à jour, sans pagination.
Requête sur l'API
GET https://api.amienscope.fr/get/updates/<timestamp_from>/<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 mis à jour depuis le 10/10/2015 à 14:30:20 (timestamp UNIX : 1444480220), à partir du 20ème élément, la requête effectuée sera la suivante :
https://api.amienscope.fr/get/updates/1444428000/20,10
Voir aussi
- /get/categories
- Catégories d'événements utilisées dans l'API
- /get/audiences
- Liste des publics visés utilisés par les événements
- /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/event/<id>
- Détail des informations complètes d'un événement spécifique
- /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
- /search/<criteria>
- Recherche d'événements par critères spécifiques
- /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é