jmplace/DocScoDoc
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request 'preparation des enrées utilisateurs/roles/departement-create, ...' (#36) from jmplace/DocScoDoc:complements_9.docs into master

Browse Source 
Reviewed-on: https://scodoc.org/git/viennet/DocScoDoc/pulls/36
This commit is contained in:
Emmanuel Viennet 2022-08-11 14:01:28 +02:00
commit b085b9e1f7
1 changed files with 73 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
docs/ScoDoc9API.md
View File

@ -292,6 +292,15 @@ Ce tableau est trié selon le type des informations renvoyées:
* **Résultat:** Un département
* **Exemple de résultat:** [departement.json](samples/sample_departement.json.md)
#### **`departement-create`**
TODO
#### **`departement-edit`**
TODO
#### **`departement-delete`**
TODO
### **API Etudiant**
#### Structure Etudiant
@ -654,6 +663,20 @@ informatique de 2014 en formation initiale (FI).
* **Résultat:** Retire un étudiant d'un groupe.
* **[Exemple de résultat](samples/sample_group-remove_etudiant.json.md)**
### **API Jury**
#### **`formsemestre-decision_jury`**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/decision_jury`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/jury`
* **Résultat:** Retourne le récapitulatif des décisions jury
* **Exemple de résultat:**
* semestre pair
* semestre impair
```
XXX A COMPLETER
```
### **API Moduleimpl**
#### Structure ModuleImpl
@ -761,6 +784,56 @@ d'un nombre quelconque de groupes d'étudiants.
* **Résultat:** Retire un étudiant des groupes de la partition.
* **[Exemple de résultat](samples/sample_partition-remove_etudiant.json.md)**
### **API Role**
#### **roles**
TODO
#### **role**
TODO
#### **role-add_permission**
TODO
#### **role-remove_permission**
TODO
#### **role-create**
TODO
#### **role-delete**
TODO
#### **role-edit**
TODO
### **API User, Permissions**
#### **user**
* **Méthode:** GET
* **Paramètres:** `user_id`
* **Route:** `/user/<int:user_id>`
* **Exemple d'utilisation:** `/api/user/1`
* **Résultat:** Retourne la description d'un utilisateur.
* **Exemple de résultat:** [user.json](samples/sample_user.json.md)
#### **`user-create`**
TODO
#### **`user-query`**
TODO
#### **`user-edit`**
TODO
#### **`user-role-add`**
TODO
#### **`user-role-remove`**
TODO
#### **`permissions`**
TODO
### ** API Bulletin, Evaluations, Notes**
#### **formsemestre-bulletins**
* **Méthode:** GET
@ -882,29 +955,6 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
* **Résultat:** Le référentiel de compétences d'une formation donnée (json). (_pas toujours présent_)
* **Exemple de résultat:** [formation-referentiel_competences.json](samples/sample_formation-referentiel_competences.json.md)
### **API User**
#### **user**
* **Méthode:** GET
* **Paramètres:** `user_id`
* **Route:** `/user/<int:user_id>`
* **Exemple d'utilisation:** `/api/user/1`
* **Résultat:** Retourne la description d'un utilisateur.
* **Exemple de résultat:** [user.json](samples/sample_user.json.md)
### **API Jury**
#### **`formsemestre-decision_jury`**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/decision_jury`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/jury`
* **Résultat:** Retourne le récapitulatif des décisions jury
* **Exemple de résultat:**
* semestre pair
* semestre impair
```
XXX A COMPLETER
```
### **API Logos**
#### **`logos`**
* **Méthode:** GET