From 58e3ee950056918646909298cd8ceadf04a53c9d Mon Sep 17 00:00:00 2001 From: Iziram Date: Fri, 29 Mar 2024 16:37:43 +0100 Subject: [PATCH] =?UTF-8?q?Assiduit=C3=A9=20:=20Docs=20:=20erratum=20+=20o?= =?UTF-8?q?ublie=20samples?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/ScoDoc9API.md | 27 ++++++----- ...=> sample_assiduite_justificatifs.json.md} | 2 +- .../samples/sample_justificatifs_dept.json.md | 47 +++++++++++++++++++ .../sample_justificatifs_formsemestre.json.md | 39 +++++++++++++++ 4 files changed, 102 insertions(+), 13 deletions(-) rename docs/samples/{sample_assiduites_justificatifs.json.md => sample_assiduite_justificatifs.json.md} (95%) create mode 100644 docs/samples/sample_justificatifs_dept.json.md create mode 100644 docs/samples/sample_justificatifs_formsemestre.json.md diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index dcc7daa63..b910e6880 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1898,6 +1898,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. etudid3 : [{assiduité...}], } ``` +* **Exemple de résultat:** [assiduites-group.json](samples/sample_assiduites_group.json.md) #### **assiduites-create** @@ -1924,6 +1925,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. > `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "absent","etudid":1}]` * **Résultat:** Retourne un objet en deux parties (errors et success) contenant le retour de chaque objet donné dans la requête POST. +* **Exemple de résultat:** [assiduites-create.json](samples/sample_assiduites_create.json.md) #### **assiduite-create** @@ -2032,18 +2034,19 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### Structure Justificatif -| attribut | type | commentaire | -| :----------- | :------------- | :------------------------------------------------------------ | -| *justif_id* | int | identifiant unique | -| *etudid* | int | identifiant unique de l'étudiant concerné par le justificatif | -| *date_debut* | string | date ISO du début de la période du justificatif | -| *date_fin* | string | date ISO de la fin de la période du justificatif | -| *etat* | string | état du justificatif ( attente, valide, non_valide, modifie) | -| *raison* | string ou null | explication du justificatif si présente | -| *fichier* | string | identifiant de l'archivage des fichiers | -| *user_id* | int or null | id de l'utilisateur ayant créé le justificatif | -| *user_name* | str ou null | login de l'utilisateur ayant créé le justificatif | -| *entry_date* | string | date ISO de l'entrée du justificatif | +| attribut | type | commentaire | +| :-------------- | :------------- | :------------------------------------------------------------ | +| *justif_id* | int | identifiant unique | +| *etudid* | int | identifiant unique de l'étudiant concerné par le justificatif | +| *date_debut* | string | date ISO du début de la période du justificatif | +| *date_fin* | string | date ISO de la fin de la période du justificatif | +| *etat* | string | état du justificatif ( attente, valide, non_valide, modifie) | +| *raison* | string ou null | explication du justificatif si présente | +| *fichier* | string | identifiant de l'archivage des fichiers | +| *user_id* | int or null | id de l'utilisateur ayant créé le justificatif | +| *user_name* | str ou null | login de l'utilisateur ayant créé le justificatif | +| *entry_date* | string | date ISO de l'entrée du justificatif | +| *external_data* | objet ou null | un objet décrivant des actions non utilisée par ScoDoc | #### **justificatif** diff --git a/docs/samples/sample_assiduites_justificatifs.json.md b/docs/samples/sample_assiduite_justificatifs.json.md similarity index 95% rename from docs/samples/sample_assiduites_justificatifs.json.md rename to docs/samples/sample_assiduite_justificatifs.json.md index 16b83c970..15532f251 100644 --- a/docs/samples/sample_assiduites_justificatifs.json.md +++ b/docs/samples/sample_assiduite_justificatifs.json.md @@ -1,4 +1,4 @@ -### assiduites_justificatifs +### assiduite_justificatifs #### GET /assiduite/1/justificatifs ```json diff --git a/docs/samples/sample_justificatifs_dept.json.md b/docs/samples/sample_justificatifs_dept.json.md new file mode 100644 index 000000000..a9299c457 --- /dev/null +++ b/docs/samples/sample_justificatifs_dept.json.md @@ -0,0 +1,47 @@ +### justificatifs_dept + +#### GET /justificatifs/dept/1 +```json +[ + { + "code_nip": "1", + "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": "MODIFIE", + "etudid": 1, + "external_data": null, + "fichier": null, + "formsemestre": { + "id": 1, + "title": "TAPI-BUT-FI-S1-2021" + }, + "justif_id": 1, + "raison": null, + "user_id": null, + "user_name": null, + "user_nom_complet": null + }, + { + "code_nip": "NIP2", + "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": "NON_VALIDE", + "etudid": 2, + "external_data": null, + "fichier": null, + "formsemestre": { + "id": 1, + "title": "TAPI-BUT-FI-S1-2021" + }, + "justif_id": 2, + "raison": null, + "user_id": null, + "user_name": null, + "user_nom_complet": null + }, + "..." +] +``` + diff --git a/docs/samples/sample_justificatifs_formsemestre.json.md b/docs/samples/sample_justificatifs_formsemestre.json.md new file mode 100644 index 000000000..72c1a7b5f --- /dev/null +++ b/docs/samples/sample_justificatifs_formsemestre.json.md @@ -0,0 +1,39 @@ +### justificatifs_formsemestre + +#### GET /justificatifs/formsemestre/1 +```json +[ + { + "code_nip": "1", + "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": "MODIFIE", + "etudid": 1, + "external_data": null, + "fichier": null, + "justif_id": 1, + "raison": null, + "user_id": null, + "user_name": null, + "user_nom_complet": null + }, + { + "code_nip": "NIP2", + "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": "NON_VALIDE", + "etudid": 2, + "external_data": null, + "fichier": null, + "justif_id": 2, + "raison": null, + "user_id": null, + "user_name": null, + "user_nom_complet": null + }, + "..." +] +``` +