From 19856695a7fcd8d0ed46f857d495948db733f255 Mon Sep 17 00:00:00 2001 From: viennet Date: Fri, 13 May 2022 12:20:13 -0400 Subject: [PATCH] API: wip --- docs/ScoDoc9API.md | 80 ++++++---------------------------------------- 1 file changed, 9 insertions(+), 71 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index ab39557..5c5bf1e 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1223,54 +1223,16 @@ d'un nombre quelconque de groupes d'étudiants. ] ``` - * **`etud_in_group`** + * **`/partitions/groups/`** * **Méthode: GET** * **Paramètres:** `group_id`, `etat` * **Routes:** `/partitions/groups/` ou `/partitions/groups//etat/` * **Exemple d'utilisation:** `/ScoDoc/api/partitions/groups/1` - * **Résultat:** La liste de toutes les partitions d'un formsemestre. + * **Résultat:** XXX à préciser * **Exemple de résultat:** - ``` - [ - { - "etudid": 10, - "id": 10, - "dept_id": 1, - "nom": "BOUTET", - "prenom": "Marguerite", - "nom_usuel": "", - "civilite": "F", - "date_naissance": null, - "lieu_naissance": null, - "dept_naissance": null, - "nationalite": null, - "statut": null, - "boursier": null, - "photo_filename": null, - "code_nip": "10", - "code_ine": "10", - "scodoc7_id": null, - "email": "MARGUERITE.BOUTET@example.com", - "emailperso": null, - "domicile": null, - "codepostaldomicile": null, - "villedomicile": null, - "paysdomicile": null, - "telephone": null, - "telephonemobile": null, - "fax": null, - "typeadresse": "domicile", - "description": null, - "group_id": 1, - "etat": "I", - "civilite_str": "Mme", - "nom_disp": "BOUTET", - "nomprenom": "Mme Marguerite BOUTET", - "ne": "e", - "email_default": "MARGUERITE.BOUTET@example.com" - } - ] - ``` + ``` + + ``` * **`set_groups`** **NON IMPLEMENTE** @@ -1281,13 +1243,14 @@ d'un nombre quelconque de groupes d'étudiants. * **Résultat:** Set les groups. -### Résultats des évaluations +### Évaluations * **`evaluations`** * **Méthode:** GET * **Paramètres:** `moduleimpl_id` * **Routes:** `/evaluations/` * **Exemple d'utilisation:** `/ScoDoc/api/evaluations/1` - * **Résultat:** Retourne la liste des évaluations à partir de l'id d'un moduleimpl + * **Résultat:** Retourne la liste des évaluations à partir de l'id d'un + moduleimpl (quel que soit leur statut). * **Exemple de résultat:** ``` [ @@ -1320,28 +1283,7 @@ d'un nombre quelconque de groupes d'étudiants. * **Exemple d'utilisation:** `/ScoDoc/api/evaluations/eval_notes/1` * **Résultat:** Retourne la liste des notes à partir de l'id d'une évaluation donnée * **Exemple de résultat:** - ``` - { - "1": { - "id": 1, - "etudid": 10, - "evaluation_id": 1, - "value": 15, - "comment": "", - "date": "Wed, 20 Apr 2022 06:49:05 GMT", - "uid": 2 - }, - "2": { - "id": 2, - "etudid": 1, - "evaluation_id": 1, - "value": 12, - "comment": "", - "date": "Wed, 20 Apr 2022 06:49:06 GMT", - "uid": 2 - } - } - ``` + XXX à revoir (à spécifier) ### Absences @@ -1358,7 +1300,6 @@ d'un nombre quelconque de groupes d'étudiants. ``` [ { - "jour": "2022-04-15", "matin": true, "estabs": true, "estjust": true, @@ -1367,7 +1308,6 @@ d'un nombre quelconque de groupes d'étudiants. "end": "2022-04-15 11:59:59" }, { - "jour": "2022-04-15", "matin": false, "estabs": true, "estjust": false, @@ -1388,7 +1328,6 @@ d'un nombre quelconque de groupes d'étudiants. ``` [ { - "jour": "2022-04-15", "matin": true, "estabs": true, "estjust": true, @@ -1397,7 +1336,6 @@ d'un nombre quelconque de groupes d'étudiants. "end": "2022-04-15 11:59:59" }, { - "jour": "2022-04-15", "matin": false, "estabs": true, "estjust": true,