From 007987db8805daac5a992542c2c2ab100b201253 Mon Sep 17 00:00:00 2001
From: Iziram <hartmann.matthias@iziram.fr>
Date: Tue, 11 Jul 2023 21:36:36 +0200
Subject: [PATCH] Assiduites : Correction doc api

---
 docs/ScoDoc9API.md | 51 +++++++++++++++++++++++++++++++++++-----------
 1 file changed, 39 insertions(+), 12 deletions(-)

diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md
index 281a830..b5cec15 100644
--- a/docs/ScoDoc9API.md
+++ b/docs/ScoDoc9API.md
@@ -1437,6 +1437,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
 | *date_fin*      | string         | date ISO de la fin de la période d'assiduité                     |
 | *etat*          | string         | état de l'assiduité (present, absent, retard)                    |
 | *desc*          | string ou null | description de l'assiduité                                       |
+| *user_id*       | int ou null    | utilisateur ayant créé l'assiduité                               |
+| *est_just*      | boolean        | l'assiduité est-elle justifiée                                   |
 | *entry_date*    | string         | la date d'entrée de l'assiduité                                  |
 
 > Rappel du format de date ISO : yyyy-mm-jjTHH:MM:SS
@@ -1463,6 +1465,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
   * `date_debut` (X : date format iso)
   * `date_fin` (X : date format iso)
   * `formsemestre_id` (X : id du formsemestre)
+  * `est_just` (v,t,f,vrai,faux,true,false)
+  * `user_id` (X : id de l'utilisateur)
 * **Routes:**
   * `/assiduites/<int:etudid>`
   * `/assiduites/<int:etudid>/query?`
@@ -1484,6 +1488,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
   * `date_debut` (X : date format iso)
   * `date_fin` (X : date format iso)
   * `formsemestre_id` (X : id du formsemestre)
+  * `est_just` (v,t,f,vrai,faux,true,false)
+  * `user_id` (X : id de l'utilisateur)
   * `metric` ('compte', 'demi', 'journee', 'heure')
 * **Routes:**
   * `/assiduites/<int:etudid>/count`
@@ -1506,6 +1512,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
   * `moduleimpl_id` (X : id du moduleimpl concerné)
   * `date_debut` (X : date format iso)
   * `date_fin` (X : date format iso)
+  * `est_just` (v,t,f,vrai,faux,true,false)
+  * `user_id` (X : id de l'utilisateur)
 * **Routes:**
   * `/assiduites/formsemestre/<int:formsemestre_id>`
   * `/assiduites/formsemestre/<int:formsemestre_id>/query?`
@@ -1526,6 +1534,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
   * `moduleimpl_id` (X : id du moduleimpl concerné)
   * `date_debut` (X : date format iso)
   * `date_fin` (X : date format iso)
+  * `est_just` (v,t,f,vrai,faux,true,false)
+  * `user_id` (X : id de l'utilisateur)
 * **Routes:**
   * `/assiduites/formsemestre/<int:formsemestre_id>/count`
   * `/assiduites/formsemestre/<int:formsemestre_id>/count/query?`
@@ -1546,12 +1556,14 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
   * `moduleimpl_id` (X : id du moduleimpl concerné)
   * `date_debut` (X : date format iso)
   * `date_fin` (X : date format iso)
+  * `est_just` (v,t,f,vrai,faux,true,false)
+  * `user_id` (X : id de l'utilisateur)
 * **Routes:**
-  * `/assiduites/group/query?group=`
+  * `/assiduites/group/query?etudids=`
 * **Exemple d'utilisation:**
-  * `/assiduites/group/query?group=1,2,3`
-  * `/assiduites/group/query?group=1,2,3&etat=retard`
-  * `/assiduites/group/query?group=1,2,3&moduleimpl=1`
+  * `/assiduites/group/query?etudids=1,2,3`
+  * `/assiduites/group/query?etudids=1,2,3&etat=retard`
+  * `/assiduites/group/query?etudids=1,2,3&moduleimpl=1`
 * **Résultat:**
   ```json
   {
@@ -1569,13 +1581,14 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
 
 ```json
 [
-  {
+  { 
+    "etudid":<int>,
+
     "date_debut": <string>,
     "date_fin": <string>,
     "etat": <string>,
-    "etudid":<int>
-    "moduleimpl_id"?: <int>
-    "desc"?:<string>
+    "moduleimpl_id"?: <int>,
+    "desc"?:<string>,
   },
   ...
 ]
@@ -1603,7 +1616,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
     "date_debut": <string>,
     "date_fin": <string>,
     "etat": <string>,
-    "moduleimpl_id"?: <int>
+    "moduleimpl_id"?: <int>,
     "desc"?:<string>
   },
   ...
@@ -1630,7 +1643,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
 {
     "etat": <string>,
     "moduleimpl_id": <int>,
-    "desc" : <string>
+    "desc" : <string>,
 }
 ```
 
@@ -1864,11 +1877,25 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
 #### **justificatif-list**
 
 * **Méthode:** GET
-* **Permission: `ScoView`**
+* **Permission: `ScoView` / `ScoJustifView`**
+  * Si `ScoView` : retourne uniquement les fichiers fourni par le même utilisateur
+  * Si `ScoJustifView` : retourne tous les fichiers
 * **Paramètres:** `justif_id`
 * **Routes:** `/justificatif/<int:justif_id>/list`
 * **Exemple d'utilisation:** `/api/justificatif/1/list`
-* **Résultat:** Retourne la liste des fichiers archivés une erreur si l'id n'est pas connu
+* **Résultat:** 
+  ```json
+    {
+      "filenames" : [
+        <str>,
+        ...
+      ],
+
+      "total": <int>
+    }
+  ```
+  * Le total indique le nombre total de fichiers (visibles ou non)
+
 * **Exemple de résultat:**  [justificatif-list.json](samples/sample_justificatif_list.json.md)
 
 #### **justificatif-justifies**