Merge pull request 'description modif formsemestre-etudiant' (#46) from jmplace/DocScoDoc:fix_2022-08-30 into master

Reviewed-on: https://scodoc.org/git/viennet/DocScoDoc/pulls/46

docs/ScoDoc9API.md

@@ -365,7 +365,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 #### Structure Etudiant
 
 | attribut         | type                | commentaire                      |
-|:-----------------|:----------|:---------------------------------|
+|:-----------------|:--------------------|:---------------------------------|
 | _id_             | int                 | id unique                        |
 | _code_nip_       | string              | non unique!                      |
 | _code_ine_       | string              | non unique!                      |
@@ -374,6 +374,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 | _nom_            | string              | en majuscule                     |
 | _nom_usuel_      | string              | null si absent                   |
 | _prenom_         | string              |                                  |
+| _sort_key_       | [ string, string ]  | nom-prenom pour trier            |
 |                  |                     | **Format long**                  |                   
 | _date_naissance_ | string              | date ISO                         |
 | _email_          | string              |                                  |
@@ -436,7 +437,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
   Attention, la liste peut être longue: requête coûteuse à éviter.
 * **Exemple de résultat:** [departement-etudiants.json](samples/sample_departement-etudiants.json.md)
 
-#### **`formsemestre-etudiants[-query]`**
+#### **`formsemestre-etudiants[-long][-query]`**
 * **Méthode:** GET
 * **Permission: `ScoView`**
 * **Paramètres:** `formsemestre_id`
@@ -444,12 +445,15 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
 * **Routes:**
   * `/formsemestre/<int:formsemestre_id>/etudiants`
   * `/formsemestre/<int:formsemestre_id>/etudiants/query?etat=I,D,DEF`
+  * `/formsemestre/<int:formsemestre_id>/etudiants/long`
+  * `/formsemestre/<int:formsemestre_id>/etudiants/long/query?etat=I,D,DEF`
 * **Exemple d'utilisation:**
-    * `/api/formsemestre/1/etudiants`
+    * `/api/formsemestre/1/etudiants/long`
     * `/api/formsemestre/1/etudiants/query?etat=D`
-* **Résultat:** Etudiants d'un formsemestre spécifié par son id. La liste est
+* **Résultat:** Etudiants d'un formsemestre spécifié par son id.
-  restreinte aux étudiants inscrits (`I`), démissionnaires (`D`) ou défaillants
+    Une clé (`sort_key`) reproduit [ nom, prenom ] sous forme ASCII, permettant le tri des étudiants.
-  (`DEF`) si l'état est indiqué.
+    Avec `query`, La liste est restreinte aux étudiants inscrits (`I`), démissionnaires (`D`) ou défaillants  (`DEF`) si l'état est indiqué.
+    Avec `long`, ajoute la date de naissance entre autre
 * **Exemple de résultat:**
     * [formsemestre-etudiants.json](samples/sample_formsemestre-etudiants.json.md)
     * [formsemestre-etudiants-query.json](samples/sample_formsemestre-etudiants-query.json.md)

docs/samples/sample_formsemestre-etudiants.json.md

@@ -3,6 +3,21 @@
 #### GET /formsemestre/1/etudiants
 ```json
 [
+    {
+        "civilite": "F",
+        "code_ine": "10",
+        "code_nip": "NIP10",
+        "dept_id": 1,
+        "groups": [],
+        "id": 10,
+        "nom": "BOUTET",
+        "nom_usuel": null,
+        "prenom": "MARGUERITE",
+        "sort_key": [
+            "boutet",
+            "marguerite"
+        ]
+    },
     {
         "civilite": "X",
         "code_ine": "INE1",
@@ -12,18 +27,154 @@
         "id": 1,
         "nom": "COSTA",
         "nom_usuel": null,
-        "prenom": "SACHA"
+        "prenom": "SACHA",
-    },
+        "sort_key": [
-    {
+            "costa",
-        "civilite": "F",
+            "sacha"
-        "code_ine": "2",
+        ]
-        "code_nip": "NIP2",
+    },
-        "dept_id": 1,
+    "..."
-        "groups": [],
+]
-        "id": 2,
+```
-        "nom": "NAUDIN",
+
-        "nom_usuel": null,
+#### GET /formsemestre/1/etudiants/long
-        "prenom": "SIMONE"
+```json
+[
+    {
+        "admission": {
+            "anglais": null,
+            "annee": null,
+            "annee_bac": null,
+            "apb_classement_gr": null,
+            "apb_groupe": null,
+            "bac": null,
+            "boursier_prec": null,
+            "classement": null,
+            "codelycee": null,
+            "codepostallycee": null,
+            "commentaire": null,
+            "decision": null,
+            "etudid": 10,
+            "francais": null,
+            "id": 10,
+            "math": null,
+            "nomlycee": null,
+            "physique": null,
+            "qualite": null,
+            "rang": null,
+            "rapporteur": null,
+            "score": null,
+            "specialite": null,
+            "type_admission": null,
+            "villelycee": null
+        },
+        "adresses": [
+            {
+                "codepostaldomicile": null,
+                "description": null,
+                "domicile": null,
+                "email": "MARGUERITE.BOUTET@example.com",
+                "emailperso": null,
+                "etudid": 10,
+                "fax": null,
+                "id": 10,
+                "paysdomicile": null,
+                "telephone": null,
+                "telephonemobile": null,
+                "typeadresse": "domicile",
+                "villedomicile": null
+            }
+        ],
+        "boursier": null,
+        "civilite": "F",
+        "code_ine": "10",
+        "code_nip": "NIP10",
+        "date_naissance": null,
+        "dept_acronym": "TAPI",
+        "dept_id": 1,
+        "dept_naissance": null,
+        "groups": [],
+        "id": 10,
+        "lieu_naissance": null,
+        "nationalite": null,
+        "nom": "BOUTET",
+        "nom_usuel": null,
+        "photo_filename": null,
+        "prenom": "MARGUERITE",
+        "scodoc7_id": null,
+        "sort_key": [
+            "boutet",
+            "marguerite"
+        ],
+        "statut": null
+    },
+    {
+        "admission": {
+            "anglais": null,
+            "annee": null,
+            "annee_bac": null,
+            "apb_classement_gr": null,
+            "apb_groupe": null,
+            "bac": null,
+            "boursier_prec": null,
+            "classement": null,
+            "codelycee": null,
+            "codepostallycee": null,
+            "commentaire": null,
+            "decision": null,
+            "etudid": 1,
+            "francais": null,
+            "id": 1,
+            "math": null,
+            "nomlycee": null,
+            "physique": null,
+            "qualite": null,
+            "rang": null,
+            "rapporteur": null,
+            "score": null,
+            "specialite": null,
+            "type_admission": null,
+            "villelycee": null
+        },
+        "adresses": [
+            {
+                "codepostaldomicile": null,
+                "description": null,
+                "domicile": null,
+                "email": "SACHA.COSTA@example.com",
+                "emailperso": null,
+                "etudid": 1,
+                "fax": null,
+                "id": 1,
+                "paysdomicile": null,
+                "telephone": null,
+                "telephonemobile": null,
+                "typeadresse": "domicile",
+                "villedomicile": null
+            }
+        ],
+        "boursier": null,
+        "civilite": "X",
+        "code_ine": "INE1",
+        "code_nip": "1",
+        "date_naissance": null,
+        "dept_acronym": "TAPI",
+        "dept_id": 1,
+        "dept_naissance": null,
+        "groups": [],
+        "id": 1,
+        "lieu_naissance": null,
+        "nationalite": null,
+        "nom": "COSTA",
+        "nom_usuel": null,
+        "photo_filename": null,
+        "prenom": "SACHA",
+        "scodoc7_id": null,
+        "sort_key": [
+            "costa",
+            "sacha"
+        ],
+        "statut": null
     },
     "..."
 ]