From 4a95cae4e9183b805de455b7e465b8fbb2350c80 Mon Sep 17 00:00:00 2001 From: nobohan Date: Fri, 18 Mar 2022 07:49:06 +0100 Subject: [PATCH] update doc admin docgen" --- admin/generation-documents.md | 50 ++++++++++++++++++++++++----------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/admin/generation-documents.md b/admin/generation-documents.md index 8ecf6ca..b755696 100644 --- a/admin/generation-documents.md +++ b/admin/generation-documents.md @@ -57,8 +57,8 @@ Les dates sont disponibles dans deux formats: lorsqu'une date est disponible, il est donc possible d'avoir accès à son format en précisant sa chaine de caractère. Exemple avec la date de naissance de la personne: ``` -personBirthdateShort=15/06/1980 -personBirthdateLong=15 juin 1980 +person.Birthdate.Short=15/06/1980 +person.Birthdate.Long=15 juin 1980 ``` @@ -230,7 +230,7 @@ ${courseStartDateShort} // 15/01/2021 * `location` (Location): Lieu de l'échange * `reasons` (liste de ActivityReason): Sujets de l'échange (pas utilisé en Vendée) * `scope` (Scope): Service (pas utilisé en Vendée) -* `sentReceived (text): sera `received` si reçu, et `sent` si envoyé; +* `sentReceived` (text): sera `received` si reçu, et `sent` si envoyé; * `socialActions` (liste de SocialAction): liste d'actions sociales associées * `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées * `thirdParties` (liste de ThirdParty): liste de tiers associés @@ -238,7 +238,7 @@ ${courseStartDateShort} // 15/01/2021 * `user` (User): l'utilisateur pour lequel l'échange a été créé; * `users` (liste de Users): les utilisateurs qui sont associés à l'échange. -### ActivityPrésence +### ActivityPresence Présence à l'échange @@ -290,22 +290,22 @@ Présence à l'échange * `gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage * `titreDeSejour` (TitreDeSejour): entité TitreDeSejour * `titreDeSejourComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `situationProfessionelle` (situationProfessionelle): entité situationProfessionelle +* `situationProfessionelle` (SituationProfessionelle): entité SituationProfessionelle * `aidantFamilial` (bool): `true` si la personne fait partie des gens du voyage -* `tempsDeTravail` (tempsDeTravail): entité tempsDeTravail +* `tempsDeTravail` (TempsDeTravail): entité TempsDeTravail * `situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `situationProfessionelleStartDate` (Date) -* `niveauEtude` (niveauEtude): entité niveauEtude -* `mobilite` (mobilite): entité mobilite +* `niveauEtude` (NiveauEtude): entité NiveauEtude +* `mobilite` (mMbilite): entité Mobilite * `permisDeConduire` (bool): `true` si la personne a un permis de conduire * `moyenDeTransport` (bool): `true` si la personne a un moyen de transport * `infoSocioProComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `entourage` (entourage): entité entourage +* `entourage` (Entourage): entité Entourage * `entourageComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `numeroSecuriteSociale` (texte) * `caisseSecuriteSociale` (texte) * `pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant -* `medecinTraitant` (tiers): entité tiers +* `medecinTraitant` (Tiers): entité ThirdParty * `medecinTraitantTexteLibre` (texte) * `mdph` (texte) * `mdphStartDate` (Date) @@ -332,10 +332,11 @@ Présence à l'échange * `girEndDate` (Date) * `girComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `infoMedicaleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `statutLogement` (statutLogement): entité statutLogement +* `statutLogement` (StatutLogement): entité StatutLogement * `statutLogementComment` (Comment): Commentaire (avec la date de la dernière mise à jour) * `caisseDeRetraitePrincipale` (texte) * `caisseDeRetraiteComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `caissesDeRetraiteComplementaires` (texte): Caisses de retraite complémentaires, séparées par des virgules En outre, si la personne est mineure, on a accès aux champs suivants: @@ -353,17 +354,17 @@ En outre, si la personne est mineure, on a accès aux champs suivants: * `delegation` (bool): `true` si délégation * `delegationDate` (Date) * `delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `delegationThirdParty` (tiers): entité tiers -* `delegationPerson` (person): entité person +* `delegationThirdParty` (tiers): entité ThirdParty +* `delegationPerson` (person): entité Person * `tuteur` (texte) -* `tuteurThirdParty` (tiers): entité tiers +* `tuteurThirdParty` (tiers): entité ThirdParty * `administrateurAdhoc` (bool): `true` si administrateurAdhoc * `administrateurAdhocDate` (Date) * `administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour) * `pupilleEtat` (bool): `true` si pupilleEtat * `pupilleEtatDate` (Date) * `pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `tuteurPerson` (person): entité person +* `tuteurPerson` (person): entité Person * `enfantEmancipe` (bool): `true` si enfantEmancipe * `enfantEmancipeDate` (Date) * `gardeAlternee` (texte) @@ -396,6 +397,7 @@ En outre, si la personne est mineure, on a accès aux champs suivants: * `notificationMDPHStartDate` (Date) * `notificationMDPHEndDate` (Date) * `dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `adresseDeRelais` (adresse): liste d'adresses ::: #### variant `household` @@ -422,6 +424,16 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89 * `id` (int): identifiant (utile pour des comparaisons); * `name` (texte): titre, label de la civilité; +::: { .vendee } +### Entourage + +* `person` (person): entité Person +* `thirdParty` (tiers): entité ThirdParty +* `text` (texte) +* `comment` (comment): Commentaire (avec la date de la dernire mise à jour) +* `aidantProche` (bool): `true` si aidantProche + +::: ### Household @@ -446,6 +458,14 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89 * `id` (int): identifiant de la position; * `label` (texte): label de la position dans le ménage; + +::: { .vendee } +### Mobilite, NiveauEtude, SituationProfessionelle, StatutLogement, TempsDeTravail, TitreDeSejour + +* `active` (bool): `true` si active +* `name` (texte) +::: + ### ThirdParty * `id` (int): identifiant du tiers;