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

API: wip

Browse Source
This commit is contained in:
Emmanuel Viennet 2022-05-13 12:20:13 -04:00
parent 8d768cf22c
commit 19856695a7
1 changed files with 9 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/ScoDoc9API.md
View File

@ -1223,53 +1223,15 @@ d'un nombre quelconque de groupes d'étudiants.
] ]
``` ```
* **`etud_in_group`** * **`/partitions/groups/`**
* **Méthode: GET** * **Méthode: GET**
* **Paramètres:** `group_id`, `etat` * **Paramètres:** `group_id`, `etat`
* **Routes:** `/partitions/groups/<int:group_id>` ou `/partitions/groups/<int:group_id>/etat/<string:etat>` * **Routes:** `/partitions/groups/<int:group_id>` ou `/partitions/groups/<int:group_id>/etat/<string:etat>`
* **Exemple d'utilisation:** `/ScoDoc/api/partitions/groups/1` * **Exemple d'utilisation:** `/ScoDoc/api/partitions/groups/1`
* **Résultat:** La liste de toutes les partitions d'un formsemestre. * **Résultat:** XXX à préciser
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
[
{
"etudid": 10,
"id": 10,
"dept_id": 1,
"nom": "BOUTET",
"prenom": "Marguerite",
"nom_usuel": "",
"civilite": "F",
"date_naissance": null,
"lieu_naissance": null,
"dept_naissance": null,
"nationalite": null,
"statut": null,
"boursier": null,
"photo_filename": null,
"code_nip": "10",
"code_ine": "10",
"scodoc7_id": null,
"email": "MARGUERITE.BOUTET@example.com",
"emailperso": null,
"domicile": null,
"codepostaldomicile": null,
"villedomicile": null,
"paysdomicile": null,
"telephone": null,
"telephonemobile": null,
"fax": null,
"typeadresse": "domicile",
"description": null,
"group_id": 1,
"etat": "I",
"civilite_str": "Mme",
"nom_disp": "BOUTET",
"nomprenom": "Mme Marguerite BOUTET",
"ne": "e",
"email_default": "MARGUERITE.BOUTET@example.com"
}
]
``` ```
@ -1281,13 +1243,14 @@ d'un nombre quelconque de groupes d'étudiants.
* **Résultat:** Set les groups. * **Résultat:** Set les groups.
### Résultats des évaluations ### Évaluations
* **`evaluations`** * **`evaluations`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `moduleimpl_id` * **Paramètres:** `moduleimpl_id`
* **Routes:** `/evaluations/<int:moduleimpl_id>` * **Routes:** `/evaluations/<int:moduleimpl_id>`
* **Exemple d'utilisation:** `/ScoDoc/api/evaluations/1` * **Exemple d'utilisation:** `/ScoDoc/api/evaluations/1`
* **Résultat:** Retourne la liste des évaluations à partir de l'id d'un moduleimpl * **Résultat:** Retourne la liste des évaluations à partir de l'id d'un
moduleimpl (quel que soit leur statut).
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
[ [
@ -1320,28 +1283,7 @@ d'un nombre quelconque de groupes d'étudiants.
* **Exemple d'utilisation:** `/ScoDoc/api/evaluations/eval_notes/1` * **Exemple d'utilisation:** `/ScoDoc/api/evaluations/eval_notes/1`
* **Résultat:** Retourne la liste des notes à partir de l'id d'une évaluation donnée * **Résultat:** Retourne la liste des notes à partir de l'id d'une évaluation donnée
* **Exemple de résultat:** * **Exemple de résultat:**
``` XXX à revoir (à spécifier)
{
"1": {
"id": 1,
"etudid": 10,
"evaluation_id": 1,
"value": 15,
"comment": "",
"date": "Wed, 20 Apr 2022 06:49:05 GMT",
"uid": 2
},
"2": {
"id": 2,
"etudid": 1,
"evaluation_id": 1,
"value": 12,
"comment": "",
"date": "Wed, 20 Apr 2022 06:49:06 GMT",
"uid": 2
}
}
```
### Absences ### Absences
@ -1358,7 +1300,6 @@ d'un nombre quelconque de groupes d'étudiants.
``` ```
[ [
{ {
"jour": "2022-04-15",
"matin": true, "matin": true,
"estabs": true, "estabs": true,
"estjust": true, "estjust": true,
@ -1367,7 +1308,6 @@ d'un nombre quelconque de groupes d'étudiants.
"end": "2022-04-15 11:59:59" "end": "2022-04-15 11:59:59"
}, },
{ {
"jour": "2022-04-15",
"matin": false, "matin": false,
"estabs": true, "estabs": true,
"estjust": false, "estjust": false,
@ -1388,7 +1328,6 @@ d'un nombre quelconque de groupes d'étudiants.
``` ```
[ [
{ {
"jour": "2022-04-15",
"matin": true, "matin": true,
"estabs": true, "estabs": true,
"estjust": true, "estjust": true,
@ -1397,7 +1336,6 @@ d'un nombre quelconque de groupes d'étudiants.
"end": "2022-04-15 11:59:59" "end": "2022-04-15 11:59:59"
}, },
{ {
"jour": "2022-04-15",
"matin": false, "matin": false,
"estabs": true, "estabs": true,
"estjust": true, "estjust": true,