From 02cf7861f39f943be43abe2a986f08a2b710791e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 17 May 2023 16:08:33 +0200 Subject: [PATCH] Documentation for HouseholdComposition in doc generation --- .../template personne.odt | 4 ++-- admin/generation-documents.md | 20 ++++++++++++++++++- 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/admin/generation-documents-templates/template personne.odt b/admin/generation-documents-templates/template personne.odt index ed8f2be..0f608a0 100644 --- a/admin/generation-documents-templates/template personne.odt +++ b/admin/generation-documents-templates/template personne.odt @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:203b005979f42c01df57756203f0b61b2ba646f38c4ec5f74963dad9d934a8c5 -size 23722 +oid sha256:d6df9f84c3f64c9158858d0c1493089485e3990bcb5325e9a431160f64e20e73 +size 35163 diff --git a/admin/generation-documents.md b/admin/generation-documents.md index 02e38b8..56401a2 100644 --- a/admin/generation-documents.md +++ b/admin/generation-documents.md @@ -470,10 +470,28 @@ Seul le champ `comment` est donc disponible. * `id` (int): l'identifiant du ménage; -* `members` (liste de HouseholdMember): liste des membres du ménages; +* `current_address` (Adress) : adresse actuelle du ménage +* `current_composition` (HouseholdComposition): Composition **actuelle** du ménage +* `currentMembers` (liste de HouseholdMember): liste des membres **actuels** du ménage; +* `members` (liste de HouseholdMember): liste des membres du ménages. Cette liste inclut également les anciens membres; * `waitingForBirth` (bool): `true` si une naissance est attendue; * `waitingForBirthDate` (Date): date de la naissance attendue; +### HouseholdComposition + +La composition du ménage entre deux dates. Cette entité associe une `HouseholdCompositionType` avec une date de début et une date de fin + +* `id` (int): L'identifiant de la composition +* `startDate` (Date): date de début de validité de la composition du ménage; +* `endDate` (Date): date de fin de validité de la composition du ménage (vide si actif) +* `numberOfChildren` (int): nombre d'enfants +* `householdCompositionType` (HouseholdCompositionType): Type de composition choisie, entre deux dates + +### HouseholdCompositionType + +* `id` (int): L'identifiant du type de composition +* `label` (texte): Le libellé de la composition + ### HouseholdMember (Membre d'un ménage) * `comment` (texte): texte du commentaire;