From 2bad43593e5368b6e49b1e0e515ad96cd3bfdb5c Mon Sep 17 00:00:00 2001 From: viennet Date: Mon, 28 Nov 2022 19:13:07 +0100 Subject: [PATCH] API: formsemestre/bulletins au format long_mat. --- docs/ConseilServeurDev.md | 1 + docs/ScoDoc9API.md | 37 ++++++++++++++++++++++--------------- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/ConseilServeurDev.md b/docs/ConseilServeurDev.md index aa104e1dc..144493fd9 100644 --- a/docs/ConseilServeurDev.md +++ b/docs/ConseilServeurDev.md @@ -27,6 +27,7 @@ En général, vous préférez développer sur la machine hôte pour disposer de éditeur préféré, mais exécutez ScoDoc dans la VM. ### Éditeur de texte / IDE + Si vous êtes expérimenté, vous avez vos outils préférés. Mais si vous débutez, surtout pour un environnement de développement distant (le code développé tourne dans une machine virtuelle ou réelle séparée de votre machine de bureau), nous diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 637a33f90..807757222 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -648,8 +648,8 @@ informatique de 2014 en formation initiale (FI). * **Permission: `ScoView`** * **Paramètres:** `dept_id` * **Routes:** - * `/departement/id//formsemestres_courants` - * `/departement//formsemestres_courants` + * `/departement/id//formsemestres_courants` + * `/departement//formsemestres_courants` * **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants` * **Résultat:** Liste des formsemestres en cours d'un département donné. * **Exemple de résultat:** [departement-formsemestres-courants.json](samples/sample_departement-formsemestres-courants.json.md) @@ -660,9 +660,9 @@ informatique de 2014 en formation initiale (FI). * **Permission: `ScoView`** * **Paramètres:** aucun * **Query string:** `annee_scolaire`, `dept_acronym`, `dept_id`, `etape_apo`, `ine`, `nip` -* **Route:** `/formsemestres/query +* **Route:** `/formsemestres/query` * **Exemple d'utilisation:** `/api/formsemestres/query?etape_apo=V7HU1&annee_scolaire=2021` -* **Résultat:** Description de formsemestresg. Si plusieurs +* **Résultat:** Description de formsemestres. Si plusieurs paramètres sont donnés, c'est la conjonction (ET) des critères qui est recherchée. Si aucun formsemestre ne satisfait la requête, une liste vide est retournée. Si `ine`ou `nip`sont spécifiés, cherche les formsemestres dans @@ -674,7 +674,7 @@ informatique de 2014 en formation initiale (FI). * **Méthode:** GET * **Permission: `ScoView`** * **Paramètres:** `etudid`, `nip`, `ine` -* **Routes:** : +* **Routes:** * `/etudiant/etudid//formsemestres` ou * `/etudiant/nip//formsemestres` ou * `/etudiant/ine//formsemestres` @@ -1119,23 +1119,29 @@ d'un autre). logiciel. Voir [ConfigPermissions](ConfigPermissions.md). * **Exemple de résultat:** [permissions.json](samples/sample_permissions.json.md) -### ** API Bulletin, Evaluations, Notes** +### ** API Bulletin, Évaluations, Notes** #### **formsemestre-bulletins** * **Méthode:** GET * **Permission: `ScoView`** * **Paramètres:** `formsemestre_id` -* **Route:** `/formsemestre//bulletins +* **Route:** `/formsemestre//bulletins[/]` * **Exemple d'utilisation:** `/api/formsemestre/1/bulletins` * **Résultat:** Bulletins d'un formsemestre spécifié par son id. * **Exemple de résultat:** [formsemestre-bulletins.json](samples/sample_formsemestre-bulletins.json.md) +Pour les formations classiques (toutes sauf BUT), les bulletins JSON peut ou non +indiquer les matières. Par défaut (version `long`), il est structuré en `UEs / modules`. Si la +version est `short_mat`ou `long_mat`, il sera structuré en +`UEs / matieres / modules`. + + #### **etudiant-formsemestre-bulletin** Récapitulatif par étudiant (état, groupe(s), moyennes d'UEs et de modules pour un formsemestre spécifié par son id. -Par défaut les valeurs numériques sont formattées en chaînes. Si format=raw, valeurs numériques +Par défaut les valeurs numériques sont formatées en chaînes. Si format=raw, valeurs numériques mais pas JSON compliant à cause des `NaN`. * **Méthode:** GET @@ -1143,21 +1149,22 @@ mais pas JSON compliant à cause des `NaN`. * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Query string:** `format` * **Routes:** - `/etudiant/etudid//formsemestre//bulletin[/short][/pdf]` - ou `/etudiant/nip//formsemestre//bulletin[/short][/pdf]` - ou `/etudiant/ine//formsemestre//bulletin[/short][/pdf]` + `/etudiant/etudid//formsemestre//bulletin[/][/pdf]` + ou `/etudiant/nip//formsemestre//bulletin[/][/pdf]` + ou `/etudiant/ine//formsemestre//bulletin[/][/pdf]` * **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin` * **Résultat:** Bulletin de l'étudiant dans le formsemestre. Deux variantes possibles: - * versions `long` et `short` (`long`par défaut, ajoutez `/short` pour la version plus courte). + * versions `long` et `short` (`long` par défaut, ajoutez `/short` pour la version plus courte). * version `json` et `pdf` (`json` par défaut, ajoutez `/pdf` pour la version pdf) Pour les formations classiques (toutes sauf BUT), les bulletins JSON peut ou - non indiquer les matières. Par défaut, il est structuré en `UEs / modules`. Si - la version est `short_mat`ou `long_mat`, il sera structuré en - `UEs / matieres / modules`. + non indiquer les matières. Par défaut (version `long`), il est structuré en + `UEs / modules`. + Si la version est `short_mat`ou `long_mat`, il sera structuré en + `UEs / matieres / modules`. Les notes moyennes de matières ne sont calculées que si l'option "*Afficher les matières sur les bulletins*" est activée pour le formsemestre considéré (sinon, la note vaut toujours "*nd*"). `