From e32095e114b78c9b1af72874663dd755c321cff7 Mon Sep 17 00:00:00 2001 From: viennet Date: Sun, 24 Jul 2022 10:25:14 +0300 Subject: [PATCH] API: WIP --- docs/ScoDoc9API.md | 41 +++++++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 9f5adadc7..2477a9571 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -457,7 +457,9 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le bulletin PDF. * **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin` * **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). + Deux versions disponibles `long` et `short` (par défaut `long` ajoutez + `/short` pour la version plus courte). + * **Exemple de résultat:** ``` { @@ -669,20 +671,13 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le ## Programmes de formations - * **`formations_ids`** - * **Méthode:** GET - * **Routes:** `/formations_ids` - * **Exemple d'utilisation:** `/ScoDoc/api/formations_ids` - * **Résultat:** Retourne la liste des ids de toutes les formations (tous départements) - * **Exemple de résultat:** `[17, 99, 32]` - * **`formation`** * **Méthode:** GET * **Paramètres:** `formation_id` * **Routes:** `/formation/` * **Exemple d'utilisation:** `/ScoDoc/api/formation/1` - * **Résultat:** Retourne la formationd'id donné + * **Résultat:** Retourne la formation d'id donné * **Exemple de résultat:** ``` { @@ -699,6 +694,21 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le "formation_id": 1 } ``` + + * **`formations_ids`** + * **Méthode:** GET + * **Routes:** `/formations_ids` + * **Exemple d'utilisation:** `/ScoDoc/api/formations_ids` + * **Résultat:** Retourne la liste des ids de toutes les formations (tous départements) + * **Exemple de résultat:** `[17, 99, 32]` + + * **`formations`** + * **Méthode:** GET + * **Routes:** `/formations` + * **Exemple d'utilisation:** `/ScoDoc/api/formations` + * **Résultat:** Retourne la liste de toutes les formations (tous + départements) + #### Export programme * **`formation_export`** * **Méthode:** GET @@ -710,7 +720,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le ``` { "id": 1, - "acronyme": "BUT R&T", + "acronyme": "BUT R&T", "titre_officiel": "Bachelor technologique réseaux et télécommunications", "formation_code": "V1RET", "code_specialite": null, @@ -794,7 +804,9 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le ] } ``` + #### Référentiel de compétences + * **`referentiel_competences`** * **Méthode:** GET * **Paramètres:** `formation_id` @@ -805,6 +817,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le ## Formsemestres + Les sessions de formation (qu'elles durent une année ou un mois) sont représentées par les `formsemestre`. * **`formsemestre`** @@ -1333,14 +1346,6 @@ d'un nombre quelconque de groupes d'étudiants. } ] ``` - - - * **`set_groups`** **NON IMPLEMENTE** - * **Méthode:** POST - * **Paramètres:** `partition_id`, `groups_lists`, `groups_to_delete`, `groups_to_create` - * **Routes:** `/partitions/set_groups/partition//groups//delete//create/` - * **Exemple d'utilisation:** `/ScoDoc/api/partitions/set_groups/partition/1/groups/"A COMPLETER"/delete/"A COMPLETER"/create/"A COMPLETER"` - * **Résultat:** Set les groups. ### Évaluations