leonard.montalbano
/
DocScoDoc
forked from ScoDoc/DocScoDoc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

mise à jour de la doc api au 14/06/2022

This commit is contained in:
leonard_montalbano 2022-06-14 16:25:48 +02:00
parent 882e7c5ed8
commit 39baf0241d
1 changed files with 52 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
docs/ScoDoc9API.md
View File

@ -351,6 +351,50 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
}
```
* **`etudiants`**
* **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** `/etudiants/etudid/<int:etudid>` ou `/etudiants/nip/<string:nip>` ou `/etudiants/ine/<string:ine>`
* **Exemple d'utilisation:** `/api/etudiants/nip/1`
* **Résultat:** Info sur le ou les étudiants correspondant. Comme /etudiant mais renvoie
toujours une liste.
Si non trouvé, liste vide, pas d'erreur.
Dans 99% des cas, la liste contient un seul étudiant, mais si l'étudiant a
été inscrit dans plusieurs départements, on a plusieurs objets (1 par dept.).
* **Exemple de résultat:**
```
[
{
"civilite": "X",
"code_ine": "1",
"code_nip": "1",
"date_naissance": "",
"dept_id": 1,
"dept_acronym": "TAPI",
"email": "SACHA.COSTA@example.com",
"emailperso": "",
"etudid": 1,
"nom": "COSTA",
"prenom": "SACHA",
"nomprenom": "Sacha COSTA",
"lieu_naissance": "",
"dept_naissance": "",
"nationalite": "",
"boursier": "",
"id": 1,
"codepostaldomicile": "",
"paysdomicile": "",
"telephonemobile": "",
"typeadresse": "domicile",
"domicile": "",
"villedomicile": "",
"telephone": "",
"fax": "",
"description": ""
}
]
```
#### Cursus
* **`etudiant_formsemestres`**
* **Méthode:** GET
@ -1062,7 +1106,7 @@ informations suivantes:
]
```
* **etat_evals** (**Attente de tests unitaires**)
* **etat_evals**
* **Méthode:** GET
* **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/etat_evals`
@ -1088,15 +1132,15 @@ informations suivantes:
"ATT": 0,
"EXC": 0,
"saisie_notes": {
"datetime_debut": "Wed, 01 Jun 2022 10:37:59 GMT",
"datetime_fin": "Wed, 01 Jun 2022 13:18:09 GMT",
"datetime_mediane": "Wed, 01 Jun 2022 12:38:57 GMT"
"datetime_debut": "2021-09-11T00:00:00+02:00",
"datetime_fin": "2022-08-25T00:00:00+02:00",
"datetime_mediane": "2022-03-19T00:00:00+01:00"
}
},
{
"id": 22,
"description": null,
"datetime_epreuve": "Tue, 31 May 2022 00:00:00 GMT",
"datetime_epreuve": "2021-08-11T00:00:00+02:00",
"heure_fin": "08:00:00",
"comptee": "oui",
"inscrits": 16,
@ -1105,9 +1149,9 @@ informations suivantes:
"ATT": 0,
"EXC": 0,
"saisie_notes": {
"datetime_debut": "Wed, 01 Jun 2022 12:04:19 GMT",
"datetime_fin": "Wed, 01 Jun 2022 12:04:36 GMT",
"datetime_mediane": "Wed, 01 Jun 2022 14:04:27 GMT"
"datetime_debut": "2021-09-11T00:00:00+02:00",
"datetime_fin": "2022-08-25T00:00:00+02:00",
"datetime_mediane": "2022-03-19T00:00:00+01:00"
}
},
]