Service get_locations
Description
Service permettant d'obtenir une liste à jour des emplacements disponibles. Ce service prend les paramètres directement par le biais de l'hyperlien, au format GET.
Exemple d’utilisation :
http://[URL]/lavitrinejsonapi?key=d41d8cd98f00b204e9800998ecf8427e&command=get_locations&lang=fr
Paramètres acceptés :
| command : | get_locations |
| id : | Référence au numéro d'identification unique de l'emplacement souhaité. |
| 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 ». |
| withShowing : | Permet d’afficher seulement les emplacements qui ont présentement une ou des représentations (showings). La valeur 0 fournie au paramètre retourne la liste les locations peu importe s’ils ont des représentations (showing) ou non. La valeur 1 fournie au paramètre retourne la liste des locations qui ont actuellement des représentations (showing). Si ce paramètre n’est pas fourni, la valeur 1 sera utilisée par défaut. |
| sector : | Ce paramètre accepte un secteur numérique (sector_id) et filtre le résultat selon ce dernier. Ce paramètre n’est pas obligatoire. S’il n’est pas fourni, il ne sera pas pris en compte. |
| organisme : | Référence au nom d’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. Ex: lastModification=2013-04-29-15-45. |
Réponse :
| id : | Référence au numéro d'identification unique de l'emplacement souhaité. | ||||||||||
| sector : | Nom du secteur de l'emplacement. | ||||||||||
| sector_id : | Numéro du secteur. | ||||||||||
| sub_sector_id : | Numéro d'identification du sous-secteur. | ||||||||||
| sub_sector : | Le nom du sous-secteur où se trouve l'emplacement. | ||||||||||
| phone : | Numéro de téléphone principal. | ||||||||||
| adress : | Sur une ligne rue, ville, province, code postal. | ||||||||||
| title : | Nom de l’emplacement (français ou anglais). | ||||||||||
| image_url : | URL de l’image principale reliée à l’emplacement. | ||||||||||
| description : | Description de l’emplacement. | ||||||||||
| longitude : | Coordonnée géographique (Est-Ouest). | ||||||||||
| latitude : | Coordonnée géographique (Nord-Sud). | ||||||||||
| sef_url : | URL qui mène vers l’emplacement sur le site. | ||||||||||
| medias : | Liste des médias associés à l'emplacement. | ||||||||||
|