From 447d6549287cca2d5e433a9182c4275412511b00 Mon Sep 17 00:00:00 2001 From: Hartmann Matthias <49349614+Iziram@users.noreply.github.com> Date: Wed, 15 Feb 2023 10:30:37 +0100 Subject: [PATCH] =?UTF-8?q?samples=20assiduit=C3=A9s=20justificatifs=20:?= =?UTF-8?q?=20d=C3=A9but?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/ScoDoc9API.md | 23 ++++--- docs/samples/sample_assiduite.json.md | 16 +++++ docs/samples/sample_assiduite_create.json.md | 18 +++++ docs/samples/sample_assiduite_delete.json.md | 23 +++++++ docs/samples/sample_assiduite_edit.json.md | 35 ++++++++++ docs/samples/sample_assiduites.json.md | 63 ++++++++++++++++++ docs/samples/sample_assiduites_count.json.md | 30 +++++++++ .../sample_assiduites_formsemestre.json.md | 23 +++++++ ...mple_assiduites_formsemestre_count.json.md | 30 +++++++++ docs/samples/sample_justificatif.json.md | 16 +++++ .../sample_justificatif_create.json.md | 18 +++++ .../sample_justificatif_delete.json.md | 23 +++++++ docs/samples/sample_justificatif_edit.json.md | 24 +++++++ docs/samples/sample_justificatifs.json.md | 26 ++++++++ docs/samples/samples.tar | Bin 0 -> 20480 bytes 15 files changed, 357 insertions(+), 11 deletions(-) create mode 100644 docs/samples/sample_assiduite.json.md create mode 100644 docs/samples/sample_assiduite_create.json.md create mode 100644 docs/samples/sample_assiduite_delete.json.md create mode 100644 docs/samples/sample_assiduite_edit.json.md create mode 100644 docs/samples/sample_assiduites.json.md create mode 100644 docs/samples/sample_assiduites_count.json.md create mode 100644 docs/samples/sample_assiduites_formsemestre.json.md create mode 100644 docs/samples/sample_assiduites_formsemestre_count.json.md create mode 100644 docs/samples/sample_justificatif.json.md create mode 100644 docs/samples/sample_justificatif_create.json.md create mode 100644 docs/samples/sample_justificatif_delete.json.md create mode 100644 docs/samples/sample_justificatif_edit.json.md create mode 100644 docs/samples/sample_justificatifs.json.md create mode 100644 docs/samples/samples.tar diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 93d0f0c3d..7c23dff3e 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -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": , - "moduleimpl_id": + "moduleimpl_id": , + "desc" : } ``` @@ -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//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//export/` * **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//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//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//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) --------------------------------------------------------------------------------------------------------------------- diff --git a/docs/samples/sample_assiduite.json.md b/docs/samples/sample_assiduite.json.md new file mode 100644 index 000000000..3fcb2ae37 --- /dev/null +++ b/docs/samples/sample_assiduite.json.md @@ -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 +} +``` + diff --git a/docs/samples/sample_assiduite_create.json.md b/docs/samples/sample_assiduite_create.json.md new file mode 100644 index 000000000..a7b1f5787 --- /dev/null +++ b/docs/samples/sample_assiduite_create.json.md @@ -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 + } + } +} +``` + diff --git a/docs/samples/sample_assiduite_delete.json.md b/docs/samples/sample_assiduite_delete.json.md new file mode 100644 index 000000000..48738dafd --- /dev/null +++ b/docs/samples/sample_assiduite_delete.json.md @@ -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 + } + } +} +``` + diff --git a/docs/samples/sample_assiduite_edit.json.md b/docs/samples/sample_assiduite_edit.json.md new file mode 100644 index 000000000..a7b9162c4 --- /dev/null +++ b/docs/samples/sample_assiduite_edit.json.md @@ -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 +} +``` + diff --git a/docs/samples/sample_assiduites.json.md b/docs/samples/sample_assiduites.json.md new file mode 100644 index 000000000..552887d97 --- /dev/null +++ b/docs/samples/sample_assiduites.json.md @@ -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 +[ + "..." +] +``` + diff --git a/docs/samples/sample_assiduites_count.json.md b/docs/samples/sample_assiduites_count.json.md new file mode 100644 index 000000000..bd95f2b74 --- /dev/null +++ b/docs/samples/sample_assiduites_count.json.md @@ -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 +} +``` + diff --git a/docs/samples/sample_assiduites_formsemestre.json.md b/docs/samples/sample_assiduites_formsemestre.json.md new file mode 100644 index 000000000..dfa44f55b --- /dev/null +++ b/docs/samples/sample_assiduites_formsemestre.json.md @@ -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 +[ + "..." +] +``` + diff --git a/docs/samples/sample_assiduites_formsemestre_count.json.md b/docs/samples/sample_assiduites_formsemestre_count.json.md new file mode 100644 index 000000000..14dde74c4 --- /dev/null +++ b/docs/samples/sample_assiduites_formsemestre_count.json.md @@ -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 +} +``` + diff --git a/docs/samples/sample_justificatif.json.md b/docs/samples/sample_justificatif.json.md new file mode 100644 index 000000000..452926c50 --- /dev/null +++ b/docs/samples/sample_justificatif.json.md @@ -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" +} +``` + diff --git a/docs/samples/sample_justificatif_create.json.md b/docs/samples/sample_justificatif_create.json.md new file mode 100644 index 000000000..80853445a --- /dev/null +++ b/docs/samples/sample_justificatif_create.json.md @@ -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 + } + } +} +``` + diff --git a/docs/samples/sample_justificatif_delete.json.md b/docs/samples/sample_justificatif_delete.json.md new file mode 100644 index 000000000..52bff41ed --- /dev/null +++ b/docs/samples/sample_justificatif_delete.json.md @@ -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 + } + } +} +``` + diff --git a/docs/samples/sample_justificatif_edit.json.md b/docs/samples/sample_justificatif_edit.json.md new file mode 100644 index 000000000..5946ad10d --- /dev/null +++ b/docs/samples/sample_justificatif_edit.json.md @@ -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 +} +``` + diff --git a/docs/samples/sample_justificatifs.json.md b/docs/samples/sample_justificatifs.json.md new file mode 100644 index 000000000..3873f60ee --- /dev/null +++ b/docs/samples/sample_justificatifs.json.md @@ -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 +[ + "..." +] +``` + diff --git a/docs/samples/samples.tar b/docs/samples/samples.tar new file mode 100644 index 0000000000000000000000000000000000000000..49426883d9784e07d8c7bc5652fdc35488b79eaf GIT binary patch literal 20480 zcmeHO+iu%95cRXZLQsHxS;rkQA#a5xF=)n_vF)1lW%7=qdEqqm?`8;{(XYG>ifH z1FZ=x{-ssGFw6lobW4W_niJBF{GNb;3i_D5X^c3G>_Alqq2s&0Q{TF&zP{%VU2}19 zp^Cy+6jFMjet7?JrjGNoMIp3(|zP zdU(-XvYF;C{v1czwW=Y2&?N+y$eMwxYXG!i(%{is3)K)L)i|kidX?_255`?krn0dHuqdoYl6Ib%f4-uEuBnJ zerORMw75{@zl)dn)chx$7x_`}l5N+S=YJyn8vdu1?b(lpXsGWbY|b|gQvTm& zR!Cj@YZd?R5#3DmjFymbPjbKiiwqeBG0rDR)dQnGDrJb7|M!w&_r@ImQ|kXQ z<^6uq;TGIxm>T8^S07wmA~1u9`10guL^lEezXJNK6?+x^|2BPa=n(t8j+e`H6mm8Q zp67H0)Q@1tj27c$8tTLS^yBp1EL#$eVwW8VvNsb*tX`eZxj^K9ICuPb-LD5gg}&?j zZ$cpY|0aae|L@M~_B}cNr^2sP10g;C)2$(D1IJ%&810OV(Rk$%7V7Ea7aRwamF5Vf zB~N}FtT8P!G9ocE&+DCh!tsAG4xWFfWWCu0n8pEyiBIv%3P*wG+$2jFvY8r}S6I)! zvnR9G&XB#a+a3TtTS9w@_1m({|3^Pqg?NR-C?L_mK9oTt|1H7)N6>)s{NJyjYep0J zUlx9iGAK4|)C?K%Q(|O~854AFBuBhtN! zck{oW(?Apd4S;z2kH|fNF75wbg6!CM2mf0!KR1RCELNtCMk7u6L`z$BFOpVZ%0UBi z9{Ua4waSjbok_P6|NEglhfV|kk!cA0hZBPw31s}AL-9BdJpXGrEAr>{8cnN?1+Wl% zr+C0?&;4QoNk1_zz)CyC29loX0M`X{OVeV*Pi{0*YwX5$-t+D0#mm z2M8iYXsX?QiX5OS{`Z{%)X0BRi2p$g88ZIQ6ZJ?>CH_~W0CD_3eiqQ51zW@=0?9m} z{x?At|NBk>YUDpE-Tzt8koLcSX_rSV@xPP;#Ie6?7LfMUUV1Ju-1}wT95{Didn8X- zyVm}h-o1U(YVtBd=Ur04|K1~jP5hq#osa*+i6!sL?V`-S$jP650;{qW!0zu(?XYjbgo6+jdJEg<^;Ca~oB|40(&hZXrB)+qpzj+1ME2X;m-ga}U`weF-7Sj;j@ z`s4IMT2m3zuhI{!b%l;#