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

master #21

Closed
leonard.montalbano wants to merge 13 commits from leonard.montalbano/DocScoDoc:master into master
pull from: leonard.montalbano/DocScoDoc:master
merge into: ScoDoc:master
Conversation 0 Commits 13 Files Changed 3 +45 -13
1 changed files with 45 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 63e33c5a7b - Show all commits

56
docs/ScoDoc9API.md
View File

@ -316,7 +316,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
* **`etudiant`** * **`etudiant`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** `/etudiant/etudid/<int:etudid>` ou `/etudiant/nip/<int:nip>` ou `/etudiant/ine/<int:ine>` * **Routes:** `/etudiant/etudid/<int:etudid>` ou `/etudiant/nip/<string:nip>` ou `/etudiant/ine/<string:ine>`
* **Exemple d'utilisation:** `/api/etudiant/nip/1` * **Exemple d'utilisation:** `/api/etudiant/nip/1`
* **Résultat:** Retourne les informations de l'étudiant correspondant à l'id passé en paramètres. (json) * **Résultat:** Retourne les informations de l'étudiant correspondant à l'id passé en paramètres. (json)
* **Exemple de résultat:** * **Exemple de résultat:**
@ -355,7 +355,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
* **`etudiant_formsemestres`** * **`etudiant_formsemestres`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** : `/etudiant/etudid/<int:etudid>/formsemestres` ou `/etudiant/nip/<int:nip>/formsemestres` ou `/etudiant/ine/<int:ine>/formsemestres` * **Routes:** : `/etudiant/etudid/<int:etudid>/formsemestres` ou `/etudiant/nip/<string:nip>/formsemestres` ou `/etudiant/ine/<string:ine>/formsemestres`
* **Exemple d'utilisation:** `/etudiant/ine/1/formsemestres` * **Exemple d'utilisation:** `/etudiant/ine/1/formsemestres`
* **Résultat:** Retourne la liste des semestres qu'un étudiant a suivis, triés par ordre chronologique. (json) * **Résultat:** Retourne la liste des semestres qu'un étudiant a suivis, triés par ordre chronologique. (json)
* **Exemple de résultat:** * **Exemple de résultat:**
@ -402,10 +402,21 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
* **Routes:** * **Routes:**
`/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin` `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin`
ou `/etudiant/nip/<int:nip>/formsemestre/<int:formsemestre_id>/bulletin` ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin`
ou `/etudiant/ine/<int:ine>/formsemestre/<int:formsemestre_id>/bulletin` ou `/etudiant/ine/<string:ine>/formsemestre/<int:formsemestre_id>/bulletin`
ou `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin/pdf`
ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin/pdf`
ou `/etudiant/ine/<string:ine>/formsemestre/<int:formsemestre_id>/bulletin/pdf`
ou `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin/short`
ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin/short`
ou `/etudiant/ine/<string:ine>/formsemestre/<int:formsemestre_id>/bulletin/short`
ou `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin/short/pdf`
ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin/short/pdf`
ou `/etudiant/ine/<string:ine>/formsemestre/<int:formsemestre_id>/bulletin/short/pdf`
* **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin` * **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin`
* **Résultat:** Bulletin de l'étudiant dans le formsemestre. * **Résultat:** Bulletin de l'étudiant dans le formsemestre.
Deux versions disponibles `long` et `short` (par défaut long ajoutez **/short** pour la version plus courte).
Possible de récupérer le pdf en version pdf avec **/pdf** XXX ATTENTION PAS ENCORE DISPONIBLE XXX
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
{ {
@ -582,7 +593,7 @@ Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le
* **`etudiant_groups`** * **`etudiant_groups`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
* **Routes:** `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/nip/<int:nip>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/ine/<int:ine>/semestre/<int:formsemestre_id>/groups` * **Routes:** `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/nip/<string:nip>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/ine/<string:ine>/semestre/<int:formsemestre_id>/groups`
* **Exemple d'utilisation:** `/etudiant/nip/1/semestre/1/groups` * **Exemple d'utilisation:** `/etudiant/nip/1/semestre/1/groups`
* **Résultat:** Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json) * **Résultat:** Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json)
* **Exemple de résultat:** * **Exemple de résultat:**
@ -1341,9 +1352,9 @@ d'un nombre quelconque de groupes d'étudiants.
* **`absences`** * **`absences`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`
* **Routes:** `/absences/etudid/<int:etudid>` ou `/absences/nip/<int:nip>` ou `/absences/ine/<int:ine>` * **Routes:** `/absences/etudid/<int:etudid>`
* **Exemple d'utilisation:** `/ScoDoc/api/absences/ine/1` * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1`
* **Résultat:** Retourne la liste des absences d'un étudiant donné * **Résultat:** Retourne la liste des absences d'un étudiant donné
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
@ -1371,9 +1382,9 @@ d'un nombre quelconque de groupes d'étudiants.
* **`absences_just`** * **`absences_just`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`
* **Routes:** `/absences/etudid/<int:etudid>/just` ou `/absences/nip/<int:nip>/just` ou `/absences/ine/<int:ine>/just` * **Routes:** `/absences/etudid/<int:etudid>/just`
* **Exemple d'utilisation:** `/ScoDoc/api/absences/ine/1/just` * **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1/just`
* **Résultat:** Retourne la liste des absences justifiées d'un étudiant donné * **Résultat:** Retourne la liste des absences justifiées d'un étudiant donné
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
@ -1400,7 +1411,7 @@ d'un nombre quelconque de groupes d'étudiants.
``` ```
* **`abs_groupe_etat`** * **`abs_groupe_etat`** **NON IMPLEMENTE**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `group_id`, `date_debut`, `date_fin` (dates au format ISO) * **Paramètres:** `group_id`, `date_debut`, `date_fin` (dates au format ISO)
* **Routes:** `/absences/abs_group_etat/<int:group_id>` ou `/absences/abs_group_etat/group_id/<in:group_id>/date_debut/<string:date_debut>/date_fin/<string:date_fin>` * **Routes:** `/absences/abs_group_etat/<int:group_id>` ou `/absences/abs_group_etat/group_id/<in:group_id>/date_debut/<string:date_debut>/date_fin/<string:date_fin>`
@ -1440,6 +1451,27 @@ d'un nombre quelconque de groupes d'étudiants.
] ]
``` ```
* **`reset_etud_abs`** **NON IMPLEMENTE**
* **Méthode:** POST
* **Paramètres:** `etudid`, `list_abs`
* **Routes:** `/absences/etudid/<int:etudid>/list_abs/<str:list_abs>/reset_etud_abs` ou `/absences/etudid/<int:etudid>/list_abs/<str:list_abs>/reset_etud_abs/only_not_just` ou `/absences/etudid/<int:etudid>/list_abs/<str:list_abs>/reset_etud_abs/only_just`
* **Exemple {LIST_ABS} json:**
```
[
{
"matin": true,
"estabs": true,
"estjust": true,
"description": "",
"begin": "2022-04-15 08:00:00",
"end": "2022-04-15 11:59:59"
},
...
]
```
* **Exemple d'utilisation:** `/ScoDoc/api/absences/etudid/1/list_abs/{LIST_ABS}reset_etud_abs`
* **Résultat:** Set la liste des absences d'un étudiant sur tout un semestre. (les absences existant pour cet étudiant sur cette période sont effacées)
### Jury ### Jury