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

debut doc nouvelel API à reformatter

Browse Source
This commit is contained in:
Emmanuel Viennet 2021-11-09 21:37:37 +01:00
parent b125025eca
commit 2d4b651ec7
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/ScoDoc9API.md
View File

@ -48,8 +48,34 @@ en POST.
Note:
- `Absences/listeBillets` est un formulaire et ne fait pas partie de l'API.
# Résumé des fonctions d'API ScoDoc 9 (work in progress)
# XXX à rédiger XXX Fonctions d'accès aux données
Basé sur le ticket
## Définition des points d'accès à l'API REST (jwt):
**Note: à reformatter: le tableau n'est pas lisible et exploitable**
Elle sera accessible à l'adresse: https://scodoc.monsite.tld/ScoDoc/api/fonction
| Fonction | Méthode | Paramètres | Exemple | Exemple resultat | Commentaires |
|:--------:|:-------:|:----------:|:-------:|:----------------|:------------:|
|etud_dept |GET|code_nip|/api/etud_dept/123|[ {exist: true, dept: "GEII", id: 987, dept_id: 3} ]|liste des étudiants avec le code NIP donné triée par ordre d'inscription décroissant|
|etud_info |GET|etud_id|/api/etud_info/987|{"nom": "Mutis","sexe": "M.","email": "alvaro.mutis@example.com","prenom": "ALVARO","nomprenom": "M. Alvaro MUTIS","insemestre": [{"etat": "I","formsemestre_id": "SEM12781","date_fin": "2010-07-30","date_debut": "2010-01-25"},{"etat": "I","formsemestre_id": "SEM8396","date_fin": "2009-01-16","date_debut": "2008-09-01"}],"etudid": "EID8768","domicile": "2 Rue Madame","villedomicile": "Paris","telephonemobile": ""}| |
|etud_bul|GET|etud_id ou sem_id|/api/etud_bul **OU** /987/12| |cf formsemestre_bulletinetud de [l'ancienne API](https://scodoc.org/ScoDocAPI/)|
|sem_info|GET|sem_id|/api/sem_info/12|[ {"titre": "DUT Génie Electrique et Informatique Industrielle","date_debut": "01/09/2021","date_fin": "02/02/2022","modalite": "FI","sem_id_txt": "S3","titre_num": "DUT Génie Electrique et Informatique Industrielle semestre 3","anneescolaire": "2021 - 2022","periode": 1,"titreannee": "DUT Génie Electrique et Informatique Industrielle semestre 3 FI 2021-2022"} ]| |
|photo|GET|etud_id|/api/photo/123 **OU** /api/photo **OU** /123/smal| | |
|formation_list|GET|dept (*facultatif*)|/api/formation_list **OU** /api/formation_list?dept=GEI| { "id": 1,"dept_id": 1,"acronyme": "BUT GEII", "titre": "BUT G\u00e9nie Electrique et Informatique Industrielle", "titre_officiel": "BUT G\u00e9nie Electrique et Informatique Industrielle","version": 1,"formation_code": "FCOD1","type_parcours": 600,"code_specialite": "","formation_id": 1 }| |
|formsemestre_list|GET|formation_id|/api/formation_list/formation_id| | |
|formsemestre_partition_list|GET|semestre_id|/api/formsemestre_partition_list/semestre_id| | |
|module_list|GET|semestre_id|/api/module_list/semestre_id| | |
|eval_list|GET|module_id|/api/eval_list/module_id| | |
|evaluation_listenotes|GET|evaluation_id|/api/evalutation_listenotes/evaluation_id| | |
|setGroups|POST|partition_id, groupsLists, groupsToDelete, groupsToCreate|/api/setGroups/???| | |
|setNote|POST|evaluation_id, etudid, note|/api/setNote/???| |
# XXX à revoir XXX Fonctions d'accès aux données
## Départements
* **`list_depts`**
* Paramètres: `viewable` (optionnel, si faux liste aussi les départements non accessible à l'utilisateur courant), `format` (json, xml)