Comme expliqué ici, une activité a lieu durant une ou plusieurs périodes, externes ou internes. Les informations concernant les périodes internes à une activité sont consultables directement au sein des infos de l'activité. Pour une période externe, il faut récupérer ces infos via un service distinct, dont l'URL est basée sur l'identifiant de la période, noté periodId et dont la structure est la suivante.
{siteUrl}/{periodId}/xml
Voici un exemple.
Une période peut représenter une semaine, un jour ou un intervalle de jours arbitraire allant de quelques jours à plusieurs mois. L’intervalle temporel précis est défini par les tags startDate et endDate.
Chaque période est liée à une macro-période (tag macroPeriod), c’est-à-dire un ensemble de plusieurs semaines similaires, comme les 9 semaines d’été ou les 2 semaines de Pâques. Les valeurs possibles pour le tag macroPeriod sont listées dans le tableau ci-dessous.
| Code |
Macro-période |
halloween |
Congé d'automne (Toussaint) |
after |
Macro-période abstraite pour toute activité de type Parascolaire. |
after2 |
Macro-période abstraite pour toute activité de type Stage du mercredi |
after3 |
Macro-période abstraite pour toute activité de type Activité du mercredi |
carnival |
Congé de détente (Carnaval) |
easter |
Vacances de printemps (Pâques) |
summer |
Été (pour les stages) |
trip |
Macro-période abstraite pour toute activité de type Excursion |
camp |
Été (pour les colonies) |
aid |
Macro-période abstraite pour toute activité de type Aide à l’étude |
Le tag week donne, quant à lui, le numéro de la semaine représentant la période au sein de la macro-période. Pour Pâques, par exemple, il peut valoir 1 ou 2. Pour les deux macro-périodes d’été, il peut valoir de 1 à 9, voire 10 selon la découpe de l’été en fonction de l’année. Le tag week est vide si la macro-période est abstraite (n’est donc pas découpée en semaines) ou si elle ne s’étend que sur une semaine unique (comme Carnaval ou Toussaint).
L’exemple suivant représente une période de type parascolaire. Notez que, par rapport à l’exemple précédent, la plage de dates est bien plus large et le tag week est vide.
Voici quelques informations concernant les autres tags.
-
publishDate est la date de mise à disponibilité pour réservation par les citoyens.
-
publishDatePrivileged, par défaut non utilisée, est une date spécifique permettant l‘ouverture anticipée des inscriptions aux parents habitant la zone privilégiée. Si cette date n’est pas spécifiée, publishDate est utilisée pour tout le monde.
-
unpublishDate est la date de fin de disponibilité pour les citoyens.
-
partnerPublishDate est la date de mise à disponibilité pour affectation d'activités par les partenaires.
-
partnerUnpublishDate est la date de fin de disponibilité pour les partenaires.
-
Le tag days représente le nombre de jours effectifs d’activités durant la période. Pour une période longue de type parascolaire, ce nombre n’est pas utilisé et ne correspond pas au nombre de jours effectifs de l’activité Une période de 5 jours comportant un jour férié durant lequel l’activité n’a pas lieu aura une valeur de 4 au lieu de 5 par exemple.
-
Pour afficher le titre de la période, si le tag periodTitle est non vide, préférez-le au tag title.
-
Les autres tags inclus dans le fichier peuvent être ignorés.
