From ebe4e92639daeb5b45cc8e0152feed15e2b8c21d Mon Sep 17 00:00:00 2001 From: iziram Date: Fri, 28 Jul 2023 14:41:01 +0200 Subject: [PATCH] Assiduites : samples justificatifs --- docs/ScoDoc9API.md | 23 ++++++++--------- .../sample_justificatif_export.json.md | 7 ++++++ .../sample_justificatif_import.json.md | 11 ++++++++ .../sample_justificatif_justifies.json.md | 7 ++++++ docs/samples/sample_justificatif_list.json.md | 10 ++++++++ .../sample_justificatif_remove.json.md | 25 +++++++++++++++++++ 6 files changed, 71 insertions(+), 12 deletions(-) create mode 100644 docs/samples/sample_justificatif_export.json.md create mode 100644 docs/samples/sample_justificatif_import.json.md create mode 100644 docs/samples/sample_justificatif_justifies.json.md create mode 100644 docs/samples/sample_justificatif_list.json.md create mode 100644 docs/samples/sample_justificatif_remove.json.md diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 90c221ee..1c2543c2 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1434,7 +1434,6 @@ valeurs numériques mais pas JSON compliant à cause des `NaN`. Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. - #### Structure Assiduité | attribut | type | commentaire | @@ -1603,7 +1602,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduites-create** * **Méthode:** POST -* **Permission: `ScoAssiduiteChange`** +* **Permission: `ScoAbsChange`** * **Data:** ```json @@ -1633,7 +1632,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-create** * **Méthode:** POST -* **Permission: `ScoAssiduiteChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** * `etudid` * `nip` @@ -1668,7 +1667,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-edit** * **Méthode:** POST -* **Permission: `ScoAssiduiteChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** `assiduite_id` * **Data:** @@ -1693,7 +1692,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduites-edit** * **Méthode:** POST -* **Permission: `ScoAssiduiteChange`** +* **Permission: `ScoAbsChange`** * **Data:** ```json @@ -1719,7 +1718,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-delete** * **Méthode:** POST -* **Permission: `ScoAssiduiteChange`** +* **Permission: `ScoAbsChange`** * **Data:** ```json @@ -1793,7 +1792,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-create** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** * `etudid` * `nip` @@ -1839,7 +1838,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-edit** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** `justif_id` * **Data:** @@ -1863,7 +1862,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-delete** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Data:** ```json @@ -1888,7 +1887,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-import** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** `justif_id` > Procédure d'importation de fichier : [importer un justificatif](FichiersJustificatifs.md#importer-un-fichier) @@ -1901,7 +1900,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-export** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** * `justif_id` * `filename` @@ -1916,7 +1915,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-remove** * **Méthode:** POST -* **Permission: `ScoJustifChange`** +* **Permission: `ScoAbsChange`** * **Paramètres:** `justif_id` > Procédure de suppression de fichier : [supprimer un justificatif](FichiersJustificatifs.md#supprimer-un-fichier) diff --git a/docs/samples/sample_justificatif_export.json.md b/docs/samples/sample_justificatif_export.json.md new file mode 100644 index 00000000..60af4a41 --- /dev/null +++ b/docs/samples/sample_justificatif_export.json.md @@ -0,0 +1,7 @@ +### justificatif_export + +#### POST /justificatif/1/export/nom_fichier + +```console +téléchargement du fichier +``` diff --git a/docs/samples/sample_justificatif_import.json.md b/docs/samples/sample_justificatif_import.json.md new file mode 100644 index 00000000..4ce0df3e --- /dev/null +++ b/docs/samples/sample_justificatif_import.json.md @@ -0,0 +1,11 @@ +### justificatif_import + +#### POST /justificatif/1/import + +> `Content-Type: multipart/form-data` +> +> `binary file` + +```json +{ "filename": "nom_du_fichier" } +``` diff --git a/docs/samples/sample_justificatif_justifies.json.md b/docs/samples/sample_justificatif_justifies.json.md new file mode 100644 index 00000000..716d7194 --- /dev/null +++ b/docs/samples/sample_justificatif_justifies.json.md @@ -0,0 +1,7 @@ +### justificatif_justifies + +#### GET /justificatif/1/justifies + +```json +[1, 2, "..."] +``` diff --git a/docs/samples/sample_justificatif_list.json.md b/docs/samples/sample_justificatif_list.json.md new file mode 100644 index 00000000..31c24518 --- /dev/null +++ b/docs/samples/sample_justificatif_list.json.md @@ -0,0 +1,10 @@ +### justificatif_list + +#### GET /justificatif/1/list + +```json +{ + "total": 1, + "filenames": ["nom_fichier"] +} +``` diff --git a/docs/samples/sample_justificatif_remove.json.md b/docs/samples/sample_justificatif_remove.json.md new file mode 100644 index 00000000..3caff411 --- /dev/null +++ b/docs/samples/sample_justificatif_remove.json.md @@ -0,0 +1,25 @@ +### justificatif_remove + +#### POST /justificatif/1/remove + +> `Content-Type: application/json` +> +> `{"remove" : "all"}` + +```json +{ + "response": "remove" +} +``` + +#### POST /justificatif/1/remove + +> `Content-Type: application/json` +> +> `{"remove" : "list", "filenames": ["nom_fichier"]}` + +```json +{ + "response": "remove" +} +```