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

next

Browse Source
This commit is contained in:
Jean-Marie PLACE 2022-07-25 13:39:44 +02:00
parent 463273646f
commit 2a4cf59f02
1 changed files with 169 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

270
docs/ScoDoc9API.md
View File

@ -163,15 +163,6 @@ par le serveur ScoDoc.
## Départements ## Départements
#### **`departements_ids`**
* **Méthode:** GET
* **Routes:** `/departements_ids`
* **Résultat:** Liste des id départements (visibles ou non).
* **Exemple de résultat:**
```
[ 1888, 999, 165 ]
```
#### **`departements`** #### **`departements`**
* **Méthode:** GET * **Méthode:** GET
@ -186,6 +177,16 @@ par le serveur ScoDoc.
] ]
``` ```
#### **`departements_ids`**
* **Méthode:** GET
* **Routes:** `/departements_ids`
* **Résultat:** Liste des id départements (visibles ou non).
* **Exemple de résultat:**
```
[ 1888, 999, 165 ]
```
#### **`departement`** #### **`departement`**
* **Méthode:** GET * **Méthode:** GET
@ -207,13 +208,13 @@ par le serveur ScoDoc.
#### **Étudiants d'un département** #### **Étudiants d'un département**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept`, `formsemestre_id` * **Paramètres:** `dept`, `dept_id`
* **Routes:** * **Routes:**
* `/departement/id/<int:dept_id>/etudiants` * `/departement/id/<int:dept_id>/etudiants`
* `/departement/<string:dept>/etudiants` * `/departement/<string:dept>/etudiants`
* **Exemple d'utilisation:** `/api/departement/MMI/etudiants` * **Exemple d'utilisation:** `/api/departement/MMI/etudiants`
* **Résultat:** liste tous les étudiants d'un département. On peut spécifier l'acronyme du département * **Résultat:** liste tous les étudiants (passés ou présents) d'un département.
("MMI") ou son id (un entier). 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. Attention, la liste peut être longue: requête coûteuse à éviter.
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
@ -240,11 +241,11 @@ par le serveur ScoDoc.
* `/departement/id/<int:dept_id>/formsemestres_ids` * `/departement/id/<int:dept_id>/formsemestres_ids`
* `/departement/<string:dept>/formsemestres_ids` * `/departement/<string:dept>/formsemestres_ids`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids` * **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids`
* **Résultat:** Liste des id des formsemestres d'un département donné. * **Résultat:** Liste des id des formsemestres (passés ou présents) d'un département donné.
* **Exemple de résultat:** * **Exemple de résultat:**
```[ 28, 99, 3 ]``` ```[ 28, 99, 3 ]```
#### **Formsemestre courants d'un département** #### **Formsemestre en cours d'un département**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept` * **Paramètres:** `dept`
@ -254,7 +255,42 @@ par le serveur ScoDoc.
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants` * **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants`
* **Résultat:** Liste des id des formsemestres en cours d'un département donné. * **Résultat:** Liste des id des formsemestres en cours d'un département donné.
* **Exemple de résultat:** * **Exemple de résultat:**
```[ 28, 99 ]``` ```
[
{
"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"
},
...
]
```
### Semestres ### Semestres
@ -262,9 +298,8 @@ par le serveur ScoDoc.
#### **Formsemestre** #### **Formsemestre**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept` * **Paramètres:** `formsemestre_id`
* **Routes:** * **Route:** `/formsemestre/<int:formsemestre_id>`
* `/formsemestre/<int:formsemestre_id>`
* **Exemple d'utilisation:** `/api/formsemestre/1` * **Exemple d'utilisation:** `/api/formsemestre/1`
* **Résultat:** Données d'un formsemestre spécifié par son id. * **Résultat:** Données d'un formsemestre spécifié par son id.
* **Exemple de résultat:** * **Exemple de résultat:**
@ -304,95 +339,130 @@ par le serveur ScoDoc.
#### **Formsemestres** #### **Formsemestres**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept` * **Paramètres:** aucun
* **Routes:** * ** Query string:** `etape_apo`, `annee_scolaire`, `dept_acronym`, `dept_id`
* `/departement/id/<int:dept_id>/formsemestres_ids` * **Route:** `/formsemestres/query
* `/departement/<string:dept>/formsemestres_ids` * **Exemple d'utilisation:** `/api/formsemestres/query?etapeapo=V7HU1&annee_scolaire=2021`
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_ids` * **Résultat:** Données d'un formsemestre spécifié par son id.
* **Résultat:** Liste des id des formsemestres d'un département donné.
* **Exemple de résultat:** * **Exemple de résultat:**
```{
#### **Formsemestres en cours** "block_moyennes": false,
"bul_bgcolor": "white",
* **Méthode:** GET "bul_hide_xml": false,
* **Paramètres:** `dept` "date_debut_iso": "2021-09-01",
* **Routes:** "date_debut": "01/09/2021",
* `/departement/id/<int:dept_id>/formsemestres_courants` "date_fin_iso": "2022-08-31",
* `/departement/<string:dept>/formsemestres_courants` "date_fin": "31/08/2022",
* **Exemple d'utilisation:** `/api/departement/MMI/formsemestres_courants` "dept_id": 1,
* **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) "elt_annee_apo": "V7HU",
* **Exemple de résultat:** "elt_sem_apo": null,
``` "ens_can_edit_eval": false,
[ "etat": true,
{ "formation_id": 1,
"block_moyennes": false, "formsemestre_id": 1,
"bul_bgcolor": "white", "gestion_compensation": false,
"bul_hide_xml": false, "gestion_semestrielle": false,
"date_debut_iso": "2021-09-01", "id": 1,
"date_debut": "01/09/2021", "modalite": "FI",
"date_fin_iso": "2022-08-31", "resp_can_change_ens": true,
"date_fin": "31/08/2022", "resp_can_edit": false,
"dept_id": 1, "responsables": [
"elt_annee_apo": "V7HU", 12,
"elt_sem_apo": null, 42
"ens_can_edit_eval": false, ],
"etat": true, "scodoc7_id": null,
"formation_id": 1, "semestre_id": 1,
"formsemestre_id": 1, "titre_num": "BUT MMI semestre 1",
"gestion_compensation": false, "titre": "BUT MMI",
"gestion_semestrielle": false, "titre_formation": "BUT MMI"
"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"
},
...
]
```
Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
`titre_formation` est l'acronyme de la formation (défini dans son programme pédagogique). `titre_formation` est l'acronyme de la formation (défini dans son programme pédagogique).
#### **Bulletins d'un formsemestre**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Route:** `/formsemestres/bulletins
* **Exemple d'utilisation:** `/api/formsemestre/1/bulletins`
* **Résultat:** Bulletins d'un formsemestre spécifié par son id.
* **Exemple de résultat:**
#### **Programme d'un formsemestre**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Route:** `/formsemestres/programme
* **Exemple d'utilisation:** `/api/formsemestre/1/programme`
* **Résultat:** Liste des UEs, ressources et SAE d'un formsemestre spécifié par son id.
* **Exemple de résultat:**
#### **Etudiants d'un formsemestre**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Route:**
* `/formsemestres/etudiants`
* `/formsemestres/etudiants/demissionnaires`
* `/formsemestres/etudiants/defaillants`
* **Exemple d'utilisation:** `/api/formsemestre/1/etudiants`
* **Résultat:** Etudiants d'un formsemestre spécifié par son id. Liste est restreinte aux étudiants démissionnaires/défaillants si l'option correspondante est ajoutée au chemin
* **Exemple de résultat:**
#### **Etat des évaluations d'un formsemestre**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Route:** `/formsemestres/etat_evals`
* **Exemple d'utilisation:** `/api/formsemestre/1/etat_evals`
* **Résultat:** informations sur les évaluations d'un formsemestre spécifié par son id.
* **Exemple de résultat:**
#### **Résultats d'un formsemestre**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Query string: `format`
* **Route:** `/formsemestres/resultats`
* **Exemple d'utilisation:** `/api/formsemestre/1/etat_evals`
* **Résultat:** Récapitulatif par étudiant (état, groupe(s), moyennes d'UEs et de modules
pour un formsemestre spécifié par son id.
Par défaut les valeurs numériques sont formattées en chaînes. Si format=raw, valeurs numériques
mais pas JSON compliant à cause des _NaN_.
* **Exemple de résultat:**
## Étudiants ## Étudiants
#### **`etudiants_courant`** #### **`etudiants_courant`**
* **Méthode:** GET * **Méthode:** GET
* **Routes:** * **Routes:**
* `/etudiants/courant` * `/etudiants/courant`
* `/etudiants/courant/long` * `/etudiants/courant/long`
* **Exemple d'utilisation:** `/api/etudiants/courant` * **Exemple d'utilisation:** `/api/etudiants/courant`
* **Résultat:** Liste des étudiants inscrits dans un formsemestre * **Résultat:** Liste des étudiants inscrits dans un formsemestre
actuellement en cours. Avec `/long`, donne tous les attributs de actuellement en cours. Avec `/long`, donne tous les attributs de
l'étudiants (plus lent). l'étudiants (plus lent).
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
[ [
{ {
"id": 1, "id": 1,
"nip": 1, "nip": 1,
"nom": "MOREL", "nom": "MOREL",
"prenom": "JACQUES", "prenom": "JACQUES",
"civilite": "X" "civilite": "X"
}, },
{ {
"id": 2, "id": 2,
"nip": 2, "nip": 2,
"nom": "GILLES", "nom": "GILLES",
"prenom": "MAXIME", "prenom": "MAXIME",
"civilite": "X" "civilite": "X"
} }
] ]
``` ```
#### **`etudiant`** #### **`etudiant`**
@ -755,8 +825,6 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
] ]
``` ```
## Programmes de formations ## Programmes de formations
#### **`formation`** #### **`formation`**