commentaire des parcours

admin/generation-documents.md

@@ -208,7 +208,21 @@ ${courseStartDateShort} // 15/01/2021
 * `locationPerson` (Person): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
 * `administrativeLocation` (Location): localisation administrative du parcours;
 * `hasAdministrativeLocation` (bool): `true` si une localisation administrative est définie;
-* `works` (liste de AccompanyingPeriodWork): liste des actions d'accompagnement créées dans le cadre de ce parcours
+* `works` (liste de AccompanyingPeriodWork): liste des actions d'accompagnement créées dans le cadre de ce parcours;
+* `comments` (liste de AccompanyingPeriodComment): liste des commentaires;
+* `pinnedComment` (AccompanyingPeriodComment): commentaire épinglé;
+
+### AccompanyingPeriodComment
+
+* `id` (int): identifiant
+* `content` (texte): contenu du commentaire
+* `createdAt` (Date): date de création
+* `creator` (User): Créateur du commentaire
+
+### AccompanyingPeriodOrigin
+
+* `id` (int): identifiant;
+* `label` (texte): libellé de l'origine;
 
 
 ### AccompanyingPeriodParticipation
@@ -226,11 +240,6 @@ ${courseStartDateShort} // 15/01/2021
 * `thirdParty` (ThirdParty): tiers ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est une personne);
 
 
-### AccompanyingPeriodOrigin
-
-* `id` (int): identifiant;
-* `label` (texte): libellé de l'origine;
-
 ### Activity (échange)
 
 * `id` (int): identifiant;
@@ -312,6 +321,7 @@ Présence à l'échange
 * `memo` (texte): le mémo
 * `numberOfChildren` (texte): le nombre d'enfants
 * `address` (Adresse): l'adresse actuelle
+* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
 
 ::: { .vendee }
 
@@ -520,6 +530,28 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
 
 ::: { .vendee }
 
+### PersonResource (Ressources associée à l'usager)
+
+Pour rappel, les ressources peuvent être:
+
+* des tiers;
+* des usagers;
+* ou un champ de texte libre.
+
+
+* `comment` (Comment)
+* `freeText` (texte): commentaire, quand la personne ressources un texte libre
+* `id` (int)
+* `kind` (PersonResourceKind): le type de personne ressources (voisin, etc.)
+* `thirdParty` (ThirdParty): le tiers, quand la ressources est liée à un tiers
+* `person` (Person): l'usager, quand la ressources liée à un autre usager
+* `resourceKind` (texte): un discriminateur qui permet de vérifier si la ressources est lié à un usager (alors égal à `person`, un tiers (`thirdparty`) ou un texte libre (`freetext`). A utiliser dans les conditions dans les documents.
+
+### PersonResourceKind (Type de personne ressource)
+
+* `id` (int)
+* `title` (texte) 
+
 ### StatutLogement
 
 * `id` (int): identifiant (utile pour des comparaisons);