Assiduité : Nouvelles documentations #65

Merged
viennet merged 5 commits from iziram/DocAssiduites:modif into master 2024-06-26 16:42:49 +02:00
4 changed files with 85 additions and 2 deletions
Showing only changes of commit 7a6381082e - Show all commits

View File

@ -750,6 +750,15 @@ Note: les poids ne sont utilisés que dans les formations APC (BUT).
* **Résultat:** Liste une évaluation
* **Exemple de résultat:** [evaluation.json](samples/sample_evaluation.json.md)
#### **`evaluation-assiduites`**
* **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** `/evaluation/<int:evaluation_id>/assiduites`
* **Exemple d'utilisation:** `/ScoDoc/api/evaluation/123/assiduites`
* **Résultat:** La liste des assiduités de chaque étudiant inscrits à l'évaluation sur la plage de l'évaluation (Groupé par etudid)
* **Exemple de résultat:** [evaluation-assiduites.json](samples/sample_evaluation_assiduites.json.md)
#### **`evaluation-create`**
* **Méthode: POST**
@ -1735,7 +1744,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
* **Exemple d'utilisation:** `/api/assiduite/1`
* **Résultat:** Retourne un objet assiduité ou une erreur si l'id n'est pas connu
* **Exemple de résultat:** [assiduite.json](samples/sample_assiduite.json.md)
*
#### **assiduite-justificatifs[-long]**
* **Méthode:** GET
@ -1785,6 +1794,25 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences.
* **Résultat:** Liste de toutes les objets assiduité qui correspondent aux critères sélectionnés
* **Exemple de résultat:** [assiduites.json](samples/sample_assiduites.json.md)
#### **assiduites-evaluations**
* **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:**
* `etudid`
* `nip`
* `ine`
* **Routes:**
* `/assiduites/<int:etudid>/evaluations`
* `/assiduites/etudid/<int:etudid>/evaluations`
* `/assiduites/nip/<nip>/evaluations`
* `/assiduites/ine/<ine>/evaluations`
* **Exemple d'utilisation:**
* `/api/assiduites/1/evaluations`
* **Résultat:** Retourne toutes les assiduités liés à des évaluations. (organisé par évaluations)
* **Exemple de résultat:** [assiduites-evaluations.json](samples/sample_assiduites_evaluations.json.md)
#### **assiduites-count[-query]**
* **Méthode:** GET

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 865 KiB

After

Width:  |  Height:  |  Size: 872 KiB

View File

@ -0,0 +1,29 @@
### assiduites-evaluations
#### GET /assiduites/1/evaluations
```json
[
{
"evaluation_id": 1234,
"assiduites": [
{
"assiduite_id": 1,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
]
}
]
```

View File

@ -0,0 +1,26 @@
### evaluation-assiduites
#### GET /evaluation/1/assiduites
```json
{
"1" : [
{
"assiduite_id": 1,
"code_nip": "1",
"date_debut": "2022-08-20T12:00:00.000000+02:00",
"date_fin": "2022-08-20T12:00:00.000000+02:00",
"desc": null,
"entry_date": "2022-08-20T12:00:00.000000+02:00",
"est_just": false,
"etat": "PRESENT",
"etudid": 1,
"external_data": null,
"moduleimpl_id": 12,
"user_id": null,
"user_name": null,
"user_nom_complet": null
},
]
}
```