forked from ScoDoc/DocScoDoc
samples assiduités justificatifs : début
This commit is contained in:
parent
0c171ae072
commit
447d654928
@ -1409,7 +1409,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* `/api/assiduites/1/count/query?moduleimpl_id=1`
|
||||
* `/api/assiduites/1/count/query?etat=present,retard&metric=compte,heure`
|
||||
* **Résultat:** les métriques obtenu à partir des assiduitées correspondant aux critères sélectionnés
|
||||
* **Exemple de résultat:** [assiduites.json](samples/sample_assiduites.json.md)
|
||||
* **Exemple de résultat:** [assiduites-count.json](samples/sample_assiduites_count.json.md)
|
||||
|
||||
#### **assiduites-formsemestre[-query]**
|
||||
|
||||
@ -1449,7 +1449,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* `/api/assiduites/formsemestre/1/count/query?etat=retard`
|
||||
* `/api/assiduites/formsemestre/1/count/query?moduleimpl=1&metric=demi,journee`
|
||||
* **Résultat:** les métriques obtenu à partir des assiduitées de tous les étudiants du formsemestre correspondant aux critères sélectionnés
|
||||
* **Exemple de résultat:** [assiduites_formsemestre.json](samples/sample_assiduites_formsemestre.json.md)
|
||||
* **Exemple de résultat:** [assiduites_formsemestre-count.json](samples/sample_assiduites_formsemestre_count.json.md)
|
||||
|
||||
#### **assiduite-create**
|
||||
|
||||
@ -1489,7 +1489,8 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
```json
|
||||
{
|
||||
"etat": <string>,
|
||||
"moduleimpl_id": <int>
|
||||
"moduleimpl_id": <int>,
|
||||
"desc" : <string>
|
||||
}
|
||||
```
|
||||
|
||||
@ -1601,7 +1602,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
```
|
||||
|
||||
* **Résultat:** Retourne un objet en deux partie (errors et success) contenant le retour de chaque objet donné dans la requête post.
|
||||
* **Exemple de résultat:** [justificatif-create.json](samples/sample_justificatif-create.json.md)
|
||||
* **Exemple de résultat:** [justificatif-create.json](samples/sample_justificatif_create.json.md)
|
||||
|
||||
#### **justificatif-edit**
|
||||
|
||||
@ -1625,7 +1626,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
> `{etat: "valide"}`
|
||||
|
||||
* **Résultat:** Modifie le justificatif désignée.
|
||||
* **Exemple de résultat:** [justificatif-edit.json](samples/sample_justificatif-edit.json.md)
|
||||
* **Exemple de résultat:** [justificatif-edit.json](samples/sample_justificatif_edit.json.md)
|
||||
|
||||
#### **justificatif-delete**
|
||||
|
||||
@ -1651,7 +1652,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
```
|
||||
|
||||
* **Résultat:** Retourne un objet en deux partie (errors et success) contenant le retour de chaque objet donné dans la requête post.
|
||||
* **Exemple de résultat:** [justificatif-delete.json](samples/sample_justificatif-delete.json.md)
|
||||
* **Exemple de résultat:** [justificatif-delete.json](samples/sample_justificatif_delete.json.md)
|
||||
|
||||
#### **justificatif-import**
|
||||
|
||||
@ -1664,7 +1665,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* **Routes:** `/justificatif/<int:justif_id>/import`
|
||||
|
||||
* **Résultat:** Le nom du fichier archivé (nom coté serveur)
|
||||
* **Exemple de résultat:** [justificatif-import.json](samples/sample_justificatif-import.json.md)
|
||||
* **Exemple de résultat:** [justificatif-import.json](samples/sample_justificatif_import.json.md)
|
||||
|
||||
#### **justificatif-export**
|
||||
|
||||
@ -1679,7 +1680,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* **Routes:** `/justificatif/<int:justif_id>/export/<str:filename>`
|
||||
|
||||
* **Résultat:** le fichier (téléchargement direct / renvoie octets)
|
||||
* **Exemple de résultat:** [justificatif-export.json](samples/sample_justificatif-export.json.md)
|
||||
* **Exemple de résultat:** [justificatif-export.json](samples/sample_justificatif_export.json.md)
|
||||
|
||||
#### **justificatif-remove**
|
||||
|
||||
@ -1692,7 +1693,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* **Routes:** `/justificatif/<int:justif_id>/remove`
|
||||
|
||||
* **Résultat:** `{response:"removed"}` ou une erreur
|
||||
* **Exemple de résultat:** [justificatif-remove.json](samples/sample_justificatif-remove.json.md)
|
||||
* **Exemple de résultat:** [justificatif-remove.json](samples/sample_justificatif_remove.json.md)
|
||||
|
||||
#### **justificatif-list**
|
||||
|
||||
@ -1702,7 +1703,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* **Routes:** `/justificatif/<int:justif_id>/list`
|
||||
* **Exemple d'utilisation:** `/api/justificatif/1/list`
|
||||
* **Résultat:** Retourne la liste des fichiers archivés une erreur si l'id n'est pas connu
|
||||
* **Exemple de résultat:** [justificatif-list.json](samples/sample_justificatif-list.json.md)
|
||||
* **Exemple de résultat:** [justificatif-list.json](samples/sample_justificatif_list.json.md)
|
||||
|
||||
#### **justificatif-justifies**
|
||||
|
||||
@ -1712,7 +1713,7 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`.
|
||||
* **Routes:** `/justificatif/<int:justif_id>/justifies`
|
||||
* **Exemple d'utilisation:** `/api/justificatif/1/justifies`
|
||||
* **Résultat:** Retourne la liste des assiduite_id qui sont justifiés par le justificatif ou une erreur si l'id n'est pas connu
|
||||
* **Exemple de résultat:** [justificatif-justifies.json](samples/sample_justificatif-justifies.json.md)
|
||||
* **Exemple de résultat:** [justificatif-justifies.json](samples/sample_justificatif_justifies.json.md)
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
|
16
docs/samples/sample_assiduite.json.md
Normal file
16
docs/samples/sample_assiduite.json.md
Normal file
@ -0,0 +1,16 @@
|
||||
### assiduite
|
||||
|
||||
#### GET /assiduite/1
|
||||
```json
|
||||
{
|
||||
"assiduite_id": 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",
|
||||
"etat": "PRESENT",
|
||||
"etudid": 1,
|
||||
"moduleimpl_id": 8
|
||||
}
|
||||
```
|
||||
|
18
docs/samples/sample_assiduite_create.json.md
Normal file
18
docs/samples/sample_assiduite_create.json.md
Normal file
@ -0,0 +1,18 @@
|
||||
### assiduite_create
|
||||
|
||||
#### POST /assiduite/1/create
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "absent"}]`
|
||||
|
||||
```json
|
||||
{
|
||||
"errors": {},
|
||||
"success": {
|
||||
"0": {
|
||||
"assiduite_id": 60
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
23
docs/samples/sample_assiduite_delete.json.md
Normal file
23
docs/samples/sample_assiduite_delete.json.md
Normal file
@ -0,0 +1,23 @@
|
||||
### assiduite_delete
|
||||
|
||||
#### POST /assiduite/delete
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `[2,2,3]`
|
||||
|
||||
```json
|
||||
{
|
||||
"errors": {
|
||||
"1": "Assiduite non existante"
|
||||
},
|
||||
"success": {
|
||||
"0": {
|
||||
"OK": true
|
||||
},
|
||||
"2": {
|
||||
"OK": true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
35
docs/samples/sample_assiduite_edit.json.md
Normal file
35
docs/samples/sample_assiduite_edit.json.md
Normal file
@ -0,0 +1,35 @@
|
||||
### assiduite_edit
|
||||
|
||||
#### POST /assiduite/1/edit
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `{"etat": "retard","moduleimpl_id":3}`
|
||||
|
||||
```json
|
||||
{
|
||||
"OK": true
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /assiduite/1/edit
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `{"etat":"absent"}`
|
||||
|
||||
```json
|
||||
{
|
||||
"OK": true
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /assiduite/1/edit
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `{"moduleimpl_id":2}`
|
||||
|
||||
```json
|
||||
{
|
||||
"OK": true
|
||||
}
|
||||
```
|
||||
|
63
docs/samples/sample_assiduites.json.md
Normal file
63
docs/samples/sample_assiduites.json.md
Normal file
@ -0,0 +1,63 @@
|
||||
### assiduites
|
||||
|
||||
#### GET /assiduites/1
|
||||
```json
|
||||
[
|
||||
{
|
||||
"assiduite_id": 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",
|
||||
"etat": "PRESENT",
|
||||
"etudid": 1,
|
||||
"moduleimpl_id": 8
|
||||
},
|
||||
{
|
||||
"assiduite_id": 2,
|
||||
"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",
|
||||
"etat": "RETARD",
|
||||
"etudid": 1,
|
||||
"moduleimpl_id": 13
|
||||
},
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
||||
#### GET /assiduites/1/query?etat=retard
|
||||
```json
|
||||
[
|
||||
{
|
||||
"assiduite_id": 2,
|
||||
"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",
|
||||
"etat": "RETARD",
|
||||
"etudid": 1,
|
||||
"moduleimpl_id": 13
|
||||
},
|
||||
{
|
||||
"assiduite_id": 3,
|
||||
"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",
|
||||
"etat": "RETARD",
|
||||
"etudid": 1,
|
||||
"moduleimpl_id": 14
|
||||
},
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
||||
#### GET /assiduites/1/query?moduleimpl_id=1
|
||||
```json
|
||||
[
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
30
docs/samples/sample_assiduites_count.json.md
Normal file
30
docs/samples/sample_assiduites_count.json.md
Normal file
@ -0,0 +1,30 @@
|
||||
### assiduites_count
|
||||
|
||||
#### GET /assiduites/1/count
|
||||
```json
|
||||
{
|
||||
"compte": 4,
|
||||
"demi": 3,
|
||||
"heure": 6.0,
|
||||
"journee": 4
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /assiduites/1/count/query?etat=present,retard&metric=compte,heure
|
||||
```json
|
||||
{
|
||||
"compte": 4,
|
||||
"heure": 6.0
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /assiduites/1/count/query?etat=retard
|
||||
```json
|
||||
{
|
||||
"compte": 3,
|
||||
"demi": 3,
|
||||
"heure": 6.0,
|
||||
"journee": 3
|
||||
}
|
||||
```
|
||||
|
23
docs/samples/sample_assiduites_formsemestre.json.md
Normal file
23
docs/samples/sample_assiduites_formsemestre.json.md
Normal file
@ -0,0 +1,23 @@
|
||||
### assiduites_formsemestre
|
||||
|
||||
#### GET /assiduites/formsemestre/1
|
||||
```json
|
||||
[
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
||||
#### GET /assiduites/formsemestre/1/query?etat=retard
|
||||
```json
|
||||
[
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
||||
#### GET /assiduites/formsemestre/1/query?moduleimpl_id=1
|
||||
```json
|
||||
[
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
30
docs/samples/sample_assiduites_formsemestre_count.json.md
Normal file
30
docs/samples/sample_assiduites_formsemestre_count.json.md
Normal file
@ -0,0 +1,30 @@
|
||||
### assiduites_formsemestre_count
|
||||
|
||||
#### GET /assiduites/formsemestre/1/count
|
||||
```json
|
||||
{
|
||||
"compte": 0,
|
||||
"demi": 0,
|
||||
"heure": 0.0,
|
||||
"journee": 0
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /assiduites/formsemestre/1/count/query?etat=present,retard&metric=compte,heure
|
||||
```json
|
||||
{
|
||||
"compte": 0,
|
||||
"heure": 0.0
|
||||
}
|
||||
```
|
||||
|
||||
#### GET /assiduites/formsemestre/1/count/query?etat=retard
|
||||
```json
|
||||
{
|
||||
"compte": 0,
|
||||
"demi": 0,
|
||||
"heure": 0.0,
|
||||
"journee": 0
|
||||
}
|
||||
```
|
||||
|
16
docs/samples/sample_justificatif.json.md
Normal file
16
docs/samples/sample_justificatif.json.md
Normal file
@ -0,0 +1,16 @@
|
||||
### justificatif
|
||||
|
||||
#### GET /justificatif/1
|
||||
```json
|
||||
{
|
||||
"date_debut": "2022-08-20T12:00:00.000000+02:00",
|
||||
"date_fin": "2022-08-20T12:00:00.000000+02:00",
|
||||
"entry_date": "2022-08-20T12:00:00.000000+02:00",
|
||||
"etat": "VALIDE",
|
||||
"etudid": 1,
|
||||
"fichier": null,
|
||||
"justif_id": 1,
|
||||
"raison": "raison"
|
||||
}
|
||||
```
|
||||
|
18
docs/samples/sample_justificatif_create.json.md
Normal file
18
docs/samples/sample_justificatif_create.json.md
Normal file
@ -0,0 +1,18 @@
|
||||
### justificatif_create
|
||||
|
||||
#### POST /justificatif/1/create
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "attente"}]`
|
||||
|
||||
```json
|
||||
{
|
||||
"errors": {},
|
||||
"success": {
|
||||
"0": {
|
||||
"justif_id": 12
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
23
docs/samples/sample_justificatif_delete.json.md
Normal file
23
docs/samples/sample_justificatif_delete.json.md
Normal file
@ -0,0 +1,23 @@
|
||||
### justificatif_delete
|
||||
|
||||
#### POST /justificatif/delete
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `[2,2,3]`
|
||||
|
||||
```json
|
||||
{
|
||||
"errors": {
|
||||
"1": "Justificatif non existant"
|
||||
},
|
||||
"success": {
|
||||
"0": {
|
||||
"OK": true
|
||||
},
|
||||
"2": {
|
||||
"OK": true
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
24
docs/samples/sample_justificatif_edit.json.md
Normal file
24
docs/samples/sample_justificatif_edit.json.md
Normal file
@ -0,0 +1,24 @@
|
||||
### justificatif_edit
|
||||
|
||||
#### POST /justificatif/1/edit
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `{"etat":"valide"}`
|
||||
|
||||
```json
|
||||
{
|
||||
"OK": true
|
||||
}
|
||||
```
|
||||
|
||||
#### POST /justificatif/1/edit
|
||||
> `Content-Type: application/json`
|
||||
>
|
||||
> `{"raison":"MEDIC"}`
|
||||
|
||||
```json
|
||||
{
|
||||
"OK": true
|
||||
}
|
||||
```
|
||||
|
26
docs/samples/sample_justificatifs.json.md
Normal file
26
docs/samples/sample_justificatifs.json.md
Normal file
@ -0,0 +1,26 @@
|
||||
### justificatifs
|
||||
|
||||
#### GET /justificatifs/1
|
||||
```json
|
||||
[
|
||||
{
|
||||
"date_debut": "2022-08-20T12:00:00.000000+02:00",
|
||||
"date_fin": "2022-08-20T12:00:00.000000+02:00",
|
||||
"entry_date": "2022-08-20T12:00:00.000000+02:00",
|
||||
"etat": "VALIDE",
|
||||
"etudid": 1,
|
||||
"fichier": null,
|
||||
"justif_id": 1,
|
||||
"raison": "raison"
|
||||
},
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
||||
#### GET /justificatifs/1/query?etat=attente
|
||||
```json
|
||||
[
|
||||
"..."
|
||||
]
|
||||
```
|
||||
|
BIN
docs/samples/samples.tar
Normal file
BIN
docs/samples/samples.tar
Normal file
Binary file not shown.
Loading…
Reference in New Issue
Block a user