ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

corrections d'erreurs + ajout de la doc pour la route '/formsemestre/<int:formsemestre_id>/etudiants'

Browse Source
This commit is contained in:
leonard_montalbano 2022-05-13 15:55:56 +02:00
parent 1c83ced1d8
commit 905dc4de95
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/ScoDoc9API.md
View File

@ -326,6 +326,8 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
"code_ine": "1", "code_ine": "1",
"code_nip": "1", "code_nip": "1",
"date_naissance": "", "date_naissance": "",
"dept_id": 1,
"dept_acronym": "TAPI",
"email": "SACHA.COSTA@example.com", "email": "SACHA.COSTA@example.com",
"emailperso": "", "emailperso": "",
"etudid": 1, "etudid": 1,
@ -862,7 +864,9 @@ informations suivantes:
#### Étudiants inscrits #### Étudiants inscrits
* **etudiants** * **etudiants**
* **Méthode:** GET * **Méthode:** GET
* **Routes:** `/formsemestre/<int:formsemestre_id>/etudiants` * **Paramètres:** `formsemestre_id`, `etat` (par défaut égal à "I" pour les étudiants inscrits)
* **Routes:** `/formsemestre/<int:formsemestre_id>/etudiants` ou `/formsemestre/<int:formsemestre_id>/etudiants/demissionnaires` ou `/formsemestre/<int:formsemestre_id>/etudiants/defaillants`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/etudiants/demissionnaires`
* **Résultat:** les étudiants inscrits à ce semestres XXX préciser état * **Résultat:** les étudiants inscrits à ce semestres XXX préciser état
(DEM, DEF)) (DEM, DEF))
@ -1065,7 +1069,7 @@ informations suivantes:
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept`, `formsemestre_id` * **Paramètres:** `dept`, `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/programme` * **Routes:** `/formsemestre/<int:formsemestre_id>/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. * **Résultat:** Retourne la liste des UEs, modules, ressources et SAE d'un semestre.
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
@ -1213,7 +1217,7 @@ d'un nombre quelconque de groupes d'étudiants.
* **Paramètres:** `group_id`, `etat` * **Paramètres:** `group_id`, `etat`
* **Routes:** `/partitions/groups/<int:group_id>` ou `/partitions/groups/<int:group_id>/etat/<string:etat>` * **Routes:** `/partitions/groups/<int:group_id>` ou `/partitions/groups/<int:group_id>/etat/<string:etat>`
* **Exemple d'utilisation:** `/ScoDoc/api/partitions/groups/1` * **Exemple d'utilisation:** `/ScoDoc/api/partitions/groups/1`
* **Résultat:** La liste de toutes les partitions d'un formsemestre. * **Résultat:** Retourne la liste des étudiants dans un groupe.
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
[ [