From 63e33c5a7be2cb14c4e8429549c4c024782f542b Mon Sep 17 00:00:00 2001 From: leonard_montalbano Date: Tue, 24 May 2022 12:10:55 +0200 Subject: [PATCH] =?UTF-8?q?mise=20=C3=A0=20jour=20de=20la=20doc=20api=20au?= =?UTF-8?q?=2024/05/2022?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/ScoDoc9API.md | 58 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 45 insertions(+), 13 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 8a4c3ae8..f220252f 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -316,7 +316,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le * **`etudiant`** * **Méthode:** GET * **Paramètres:** `etudid`, `nip`, `ine` - * **Routes:** `/etudiant/etudid/` ou `/etudiant/nip/` ou `/etudiant/ine/` + * **Routes:** `/etudiant/etudid/` ou `/etudiant/nip/` ou `/etudiant/ine/` * **Exemple d'utilisation:** `/api/etudiant/nip/1` * **Résultat:** Retourne les informations de l'étudiant correspondant à l'id passé en paramètres. (json) * **Exemple de résultat:** @@ -355,7 +355,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le * **`etudiant_formsemestres`** * **Méthode:** GET * **Paramètres:** `etudid`, `nip`, `ine` - * **Routes:** : `/etudiant/etudid//formsemestres` ou `/etudiant/nip//formsemestres` ou `/etudiant/ine//formsemestres` + * **Routes:** : `/etudiant/etudid//formsemestres` ou `/etudiant/nip//formsemestres` ou `/etudiant/ine//formsemestres` * **Exemple d'utilisation:** `/etudiant/ine/1/formsemestres` * **Résultat:** Retourne la liste des semestres qu'un étudiant a suivis, triés par ordre chronologique. (json) * **Exemple de résultat:** @@ -402,10 +402,21 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Routes:** `/etudiant/etudid//formsemestre//bulletin` - ou `/etudiant/nip//formsemestre//bulletin` - ou `/etudiant/ine//formsemestre//bulletin` + ou `/etudiant/nip//formsemestre//bulletin` + ou `/etudiant/ine//formsemestre//bulletin` + ou `/etudiant/etudid//formsemestre//bulletin/pdf` + ou `/etudiant/nip//formsemestre//bulletin/pdf` + ou `/etudiant/ine//formsemestre//bulletin/pdf` + ou `/etudiant/etudid//formsemestre//bulletin/short` + ou `/etudiant/nip//formsemestre//bulletin/short` + ou `/etudiant/ine//formsemestre//bulletin/short` + ou `/etudiant/etudid//formsemestre//bulletin/short/pdf` + ou `/etudiant/nip//formsemestre//bulletin/short/pdf` + ou `/etudiant/ine//formsemestre//bulletin/short/pdf` * **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin` - * **Résultat:** Bulletin de l'étudiant dans le formsemestre. + * **Résultat:** Bulletin de l'étudiant dans le formsemestre. + Deux versions disponibles `long` et `short` (par défaut long ajoutez **/short** pour la version plus courte). + Possible de récupérer le pdf en version pdf avec **/pdf** XXX ATTENTION PAS ENCORE DISPONIBLE XXX * **Exemple de résultat:** ``` { @@ -582,7 +593,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le * **`etudiant_groups`** * **Méthode:** GET * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` - * **Routes:** `/etudiant/etudid//semestre//groups` ou `/etudiant/nip//semestre//groups` ou `/etudiant/ine//semestre//groups` + * **Routes:** `/etudiant/etudid//semestre//groups` ou `/etudiant/nip//semestre//groups` ou `/etudiant/ine//semestre//groups` * **Exemple d'utilisation:** `/etudiant/nip/1/semestre/1/groups` * **Résultat:** Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json) * **Exemple de résultat:** @@ -1341,9 +1352,9 @@ d'un nombre quelconque de groupes d'étudiants. * **`absences`** * **Méthode:** GET - * **Paramètres:** `etudid`, `nip`, `ine` - * **Routes:** `/absences/etudid/` ou `/absences/nip/` ou `/absences/ine/` - * **Exemple d'utilisation:** `/ScoDoc/api/absences/ine/1` + * **Paramètres:** `etudid` + * **Routes:** `/absences/etudid/` + * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1` * **Résultat:** Retourne la liste des absences d'un étudiant donné * **Exemple de résultat:** ``` @@ -1371,9 +1382,9 @@ d'un nombre quelconque de groupes d'étudiants. * **`absences_just`** * **Méthode:** GET - * **Paramètres:** `etudid`, `nip`, `ine` - * **Routes:** `/absences/etudid//just` ou `/absences/nip//just` ou `/absences/ine//just` - * **Exemple d'utilisation:** `/ScoDoc/api/absences/ine/1/just` + * **Paramètres:** `etudid` + * **Routes:** `/absences/etudid//just` + * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1/just` * **Résultat:** Retourne la liste des absences justifiées d'un étudiant donné * **Exemple de résultat:** ``` @@ -1400,7 +1411,7 @@ d'un nombre quelconque de groupes d'étudiants. ``` - * **`abs_groupe_etat`** + * **`abs_groupe_etat`** **NON IMPLEMENTE** * **Méthode:** GET * **Paramètres:** `group_id`, `date_debut`, `date_fin` (dates au format ISO) * **Routes:** `/absences/abs_group_etat/` ou `/absences/abs_group_etat/group_id//date_debut//date_fin/` @@ -1440,6 +1451,27 @@ d'un nombre quelconque de groupes d'étudiants. ] ``` + * **`reset_etud_abs`** **NON IMPLEMENTE** + * **Méthode:** POST + * **Paramètres:** `etudid`, `list_abs` + * **Routes:** `/absences/etudid//list_abs//reset_etud_abs` ou `/absences/etudid//list_abs//reset_etud_abs/only_not_just` ou `/absences/etudid//list_abs//reset_etud_abs/only_just` + * **Exemple {LIST_ABS} json:** + ``` + [ + { + "matin": true, + "estabs": true, + "estjust": true, + "description": "", + "begin": "2022-04-15 08:00:00", + "end": "2022-04-15 11:59:59" + }, + ... + ] + ``` + * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1/list_abs/{LIST_ABS}reset_etud_abs` + * **Résultat:** Set la liste des absences d'un étudiant sur tout un semestre. (les absences existant pour cet étudiant sur cette période sont effacées) + ### Jury