Service :: Détail d'une activité

L'URL permettant d'accéder aux détails d'une activité spécifique se construit sur base de l'identifiant de l'activité; que l'on notera activityId:

{siteUrl}/{activityId}/xml

L'URL de chaque activité récupérée via le service get/activities est incluse dans la réponse de ce service.

Le retour du service de détail d'une activité est illustré ci-dessous.

⚠️ Ceci n'est qu'un exemple: plusieurs variantes des tags illustrés existent (notamment en cas de contenu bilingue) et sont décrits ci-après.

<Activity type="object" id="52897" iid="52897" className="Activity">
 <title>Tennis passion</title>
 <creator>admin</creator>
 <created type="DateTime">2025/05/06 16:17:8.693788 GMT+2</created>
 <modified type="DateTime">2025/05/06 20:42:45.268810 GMT+2</modified>
 <modifier>admin</modifier>
 <summary>Initiation au tennis, par un ancien pro</summary>
 <description>&lt;p&gt;Le tennis s'apprend dès le plus jeune âge. C'est une école de vie, de discipline, de persévérance et de dépassement de soi.&lt;/p&gt;
              &lt;p&gt;C'est un exemple de chemin difficile mais passionnant qui produit bonheur et plaisir.&lt;/p&gt;
              &lt;p&gt;Amateur de padel et autres dérivés du jokari, passe ton chemin.&lt;/p&gt;</description>
 <variety>standard</variety>
 <externalUrl/>
 <internalUrl>http://{siteUrl}/register/activity?id=52897</internalUrl>
 <publicUrl>http://{siteUrl}/52897/view?popup=True&pageLayout=w*aw*center</publicUrl>
 <picture type="file" mimeType="image/png" name="tennis.png">
  <part type="base64" number="1">iVBORw0KGg...</part>
 </picture>
 <language>fr</language>
 <capacityDict type="dict">
  <entry type="object">
   <k>62897</k>
   <v type="object" className="Object">
    <capacity type="int">10</capacity>
   </v>
   </entry>
   <entry type="object">
    <k>62898</k>
    <v type="object" className="Object">
     <capacity type="int">10</capacity>
    </v>
   </entry>
 </capacityDict>
 <periodType>normal</periodType>
 <domain>tennis</domain>
 <ageSlice/>
 <minAge type="float">4.0</minAge>
 <maxAge type="float">6.0</maxAge>
 <agePrices type="bool">False</agePrices>
 <pricesPerAge/>
 <schoolLevels/>
 <equipment>Tout est prévu</equipment>
 <registerParents>impossible</registerParents>
 <fiscal type="bool">False</fiscal>
 <insurance type="bool">False</insurance>
 <medical type="bool">False</medical>
 <blockingMedical type="bool">False</blockingMedical>
 <targets type="list" count="1">
  <e type="object" className="Object">
   <url>{siteUrl}/49627/xml</url>
   <id>jeunesse</id>
  </e>
 </targets>
 <tags type="list" count="1">
  <e type="object" className="Object">
   <url>http://{siteUrl}/49594/xml</url>
   <id>sport</id>
  </e>
 </tags>
 <citizenPrice>100 €</citizenPrice>
 <partnerXml>&lt;a&gt; href="https://tennis.passion.sport">Tennis Passion&lt;a&gt;/a&lt;a&gt;</partnerXml>
 <periods type="list" count="2"/>
  <e>{siteUrl}/62897/xml</e>
  <e>{siteUrl}/62898/xml</e>
 </periods>
 <innerPeriods/>
 <placeTitle>Club de tennis M.A.R.S</placeTitle>
 </Activity>

Les sous-sections suivantes donnent tous les détails au sujet de ce type de réponse.

Zones de texte

Chaque activité est décrite par quatre zones de texte :

• son titre (tag title) ;
• un résumé (tag summary), zone de texte non formaté mais pouvant s’étendre sur plusieurs lignes ;
• une description (tag homonyme), plus complète, sous la forme d’une zone de texte riche au format XHTML ;
• des détails horaires (tag scheduleDetails), sous la forme d'une ligne de texte. Ces détails (non illustrés sur l'exemple ci-dessus) sont optionnels et donnent des précisions sur l’horaire et l’éventuelle récurrence de l’activité.

Si le site rEve est configuré en mode bilingue, pour chacun de ces champs de texte, la structure est plus complexe et inclut les versions dans les deux langues supportées (en général, le français et le néerlandais).

En voici un exemple.

Voici un exemple du tag summary en mode bilingue.

Un exemple du tag description en mode bilingue.

Et enfin, un exemple du tag scheduleDetails en mode bilingue.

