Service get_activities

 

 

Descritpion

Service permettant d'obtenir une liste d'activités sans le détail de ses représentations par ordre chronologique. Ce service prend les paramètres directement par le biais de l'hyperlien, au format GET.

 

Exemple d’utilisation :

http://[URL]/lavitrinejsonapi?key=[KEY]&command=get_activities&discipline=1&lang=fr&maxcount=25&startindex=1&organisme=abc.

 

Paramètres acceptés :

command : get_activities
discipline : Référence au numéro d'identification unique de la discipline souhaitée. Possibilité d'ajouter plusieurs numéros de discipline espacés par une virgule. Si le paramètre n'est pas fixé ou non valide, toutes les activités sont retournées, toutes disciplines confondues.
lang : La langue des informations retournées (titre, résumé, etc.). Si ce paramètre est inexistant ou non valide, la valeur « fr » est assumée. Les valeurs permises sont « fr » et « en ».
maxcount : Le nombre entier maximal d'activités (entre 0 et n) à retourner. Si ce paramètre est inexistant ou non valide, la valeur « 10 » est assumée.
startindex : La position du premier élément (entre 0 et n) à retourner. Si ce paramètre est inexistant ou non valide, c'est la valeur « 0 » qui est assumée.
last_minute_activities_only : Avec une valeur « 1 », on ne retourne que les activités avec un fanion « dernière minute » à la valeur « 1 ». Avec une valeur de « 0 », on retourne toutes les activités. Si ce paramètre est inexistant ou non valide, c'est la valeur « 0 » qui est assumée. Les valeurs permises sont « 0 » et « 1 ».
presale_activities_only : Avec une valeur « 1 », on ne retourne que les activités avec un fanion « prévente » à la valeur « 1 ». Avec une valeur de « 0 », on retourne toutes les activités. Si ce paramètre est inexistant ou non valide, c'est la valeur « 0 » qui est assumée. Les valeurs permises sont « 0 » et « 1 ».
eventid : Référence au numéro d'identification unique de l’événement souhaité. Si le paramètre n'est pas fixé ou non valide, toutes les activités sont retournées, tous événements confondus.
location : Référence au numéro d'identification unique de l’emplacement souhaité. Si le paramètre n'est pas fixé ou non valide, toutes les activités sont retournées, tous emplacements confondus.
sector : Référence au numéro d'identification unique du secteur souhaité. Possibilité d'ajouter plusieurs numéros de secteur espacés par une virgule. Si le paramètre n'est pas fixé ou non valide, toutes les activités sont retournées, tous secteurs confondus.
start_date : La date de début de l’activité. Le format accepté est DD-MM-YYYY.
end_date : La date de fin de l’activité. Le format accepté est DD-MM-YYYY.
rating : Référence au numéro d'identification unique du public cible souhaité. Si le paramètre n'est pas fixé ou non valide, toutes les activités sont retournées, tout public cible confondu.
organisme : Référence à l'identifiant de l’organisme qui sert à filtrer les résultats de recherche.
lastModification : Référence à la date de dernière modification. Le format accepté est : YYYY-MM-DD-HH-MM. Exemple : lastModification=2013-04-29-15-45.
disciplinesWebOnly : Avec une valeur « 1 », on ne retourne que les activités qui ont une discipline s'affichant sur le site Web de La Vitrine. Avec une valeur de « 0 », on retourne toutes les activités. Si ce paramètre est inexistant ou non valide, c'est la valeur « 0 » qui est assumée. Les valeurs permises sont « 0 » et « 1 ».

 

Réponse :

 

Retourne la liste d’activités correspondantes triées par ordre chronologique sur la date de début. Chacune des activités inclut les informations suivantes :

 

id : Numéro d'identification unique de l’activité.
title : Titre de l’activité (français ou anglais).
description : Description de l’activité (français ou anglais).
image_url : Référence hyperlien à une vignette illustrant l'activité (200 x 200 pixels). Si aucune image n’est disponible pour l’activité, l’image de la discipline est fournie, si aucune image n’est fournie pour la discipline une image « place holder » est fournie.
last_minute : Fanion précisant si au moins une des représentations est au statut de dernière minute. Prend les valeurs « 0 » ou « 1 ».
start_date : Date de début de la prochaine représentation.
end_date : Date de fin de la prochaine représentation.
last_modication : Date de la dernière modification de l’activité.
sef_url : Référence hyperlien à l’activité. Permet d’accéder directement à la description de l’activité via le site de La Vitrine.
discipline_id : Numéro d'identification de la discipline.
discipline : Nom de la discipline (français ou anglais).
sub_discipline_id : Numéro d'identification de la sous discipline.
sub_discipline : Nom de la sous discipline (français ou anglais).
is_quebec : Indique si l'activité est classée comme « québécoise ».
presale : Fanion précisant si au moins une des représentations est au statut de prévente. Prend les valeurs « 0 » ou « 1 ».