cleo/DocScoDocPE
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Mise à jour du 05/05/2022

Browse Source
This commit is contained in:
leonard_montalbano 2022-05-05 12:02:45 +02:00
parent b208e4a128
commit 0aae272952
1 changed files with 73 additions and 188 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

201
docs/ScoDoc9API.md
View File

@ -163,8 +163,8 @@ informations suivantes:
* **`liste_etudiants`** * **`liste_etudiants`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept`, `formsemestre_id` * **Paramètres:** `dept`, `formsemestre_id`
* **Routes:** `/departements/<string:dept>/etudiants/liste` ou `/api/departements/<string:dept>/etudiants/liste/<int:formsemestre_id>` * **Routes:** `/departements/<string:dept>/etudiants/list` ou `/api/departements/<string:dept>/etudiants/list/<int:formsemestre_id>`
* **Exemple d'utilisation:** `/api/departements/MMI/etudiants/liste` * **Exemple d'utilisation:** `/api/departements/MMI/etudiants/list`
* **Résultat:** liste des étudiants d'un département, par défaut, ou d'un semestre si renseigné. (json) * **Résultat:** liste des étudiants d'un département, par défaut, ou d'un semestre si renseigné. (json)
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
@ -230,24 +230,17 @@ informations suivantes:
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [] "responsables": [
"titre_court": BUT MMI 12,
42
],
"titre_court": "BUT MMI"
}, },
... ...
] ]
``` ```
* **`referentiel_competences`**
* **Méthode:** GET
* **Paramètres:** `dept`, `formation_id`
* **Routes:** `/departements/<string:dept>/formations/<int:formation_id>/referentiel_competences`
* **Exemple d'utilisation:** `api/departements/MMI/formations/1/referentiel_competences`
* **Résultat:** Le référentiel de compétences d'une formation donnée (json). (_pas toujours présent_)
* XXX obtenir la liste des référentiels
### Etudiants ### Etudiants
* **`etudiants_courant`** * **`etudiants_courant`**
@ -346,9 +339,13 @@ informations suivantes:
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [] "responsables": [
"titre_court": BUT MMI 12,
} 42
],
"titre_court": "BUT MMI"
},
...
] ]
``` ```
@ -570,30 +567,13 @@ informations suivantes:
## Programmes de formations ## Programmes de formations
* **`formations`** * **`formations_ids`**
* **Méthode:** GET * **Méthode:** GET
* **Routes:** `/ScoDoc/api/formations` * **Routes:** `/ScoDoc/api/formations_ids`
* **Exemple d'utilisation:** `/ScoDoc/api/formations` * **Exemple d'utilisation:** `/ScoDoc/api/formations_ids`
* **Résultat:** Liste des formations. * **Résultat:** Retourne la liste de toutes les id de formations (tous départements)
* **Exemple de résultat:** * **Exemple de résultat:** `[17, 99, 32]`
```
[
{
"id": 1,
"acronyme": "BUT R&amp;T",
"titre_officiel": "Bachelor technologique réseaux et télécommunications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"titre": "BUT R&amp;T",
"version": 1,
"type_parcours": 700,
"referentiel_competence_id": null,
"formation_id": 1
},
...
]
```
* **`formations_by_id`** * **`formations_by_id`**
* **Méthode:** GET * **Méthode:** GET
@ -619,7 +599,7 @@ informations suivantes:
``` ```
* **`formation_export_by_formation_id`** * **`formation_export_by_formation_id`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formation_id`, `export_ids` (False par défaut) * **Paramètres:** `formation_id`, `export_ids` (False par défaut. Ajouter `/with_ids` pour le passer à True)
* **Routes:** `/formations/formation_export/<int:formation_id>` * **Routes:** `/formations/formation_export/<int:formation_id>`
* **Exemple d'utilisation:** `/ScoDoc/api/formations/formation_export/1` * **Exemple d'utilisation:** `/ScoDoc/api/formations/formation_export/1`
* **Résultat:** Retourne la formation, avec UE, matières, modules * **Résultat:** Retourne la formation, avec UE, matières, modules
@ -711,6 +691,14 @@ informations suivantes:
] ]
} }
``` ```
* **`referentiel_competences`**
* **Méthode:** GET
* **Paramètres:** `formation_id`
* **Routes:** `/formations/<int:formation_id>/referentiel_competences`
* **Exemple d'utilisation:** `api/formations/1/referentiel_competences`
* **Résultat:** Le référentiel de compétences d'une formation donnée (json). (_pas toujours présent_)
* XXX obtenir la liste des référentiels
### Semestres de formation ### Semestres de formation
Les sessions de formation (dénommées "semestres" même si elles durent une année ou un mois) sont représentées par les `formsemestre`. Les sessions de formation (dénommées "semestres" même si elles durent une année ou un mois) sont représentées par les `formsemestre`.
@ -748,8 +736,11 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [] "responsables": [
"titre_court": BUT MMI 12,
42
],
"titre_court": "BUT MMI"
} }
``` ```
* **`formsemestre_apo`** * **`formsemestre_apo`**
@ -760,6 +751,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
* **Résultat:** Retourne les informations sur les formsemestres * **Résultat:** Retourne les informations sur les formsemestres
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
[
{ {
"date_fin": "31/08/2022", "date_fin": "31/08/2022",
"resp_can_edit": false, "resp_can_edit": false,
@ -785,124 +777,17 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [] "responsables": [
"titre_court": BUT MMI 12,
} 42
```
* **`etudiant_bulletin`**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`, `dept`, `etudid`, `nip`, `ine`
* **Routes:** `/formsemestre/<int:formsemestre_id>/departements/<string:dept>/etudiant/etudid/<int:etudid>/bulletin` ou `/formsemestre/<int:formsemestre_id>/departements/<string:dept>/etudiant/nip/<int:nip>/bulletin` ou `/formsemestre/<int:formsemestre_id>/departements/<string:dept>/etudiant/ine/<int:ine>/bulletin`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/departements/MMI/etudiant/etudid/1/bulletin`
* **Résultat:** Retourne le bulletin de note d'un étudiant
* **Exemple de résultat:**
```
{
"etudid": 1,
"formsemestre_id": 1,
"date": "2022-04-27T10:44:47.448094",
"publie": true,
"etapes": [],
"etudiant": {
"etudid": 1,
"code_nip": "1",
"code_ine": "1",
"nom": "COSTA",
"prenom": "Sacha",
"civilite": "",
"photo_url": "/ScoDoc/TAPI/Scolarite/get_photo_image?etudid=1&amp;size=small",
"email": "SACHA.COSTA@example.com",
"emailperso": "",
"sexe": ""
},
"note": {
"value": "10.60",
"min": "-",
"max": "-",
"moy": "-"
},
"rang": {
"value": "10",
"ninscrits": 16
},
"rang_group": [
{
"group_type": "TD",
"group_name": "",
"value": "",
"ninscrits": ""
}
], ],
"note_max": { "titre_court": "BUT MMI"
"value": 20
}, },
"bonus_sport_culture": { ...
"value": 0
},
"ue": [
{
"id": 1,
"numero": "1",
"acronyme": "RT1.1",
"titre": "Administrer les réseaux et l’Internet",
"note": {
"value": "08.50",
"min": "06.00",
"max": "16.50",
"moy": "11.31"
},
"rang": "12",
"effectif": 16,
"ects": "12",
"code_apogee": "",
"module": [
{
"id": 1,
"code": "R101",
"coefficient": 1,
"numero": 10,
"titre": "Initiation aux réseaux informatiques",
"abbrev": "Init aux réseaux informatiques",
"note": {
"value": "12.00",
"moy": "-",
"max": "-",
"min": "-",
"nb_notes": "-",
"nb_missing": "-",
"nb_valid_evals": "-"
},
"code_apogee": "",
"evaluation": [
{
"jour": "2022-04-20",
"heure_debut": "08:00:00",
"heure_fin": "09:00:00",
"coefficient": 1,
"evaluation_type": 0,
"evaluation_id": 1,
"description": "eval1",
"note": "12.00"
}
] ]
}
]
}
],
"ue_capitalisee": [],
"absences": {
"nbabs": 2,
"nbabsjust": 1
},
"appreciation": []
}
``` ```
* **`bulletins`** * **`bulletins`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
@ -1096,7 +981,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
XXX A COMPLETER XXX A COMPLETER
``` ```
* **`semestre_index`** * **`programme`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `dept`, `formsemestre_id` * **Paramètres:** `dept`, `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/programme` * **Routes:** `/formsemestre/<int:formsemestre_id>/programme`
@ -1217,8 +1102,8 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **`moduleimpls_sem`** * **`moduleimpls_sem`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `moduleimpl_id` * **Paramètres:** `moduleimpl_id`
* **Routes:** `/formations/moduleimpl/formsemestre/<int:formsemestre_id>/liste` * **Routes:** `/formations/moduleimpl/formsemestre/<int:formsemestre_id>/list`
* **Exemple d'utilisation:** `/ScoDoc/api/formations/moduleimpl/formsemestre/1/liste` * **Exemple d'utilisation:** `/ScoDoc/api/formations/moduleimpl/formsemestre/1/list`
* **Résultat:** Retourne la liste des moduleimpl d'un semestre * **Résultat:** Retourne la liste des moduleimpl d'un semestre
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```