Ces structures XML sont le résultat du marshalling d’un dictionnaire Python (une table associative).
Notez que, sur certains sites qui auraient activé le bilinguisme seulement à partir d'une certaine date, toute activité dont la date de création serait antérieure à cette date ne disposeront pas de cette structuration bilingue, mais bien de la structuration standard telle que présentée dans l'exemple de base.. Dans cette structuration standard, la langue utilisée pour rédiger le contenu des tags peut être soit le français, soit le néerlandais, sans qu’aucun autre élément n’indique de quelle langue il s’agit.
Dès qu’une activité adopte le mode bilingue, outre la structuration plus complexe de certains tags, un tag additionnel « language » précise la langue qui sera utilisée lors de l’activité. Ce tag est illustré ci-dessous, et peut valoir « fr » ou « nl ».

Type et variété de l’activité

Le type de l’activité, dont les valeurs possibles sont déjà décrites dans le service get/activities, est repris sous le tag periodType (il ne s’appelle pas activityType pour des raisons historiques). Sa variété est spécifiée via le tag variety. Les valeurs légales de ce dernier tag sont reprises dans le tableau ci-dessous.

standard

free

open

external

Selon la variété, une URL est ou non mise à disposition, permettant de démarrer le processus d’inscription à cette activité via clic depuis un site externe.

• Pour les activités de variété « standard » et « free », le tag internalUrl est fourni. Pour toute autre variété, le tag est vide.
• Pour les activités de variété « external », le tag externalUrl contient l’URL fournie par le site externe via lequel l’inscription peut se réaliser. Pour toute autre variété, ce tag est vide.
• Pour les activités de variété « open », tant le tag internalUrl qu’externalUrl sont vides.

Publics-cibles et tags

Chaque activité peut être flaggée avec plusieurs publics-cibles (tag nommé targets) et plusieurs tags (tag nommé tags).

Sur l’exemple de base, l’activité s’adresse au public « Jeunesse » et porte sur la thématique représentée par le tag « Sport ».

Deux services distincts vous permettent de récupérer les listes de publics-cibles et tags actuellement activés, donnant, pour chacun, un identifiant et une éventuelle description.

Équipement à apporter

Si l’activité requiert que les participants apportent un matériel quelconque, celui-ci peut être décrit dans le tag equipment. Ce tag, si rempli, contient une chaîne de caractères sans formatage ni passage à la ligne.

Dans le contexte d’une activité au contenu bilingue, le tag equipment l’est également et aura une structuration telle d’illustrée ci-dessous.

Photo ou image

Une photo ou une image illustrant l’activité peut être présente dans le tag picture, structuré comme expliqué dans la page d'introduction à l'API, section Fichiers binaires.

Pour rappel, l’image est découpée en segments, chacun contenant une de ses parties, encodée en Base64. Pour reconstituer l’image, il est plus performant de décoder chaque segment puis de concaténer le résultat dans un objet de type stream. Il se peut que l’image soit d’un autre type que celui de l’exemple ci-dessus (généralement : JPEG, PNG ou GIF).

Périodes et capacités

Une activité est programmée pour survenir lors d’une ou plusieurs périodes. Une période peut représenter :

• une semaine complète,

• un intervalle plus réduit, allant jusqu’au jour unique pour un événement ou un excursion ;

• un intervalle plus vaste, pouvant par exemple représenter une tranche de plusieurs mois, dans le contexte d’activités parascolaires (par exemple, du 1^er septembre au 31 décembre).

Chaque période, au sein d'un site rEve, dispose d’un identifiant.

Le tag capacityDict, présent sur chaque activité, contient une double information : la liste des périodes auxquelles l’activité est programmée, ainsi que le nombre de places maximal pour chacune de ces périodes. En voici un exemple.

Dans cet exemple, similaire à l'exemple de base, l’activité est programmée à 2 périodes : la 6035 et la 6037. Pour chacune d’entre elles, le nombre maximum de participants est de 16. Il est le même pour les 2 périodes mais aurait tout aussi bien pu être différent.

Périodes internes et périodes externes

Les périodes associées à une activité peuvent être externes ou internes. Une période externe correspond à une période prédéfinie, standardisée, comme une période de vacances scolaires, qu’il est opportun de définir à l’avance, indépendamment de toute activité. Lors de l’encodage d’une activité, on peut alors sélectionner la ou les périodes externes auxquelles l’activité a lieu. Lorsqu’une activité est liée à une ou plusieurs périodes externes, le tag periods est tel que représenté sur l'exemple de base, repris ci-dessous.

<periods type="list" count="2"/>
 <e>{siteUrl}/62897/xml</e>
 <e>{siteUrl}/62898/xml</e>
</periods>

Il est possible, via une requête HTTP GET supplémentaire, de récupérer des informations détaillées au sujet de chaque période. L’URL d’une période, illustrée ci-dessus, se construit sur base de son identifiant numérique (notons-le <ID>). La forme de cette URL est la suivante.

{appURL}/{ID}/xml

Une requête de ce type produit le résultat décrit ici.

Toute activité ne se prête pas facilement au jeu des périodes externes. Une activité représentant un événement, par exemple, définira un ou plusieurs créneaux horaires ou une ou plusieurs plages de dates qui lui sont spécifiques. Dans ce cas, rEve permet de lui définir une ou plusieurs périodes internes, propres à l’activité. Chaque période interne peut représenter un créneau horaire au sein d’une même journée ou, à l’instar des périodes externes, une plage de dates couvrant plusieurs jours. Lorsqu’une activité définit une ou plusieurs périodes internes, voici comment cela se représente.

