From 003158e9b59bec6ca5c7aad852162c79d5cced9e Mon Sep 17 00:00:00 2001 From: viennet Date: Fri, 13 May 2022 11:24:58 -0400 Subject: [PATCH] =?UTF-8?q?API:=20pr=C3=A9sentation=20des=20routes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/ScoDoc9API.md | 43 +++++++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 14 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 440d2ed5..c69eaa5a 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -318,7 +318,10 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le * **Paramètres:** `etudid`, `nip`, `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) + * **Résultat:** Retourne les informations sur l'étudiant correspondant à + l'id passé en paramètres. + Les codes INE et NIP sont uniques au sein d'un département. + Si plusieurs objets étudiant ont le même code, on ramène le plus récemment inscrit. * **Exemple de résultat:** ``` { @@ -348,7 +351,19 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le "description": "" } ``` +* **`etudiants`** + * **Méthode:** GET + * **Paramètres:** `etudid`, `nip`, `ine` + * **Routes:** `/etudiants/etudid/` ou `/etudiants/nip/` ou `/etudiants/ine/` + * **Exemple d'utilisation:** `/api/etudiants/nip/1` + * **Résultat:** Info sur le ou les étudiants correspondant. + Comme `/etudiant` mais renvoie toujours une liste. + Si non trouvé, liste vide, pas d'erreur. + Dans 99% des cas, la liste contient un seul étudiant, mais si l'étudiant a + été inscrit dans plusieurs départements, on a plusieurs objets (1 par + dept.). + #### Cursus * **`etudiant_formsemestres`** * **Méthode:** GET @@ -617,7 +632,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le ## Programmes de formations * **`formations_ids`** * **Méthode:** GET - * **Routes:** `/ScoDoc/api/formations_ids` + * **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]` @@ -1065,7 +1080,7 @@ informations suivantes: * **Méthode:** GET * **Paramètres:** `dept`, `formsemestre_id` * **Routes:** `/formsemestre//programme` - * **Exemple d'utilisation:** `api/formsemestre/1/programme` + * **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/programme` * **Résultat:** Retourne la liste des UEs, modules, ressources et SAE d'un semestre. * **Exemple de résultat:** ``` @@ -1181,7 +1196,7 @@ d'un nombre quelconque de groupes d'étudiants. * **`partition`** * **Méthode: GET** * **Paramètres:** `formsemestre_id` - * **Routes:** `/ScoDoc/api/partitions/` + * **Routes:** `/partitions/` * **Exemple d'utilisation:** `/ScoDoc/api/partition/48` * **Résultat:** La liste de toutes les partitions d'un formsemestre. * **Exemple de résultat:** @@ -1338,8 +1353,8 @@ 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` + * **Routes:** `/absences/etudid/` + * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/123456` * **Résultat:** Retourne la liste des absences d'un étudiant donné * **Exemple de résultat:** ``` @@ -1367,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:** ``` @@ -1437,7 +1452,7 @@ d'un nombre quelconque de groupes d'étudiants. * **`liste des logos globaux`** * **Méthode:** GET * **Paramètres:** `format` (json, xml), json par défaut - * **Route :** `/ScoDoc/api/logos` + * **Route :** `/logos` * **Exemple d'utilisation :** `/ScoDoc/api/logos?format=xml` * **Résultat :** Liste des logos définis pour le site scodoc. * **Exemple de résultat:** `['header', 'footer', 'custom']` @@ -1446,7 +1461,7 @@ d'un nombre quelconque de groupes d'étudiants. * **`récupération d'un logo global`** * **Méthode:** GET * **Paramètres :** Aucun - * **Route:** `/ScoDoc/api/logos/` + * **Route:** `/logos/` * **Exemple d'utilisation :** `/ScoDoc/api/logos/header` * **Résultat :** l'image (format png ou jpg) @@ -1454,8 +1469,8 @@ d'un nombre quelconque de groupes d'étudiants. * **`logo d'un département`** * **Méthode:** GET * **Paramètres:** `format` (json, xml) - * **Route :** `/ScoDoc/api/departements//logos` - * **Exemple d'utilisation :** `/ScoDoc/api/MMI/logos` + * **Route :** `/departements//logos` + * **Exemple d'utilisation :** `/ScoDoc/api/departements/MMI/logos` * **Résultat :** Liste des logos définis pour le département visé. * **Exemple de résultat:** `['footer', 'signature', 'universite']` @@ -1463,7 +1478,7 @@ d'un nombre quelconque de groupes d'étudiants. * **`récupération d'un logo global`** * **Méthode:** GET * **Paramètres :** Aucun - * **Route:** `/ScoDoc/api/departements//logos/` + * **Route:** `/departements//logos/` * **Exemple d'utilisation:** `/ScoDoc/api/departements/MMI/logos/header` * **Résultat :** l'image (format png ou jpg)