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

mise en page + qq remarques sur l'API

Browse Source
This commit is contained in:
Emmanuel Viennet 2021-11-19 16:36:03 +01:00
parent fe583938e0
commit d409fd66a9
1 changed files with 692 additions and 684 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

132
docs/ScoDoc9API.md
View File

@ -125,13 +125,14 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
"insemestre": [
{
"etat": "I",
"formsemestre_id": "SEM12781",
"formsemestre_id": "12781",
"date_fin": "2010-07-30",
"date_debut": "2010-01-25"
"parcours_type": XXX type de parcours, en discussion XXX
},
{
"etat": "I",
"formsemestre_id": "SEM8396",
"formsemestre_id": "8396",
"date_fin": "2009-01-16",
"date_debut": "2008-09-01"
}
@ -150,7 +151,9 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
* **Format URL:** `/api/etud/<int:etudid>/bul/<int:sem_id>`
* **Exemple d'utilisation:** `/api/etud/987/bul/12`
* **Résultat:** Le bulletin d'un étudiant en fonction de son id et d'un semestre donné.
* **Exemple de résultat:** [Bulletins par défaut](https://scodoc.org/ParametrageBulletins/#exemple-1-bulletins-par-defaut)
* **Exemple de résultat:** voir plus bas sur cette page.
Voir aussi [Bulletins par défaut](https://scodoc.org/ParametrageBulletins/#exemple-1-bulletins-par-defaut)
@ -225,16 +228,18 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"titre_annee": "BUT Génie Electrique et Informatique Industrielle semestre 3 FI 2021-2022"
"titre_num": "BUT Génie Electrique et Informatique Industrielle semestre 3",
"titre": "BUT Génie Electrique et Informatique Industrielle",
"parcours_type": XXX type de parcours
'formation_id": 87,
}
]
```
### Note sur les identifiants de sessions
Le `session_id` peut être utilisé pour identifier de façon prévisible et
(presque) unique une session dans un établissement, ce qui est utile
notamment pour interfacer ScoDoc à d'autres logiciels (par exemple gestion d'emplois
du temps ou de services d'enseignement). Cet identifiant est constitué des
informations suivantes:
Le `session_id` peut être utilisé pour identifier de façon prévisible et
(presque) unique une session dans un établissement, ce qui est utile
notamment pour interfacer ScoDoc à d'autres logiciels (par exemple gestion d'emplois
du temps ou de services d'enseignement). Cet identifiant est constitué des
informations suivantes:
* **Département** (RT, GEII, INFO...) (= paramètre `DeptName`, en majuscules)
* **Nom parcours:** BUT, LP, ... (défini au niveau du parcours dans ScoDoc = NAME)
@ -253,6 +258,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
## Modules de formation
Les moduleimpl sont les modules d'un semestre, ou les ressources, ou les SAÉs.
On peut récupérer soit un module par son id, soit la listes des modules d'un semestre.
* **`moduleimpl`**
* **Méthode:** GET
* **Paramètres**: `formsemestre_id` ou `moduleimpl_id`
@ -266,9 +272,9 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
## Groupes et partitions
L'ensemble des étudiants d'un semestre peut être réparti selon une ou
plusieurs partitions (types de groupes). Chaque partition est constituée
d'un nombre quelconque de groupes d'étudiants.
L'ensemble des étudiants d'un semestre peut être réparti selon une ou
plusieurs partitions (types de groupes). Chaque partition est constituée
d'un nombre quelconque de groupes d'étudiants.
* **`partition`**
* **Méthode: GET**
@ -336,8 +342,8 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **Exemple d'utilisation:**
* **Résultat:** Liste des étudiants dans un groupe.
* **Exemple de résultat au format XML:** (_avec `with_codes=1`_)
```
<group_list origin="" caption="soit 21 étudiants inscrits et 2 démissionaires." id="gt_711068">
```
<group_list origin="" caption="soit 21 étudiants inscrits et 2 démissionaires." id="gt_711068">
<etud>
<nom value="TOTO"/>
@ -358,11 +364,12 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
<code_nip value="12345678"/>
<code_ine value=""/>
</etud>
</group_list>
```
</group_list>
```
* **Exemple de résultat au format JSON:**
```
[
```
[
{
"etat":"I",
"emailperso":null,
@ -386,8 +393,8 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"62030":"A1"
},
...
]
```
]
```
* **`set_groups`**
* **Méthode:** POST
@ -395,7 +402,8 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **Format URL:** `/api/set_groups?partition_id=<int:partition_id>&groups=<int:groups>&groups_to_delete=<int:groups_to_delete>&groups_to_create=<int:groups_to_create>`
* **Exemple d'utilisation:** `/api/set_groups?partition_id=65&groups=77&groups_to_delete=8&groups_to_create=4`
* **Résultat:** Set les groups.
TODO: à changer, passer les paramètres dans le corps de la requete
TODO: à changer, passer les paramètres dans le corps de la requête
## Bulletins de notes
@ -415,16 +423,16 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **Exemple d'utilisation:** `/api/eval_notes/24`
* **Résultat:** Liste des notes à partir de l'id d'une évaluation donnée.
* **Exemple de résultat:**
```
[
```
[
{
"84": "13",
"85": "15",
"86": "9",
...
}
]
```
]
```
* **`evaluation_set_notes`**
@ -443,16 +451,16 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
* **Exemple d'utilisation:**
* **Résultat:** Un bulletin de notes.
* **Exemple de résultat:** ici au format JSON, pour une version courte (`version=short`)
```
{
"rang": {
```
{
"rang": {
"ninscrits": 52,
"value": "1"
},
"etape_apo2": "",
"etape_apo3": "",
"etape_apo4": "",
"etudiant": {
},
"etape_apo2": "",
"etape_apo3": "",
"etape_apo4": "",
"etudiant": {
"nom": "BOLANO",
"prenom": "Roberto",
"sexe": "M.",
@ -461,27 +469,27 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"code_nip": "123456789",
"email": "roberto@santateresa.mx",
"photo_url": "\/ScoDoc\/static\/photos\/F68\/RT_29960.h90.jpg"
},
"bonus_sport_culture": {
},
"bonus_sport_culture": {
"value": 0
},
"absences": {
},
"absences": {
"nbabsjust": 0,
"nbabs": 1
},
"decision": {
},
"decision": {
"etat": "I",
"code": "ADM",
"compenseformsemestre_id" : "SEM12345" /* si ce semestre en compense un autre */
},
"note": {
},
"note": {
"max": "15.51",
"moy": "10.80",
"value": "15.51",
"min": "07.29"
},
},
etudid": "9860",
"decision_ue": [
"decision_ue": [
{
"acronyme": "UE11",
"code": "ADM",
@ -498,24 +506,24 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"numero": "12",
"ue_id": "UE21478"
}
],
"ue_capitalisee": [
],
"ue_capitalisee": [
],
"publie": 1,
"autorisation_inscription": [
],
"publie": 1,
"autorisation_inscription": [
{
"semestre_id": 2
}
],
"appreciation": [
],
"appreciation": [
],
"note_max": {
],
"note_max": {
"value": 20
},
"date": "2014-07-12T17:38:47.693262",
"rang_group": [
},
"date": "2014-07-12T17:38:47.693262",
"rang_group": [
{
"ninscrits": 26,
"value": "1",
@ -552,10 +560,10 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"group_type": "sport",
"group_name": ""
}
],
formsemestre_id": "SEM12345",
"etape_apo": "V1RT",
"ue": [
],
formsemestre_id": "SEM12345",
"etape_apo": "V1RT",
"ue": [
{
"acronyme": "UE11",
"rang": "1",
@ -1067,10 +1075,10 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"titre": "Sport &amp;amp; Culture",
"id": "UE23716"
}
],
"situation": "Inscrit le 2015-09-02. D\u00e9cision jury: Valid\u00e9. UE acquises: UE11, UE12. Autoris\u00e9 \u00e0 s&apos;inscrire en S2."
}
```
],
"situation": "Inscrit le 2015-09-02. D\u00e9cision jury: Valid\u00e9. UE acquises: UE11, UE12. Autoris\u00e9 \u00e0 s&apos;inscrire en S2."
}
```
## Absences
**Remarques**, les dates sont au format iso `yyyy-mm-dd`. Les dates de fin ne sont pas incluses. Et `demi_journee`= 2 si journée complète, =1 si uniquement le matin, =0 si uniquement l'après-midi.