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

mise en page + qq remarques sur l'API

Browse Source
This commit is contained in:
Emmanuel Viennet 2021-11-19 16:36:03 +01:00
parent fe583938e0
commit d409fd66a9
1 changed files with 692 additions and 684 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/ScoDoc9API.md
View File

@ -125,13 +125,14 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
"insemestre": [ "insemestre": [
{ {
"etat": "I", "etat": "I",
"formsemestre_id": "SEM12781", "formsemestre_id": "12781",
"date_fin": "2010-07-30", "date_fin": "2010-07-30",
"date_debut": "2010-01-25" "date_debut": "2010-01-25"
"parcours_type": XXX type de parcours, en discussion XXX
}, },
{ {
"etat": "I", "etat": "I",
"formsemestre_id": "SEM8396", "formsemestre_id": "8396",
"date_fin": "2009-01-16", "date_fin": "2009-01-16",
"date_debut": "2008-09-01" "date_debut": "2008-09-01"
} }
@ -150,7 +151,9 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
* **Format URL:** `/api/etud/<int:etudid>/bul/<int:sem_id>` * **Format URL:** `/api/etud/<int:etudid>/bul/<int:sem_id>`
* **Exemple d'utilisation:** `/api/etud/987/bul/12` * **Exemple d'utilisation:** `/api/etud/987/bul/12`
* **Résultat:** Le bulletin d'un étudiant en fonction de son id et d'un semestre donné. * **Résultat:** Le bulletin d'un étudiant en fonction de son id et d'un semestre donné.
* **Exemple de résultat:** [Bulletins par défaut](https://scodoc.org/ParametrageBulletins/#exemple-1-bulletins-par-defaut) * **Exemple de résultat:** voir plus bas sur cette page.
Voir aussi [Bulletins par défaut](https://scodoc.org/ParametrageBulletins/#exemple-1-bulletins-par-defaut)
@ -225,6 +228,8 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"titre_annee": "BUT Génie Electrique et Informatique Industrielle semestre 3 FI 2021-2022" "titre_annee": "BUT Génie Electrique et Informatique Industrielle semestre 3 FI 2021-2022"
"titre_num": "BUT Génie Electrique et Informatique Industrielle semestre 3", "titre_num": "BUT Génie Electrique et Informatique Industrielle semestre 3",
"titre": "BUT Génie Electrique et Informatique Industrielle", "titre": "BUT Génie Electrique et Informatique Industrielle",
"parcours_type": XXX type de parcours
'formation_id": 87,
} }
] ]
``` ```
@ -253,6 +258,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
## Modules de formation ## Modules de formation
Les moduleimpl sont les modules d'un semestre, ou les ressources, ou les SAÉs. Les moduleimpl sont les modules d'un semestre, ou les ressources, ou les SAÉs.
On peut récupérer soit un module par son id, soit la listes des modules d'un semestre. On peut récupérer soit un module par son id, soit la listes des modules d'un semestre.
* **`moduleimpl`** * **`moduleimpl`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres**: `formsemestre_id` ou `moduleimpl_id` * **Paramètres**: `formsemestre_id` ou `moduleimpl_id`
@ -360,6 +366,7 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
</etud> </etud>
</group_list> </group_list>
``` ```
* **Exemple de résultat au format JSON:** * **Exemple de résultat au format JSON:**
``` ```
[ [
@ -395,7 +402,8 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **Format URL:** `/api/set_groups?partition_id=<int:partition_id>&groups=<int:groups>&groups_to_delete=<int:groups_to_delete>&groups_to_create=<int:groups_to_create>` * **Format URL:** `/api/set_groups?partition_id=<int:partition_id>&groups=<int:groups>&groups_to_delete=<int:groups_to_delete>&groups_to_create=<int:groups_to_create>`
* **Exemple d'utilisation:** `/api/set_groups?partition_id=65&groups=77&groups_to_delete=8&groups_to_create=4` * **Exemple d'utilisation:** `/api/set_groups?partition_id=65&groups=77&groups_to_delete=8&groups_to_create=4`
* **Résultat:** Set les groups. * **Résultat:** Set les groups.
TODO: à changer, passer les paramètres dans le corps de la requete
TODO: à changer, passer les paramètres dans le corps de la requête
## Bulletins de notes ## Bulletins de notes