Les champs d’une période interne sont similaires à ceux d'une période externe, décrits ici.

Prix

Le prix de l’activité est contenu dans le tag citizentPrice. Dans sa forme la plus simple, il contient uniquement un montant, suffixé du symbole « euro », comme illustré sur l'exemple de base.

<citizenPrice>100 €</citizenPrice>

Le contenu de ce tag peut cependant prendre des formes plus complexes. Si l’activité s’étend sur plusieurs périodes et que le prix n’est pas identique d’une période à l’autre, une précision est indiquée entre parenthèses, comme montré ci-dessous.

<citizenPrice>90 € (70€ pour les semaines du 14/08 au 18/08, du 28/08 au 01/09)</citizenPrice>

Dans cet exemple, il s’agit d’une activité proposée sur diverses semaines de l’été ; parmi celles-ci, il y en a deux pour lesquelles le prix est moindre car l‘activité dure une journée de moins. En effet, le 15 août est férié et le 1er septembre est le jour de la rentrée des classes.
Si des prix dégressifs sont d’application, le contenu les explicite, incorporant également du formatage XHTML, comme illustré ci-dessous.

<citizenPrice>95 € &lt;span class="discreet" style="margin-left:7px"&gt;2e enfant: 85€ - 3e enfant: 75€ - 4e enfant (et suivants): 65€&lt;/span&gt;</citizenPrice>

Dans tous les cas de figure, les prix affichés dans le tag citizenPrice sont ceux payés par les habitants de la zone privilégiée, déterminée par le code postal de l’association ou du pouvoir public gérant le site. Cela permet à ce dernier d’appliquer, s’il le souhaite, une majoration de prix pour les parents habitant en dehors de cette zone.

Restrictions d'accès basées sur l'âge

Pour certains événements ou certaines activités, il se peut qu’une restriction d’accès, généralement basée sur l’âge, soit d’application. Pour chaque type d’activités activé, un modèle d’âge est configuré.
Les modèles d’âge existants sont décrits dans le tableau suivant.

Dans l'exemple, l'activité, via son type normal (stage), applique le modèle "Tranches d'âges variables", avec encodage d'un âge minimum et d'un âge maximum dans les tags minAge et maxAge.

<minAge type="float">4.0</minAge>
<maxAge type="float">6.0</maxAge>

Des nombres réels peuvent être utilisés : un stage peut par exemple être ouverts aux enfants de 2 ans et demi jusqu’à 4 ans.

Pour d'autres types d'activités, notamment parascolaires, c'est le niveau scolaire qui est utilisé. Dans un tel cas, c'est le tag schoolLevels qui est utilisé. L'exemple suivant décrit une activité accessible aux enfants de la première à la sixième primaire.

L’ensemble des valeurs possibles pour le niveau scolaire est déterminé dans le tableau ci-dessous.

acc

m1 à m3

p1 à p6

ps

s1 à s6

s1d

s2d

Le tableau suivant donne les tranches d’âges existantes, dans le contexte du modèle « Tranches d’âges fixes ». Quand ce type de modèle s’applique, une seule des valeurs ci-dessous doit êre spécifiée dans le tag ageSlice. Notez que ce modèle a tendance à être abandonné.

small

medium

large

xlarge

Enfin, en ce qui concerne les activités pour lesquelles aucun modèle d’age n’est d’application, tous les tags mentionnés seront vides. De manière générale, à chaque fois qu’un modèle d’âge donné est appliqué sur une activité, tous les tags relatifs aux autres modèles d’âge seront vides.

Lieu

Le lieu de l'activité, comme montré sur l’exemple, est repris dans le tag placeTitle. Si spécifié, il contient une chaîne de caractères sans formatage ni passages à la ligne.

<placeTitle>Club de tennis M.A.R.S</placeTitle>

Partenaire

Le nom du partenaire qui propose l’activité est défini dans le tag partnerXml. Si le lien vers le site web du partenaire est renseigné dans la base de donnée du logiciel, le tag le contiendra un lien comme illustré ci-dessous. Sinon, le tag ne contiendra que le nom du partenaire.

<partnerXml>&lt;a&gt; href="https://tennis.passion.sport">Tennis Passion&lt;a&gt;/a&lt;a&gt;</partnerXml>

Inscription des parents

Certaines activités, telles des événements, sont prévues pour des enfants, mais offrent la possibilité aux parents de s’y inscrire en tant qu’accompagnants. Cette possibilité est formalisée par le tag registerParents dont les valeurs possibles sont listées ci-dessous.

impossible

optional

mandatory

Tags additionnels

Des tags additionnels, non documentés et actuellement inutiles dans le contexte précis de l’API publique d'un site rEve, peuvent être présents au sein des fichiers XML d’activités. Ils doivent être simplement ignorés.