Service :: Liste des activités
L’URL ci-dessous permet de récupérer la liste complète des activités actuellement publiées sur le site. Une activité publiée n’est pas nécessairement (encore) ouverte pour inscription.
{siteUrl}/get/activities
Voici un exemple de réponse. Elle est tronquée à 2 éléments sur un total de 6.
<activities type="list" count="6">
<e type="object" className="Object">
<title>Tennis passion</title>
<url>http://{siteUrl}/52897/xml</url>
<activityType>normal</activityType>
</e>
<e type="object" className="Object">
<title>Tout le monde Ă la mer</title>
<url>http://{siteUrl}/15827/xml</url>
<activityType>trip</activityType>
</e>
...
</activities>
3 informations sont présentes dans la liste pour chaque activité :
- son nom (tag title) ;
- son URL (tag url), permettant, via une requête HTTP GET additionnelle, de récupérer l’entièreté de la description de l’activité (voir la section suivante) ;
- son type (tag activityType), pouvant valoir une des valeurs listées dans le tableau ci-dessous.
En outre, l’identifiant de chaque activité est présent dans son URL. La première activité, par exemple, a l’identifiant 52897. Ce type d’identifiant vous permet notamment :
- de savoir si vous avez déjà récupéré les données concernant cette activité ;
- de lancer une synchronisation de données sur une activité précise, car son URL peut se reconstruire facilement sur base de cet identifiant.
| Valeur |
Type d'activité |
normal |
Stages pour enfants |
normal2 |
Un stage. Il existe 2 types, normal et normal2, afin que deux jeux de stages différents puissent disposer de configurations différentes (types de tranches d'âge, production ou non d'attestations fiscales, fiche infos requises, obligatoires ou non...) ou soient gérées par des domaines distincts. |
trip |
Excursion pour enfants, avec ou sans leurs parents, dont l'inscription se fait directement dans le logiciel. À ne pas confondre avec une excursion pour laquelle une inscription groupée serait réalisée par une école, en direct avec le partenaire organisant l'excursion (reprise, dans ce cas, sous le type schooltime, voir plus bas). |
trip2 |
Idem, avec configuration différente potentielle ou gestion par un domaine distinct |
after |
Activités parascolaires pour enfants |
after2 |
Idem, avec configuration différente potentielle ou gestion par un domaine distinct |
after3 |
Idem, avec configuration différente potentielle ou gestion par un domaine distinct |
camp |
Colonies de vacances pour enfants, dont l'inscription se fait par les parents. À ne pas confondre avec une classe verte par exemple, pour laquelle une inscription groupée serait réalisée par une école, en direct avec le partenaire organisateur (activité reprise, dans ce cas, sous type schooltime, voir plus bas). |
aid |
Aides à l'édude pour enfants, ados et jeunes adultes |
schooltime |
Activité à inscription automatique, qui reflète, pour chaque citoyen, une activité ayant fait l'objet, en-dehors du logiciel, d'une activité groupée, réalisée par l'école pour les élèves d'une ou plusieurs de ses classes. Ce type de comprend pas les inscriptions aux garderies et repas chauds organisés par les écoles, qui font l'objet d'inscriptions par les parents eux-mêmes et qui sont représentées par les types daycare et meal (voir plus bas). |
event |
Événement de nature diverse et variée: conférence, exposition, etc. Au contraire des types d'activités ci-dessus, un événement est généralement configuré pour l'achat d'un ou plusieurs tickets non nominatifs, pour tout public. |
event2 |
Jeu additionnel d'événements pouvant être configurés différemment. |
event3 |
Idem. |
event4 |
Idem. |
workshop |
Un workshop est une activité à inscription nominative, mais pour adultes, pas pour enfants. |
daycare |
Garderies scolaires, organisées par des écoles le matin, le soir et le mercredi après-midi |
meal |
Repas chauds durant le temps de midi dans les Ă©coles |
Un sous-ensemble seulement de ces types est probablement activé sur chaque site rEve. Un service spécifique vous permet de récupérer la liste des types d'activiés utilisés.
Paramètre type
L’URL peut accepter un paramètre permettant de ne récupérer que les activités d’un type donné. Par exemple, appeler :
{siteUrl}/get/activities?type=trip
produira la même liste que précédemment, mais contenant uniquement les activités de type trip.
Il est possible de spécifier plusieurs types, séparés par des virgules. Dans ce cas, le résultat contiendra les activités de tous ces types (il s’agit d’un « or » logique). Voici un exemple :
{siteUrl}/get/activities?type=normal,trip
Paramètre domainCategory
Un second paramètre peut également être spécifié et n'a de sens que sur un site rEve multi-domaines, c'est-à -dire dont les activités sont gérées par plusieurs entités (par exemple, plusieurs services communaux et/ou asbl paracommunales).
Il permet de ne récupérer que les activités issues de domaines étant associés à une catégorie définie.
Voici un exemple:
{siteUrl}/get/activities?domainCategory=website
À l'instar du paramètre type, le paramètre domainCategory peut accepter plusieurs identifiants de catégories de domaines, séparés par des virgules.
Vous pouvez consulter la liste des catégories de domaine actives via ce service spécifique.
Combiner tous les paramètres
Il est bien entendu possible de combiner tous les paramètres, comme sur cet exemple.
{siteUrl}/get/activities&type=normal,trip&domainCategory=website
