This commit is contained in:
Jean-Marie PLACE 2022-07-25 11:57:43 +02:00
parent e1d587bd49
commit af4525989a

View File

@ -172,10 +172,26 @@ par le serveur ScoDoc.
```
[ 1888, 999, 165 ]
```
#### **`departements`**
* **Méthode:** GET
* **Routes:** `/departements`
* **Exemple d'utilisation:** `/api/departements`
* **Résultat:** Liste des tous les départements (visibles ou non).
* **Exemple de résultat:**
```
[
{ un département }
...
]
```
#### **`departement`**
* **Méthode:** GET
* **Routes:** `/departement/<dept_id>`
* **Routes:**
* `/departement/id/<int:dept_id>`
* `/departement/<string:dept>`
* **Résultat:** Un département
* **Exemple de résultat:**
```
@ -188,28 +204,15 @@ par le serveur ScoDoc.
},
```
#### **`departements`**
* **Méthode:** GET
* **Routes:** `/departements`
* **Exemple d'utilisation:** `/api/departements`
* **Résultat:** Liste des tous les départements (visibles ou non).
* **Exemple de résultat:**
```
[
{ un département }
...
]
```
#### **Étudiants d'un département**
* **Méthode:** GET
* **Paramètres:** `dept`, `formsemestre_id`
* **Routes:** `/departement/<string:dept>/etudiants`
* **Routes:**
* `/departement/id/<int:dept_id>/etudiants`
* `/departement/<string:dept>/etudiants`
* **Exemple d'utilisation:** `/api/departement/MMI/etudiants`
* **Résultat:** liste tous les étudiants d'un département, par défaut, ou d'un
formsemestre si renseigné. On peut spécifier l'acronyme du département
* **Résultat:** liste tous les étudiants d'un département. On peut spécifier l'acronyme du département
("MMI") ou son id (un entier).
Attention, la liste peut être longue: requête coûteuse à éviter.
* **Exemple de résultat:**
@ -229,26 +232,95 @@ par le serveur ScoDoc.
...
]
```
#### **Formsemestre d'un département**
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_ids`
* `/departement/<string:dept>/formsemestres_ids`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids`
* **Résultat:** Liste des id des formsemestres d'un département donné.
* **Exemple de résultat:**
```[ 28, 99, 3 ]```
#### **Formsemestre courants d'un département**
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_courants`
* `/departement/<string:dept>/formsemestres_courants`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants`
* **Résultat:** Liste des id des formsemestres en cours d'un département donné.
* **Exemple de résultat:**
```[ 28, 99 ]```
### Semestres
#### **Formsemestre**
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:**
* `/formsemestre/<int:formsemestre_id>`
* **Exemple d'utilisation:** `/api/formsemestre/1`
* **Résultat:** Données d'un formsemestre spécifié par son id.
* **Exemple de résultat:**
```{
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut_iso": "2021-09-01",
"date_debut": "01/09/2021",
"date_fin_iso": "2022-08-31",
"date_fin": "31/08/2022",
"dept_id": 1,
"elt_annee_apo": "V7HU",
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etat": true,
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"resp_can_edit": false,
"responsables": [
12,
42
],
"scodoc7_id": null,
"semestre_id": 1,
"titre_num": "BUT MMI semestre 1",
"titre": "BUT MMI",
"titre_formation": "BUT MMI"
}
```
#### **Formsemestres**
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:** `/departement/<string:dept>/formsemestres_ids`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids`
* **Résultat:** Liste des id des formsemestres d'un département donné.
* **Exemple de résultat:**
```[ 28, 99, 3 ]```
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_ids`
* `/departement/<string:dept>/formsemestres_ids`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids`
* **Résultat:** Liste des id des formsemestres d'un département donné.
* **Exemple de résultat:**
#### **Formsemestres en cours**
* **Méthode:** GET
* **Paramètres:** `dept`
* **Routes:** `/departement/<string:dept>/formsemestres_courants`
* **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_courants`
* `/departement/<string:dept>/formsemestres_courants`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants`
* **Résultat:** Liste des formsemestres en cours d'un département donné.
* **Résultat:** Liste des formsemestres en cours d'un département donné (date du jour dans la période couverte par le formsemestre,tous départements, dans tous les départements où l'utilisateur à le rôle APIView ou ScoView)
* **Exemple de résultat:**
```
[
@ -295,7 +367,9 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
#### **`etudiants_courant`**
* **Méthode:** GET
* **Routes:** `/etudiants/courant` ou `/etudiants/courant/long`
* **Routes:**
* `/etudiants/courant`
* `/etudiants/courant/long`
* **Exemple d'utilisation:** `/api/etudiants/courant`
* **Résultat:** Liste des étudiants inscrits dans un formsemestre
actuellement en cours. Avec `/long`, donne tous les attributs de