From 8ce0af10e827663eb103f590c7e3f00a05e71e8d Mon Sep 17 00:00:00 2001 From: iziram Date: Fri, 28 Jul 2023 11:30:28 +0200 Subject: [PATCH 1/2] Assiduites: MAJ Doc API --- docs/ScoDoc9API.md | 94 +++++++++++----- docs/samples/sample_assiduite.json.md | 20 ++-- docs/samples/sample_assiduite_create.json.md | 17 +-- docs/samples/sample_assiduite_delete.json.md | 29 ++--- docs/samples/sample_assiduite_edit.json.md | 50 ++++----- docs/samples/sample_assiduites.json.md | 102 ++++++++++-------- docs/samples/sample_assiduites_count.json.md | 24 +++-- .../sample_assiduites_formsemestre.json.md | 58 +++++++++- ...mple_assiduites_formsemestre_count.json.md | 24 +++-- docs/samples/sample_justificatif.json.md | 9 +- .../sample_justificatif_create.json.md | 18 ++-- .../sample_justificatif_delete.json.md | 29 ++--- docs/samples/sample_justificatif_edit.json.md | 17 ++- docs/samples/sample_justificatifs.json.md | 32 +++--- 14 files changed, 327 insertions(+), 196 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index dc5120c4..90c221ee 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -1467,7 +1467,10 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** GET * **Permission: `ScoView`** -* **Paramètres:** `etudid` +* **Paramètres:** + * `etudid` + * `nip` + * `ine` * **Query string:** * `etat` ('present','retard','absent) * `moduleimpl_id` (X : id du moduleimpl concerné) @@ -1479,6 +1482,12 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** * `/assiduites/` * `/assiduites//query?` + * `/assiduites/etudid/` + * `/assiduites/etudid//query?` + * `/assiduites/nip/` + * `/assiduites/nip//query?` + * `/assiduites/ine/` + * `/assiduites/ine//query?` * **Exemple d'utilisation:** * `/api/assiduites/1` * `/api/assiduites/1/query?etat=retard` @@ -1490,7 +1499,10 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** GET * **Permission: `ScoView`** -* **Paramètres:** `etudid` +* **Paramètres:** + * `etudid` + * `nip` + * `ine` * **Query string:** * `etat` ('present','retard','absent) * `moduleimpl_id` (X : id du moduleimpl concerné) @@ -1503,6 +1515,12 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** * `/assiduites//count` * `/assiduites//count/query?` + * `/assiduites/etudid//count` + * `/assiduites/etudid//count/query?` + * `/assiduites/nip//count` + * `/assiduites/nip//count/query?` + * `/assiduites/ine//count` + * `/assiduites/ine//count/query?` * **Exemple d'utilisation:** * `/api/assiduites/1` * `/api/assiduites/1/count/query?etat=retard` @@ -1515,7 +1533,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** GET * **Permission: `ScoView`** -* **Paramètres:** `etudid` +* **Paramètres:** `formsemestre_id` * **Query string:** * `etat` ('present','retard','absent) * `moduleimpl_id` (X : id du moduleimpl concerné) @@ -1537,7 +1555,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** GET * **Permission: `ScoView`** -* **Paramètres:** `etudid` +* **Paramètres:** `formsemestre_id` * **Query string:** * `etat` ('present','retard','absent) * `moduleimpl_id` (X : id du moduleimpl concerné) @@ -1607,7 +1625,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * `/assiduites/create` * **Exemple d'utilisation:** `/api/assiduites/create` -> `[{date_debut: "2022-10-27T08:00",date_fin: "2022-10-27T10:00",etat: "absent",etudid:1}]` +> `[{"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. @@ -1616,7 +1634,10 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** POST * **Permission: `ScoAssiduiteChange`** -* **Paramètres:** `etudid` +* **Paramètres:** + * `etudid` + * `nip` + * `ine` * **Data:** ```json @@ -1634,9 +1655,12 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** * `/assiduite//create` + * `/assiduites/etudid//create` + * `/assiduites/nip//create` + * `/assiduites/ine//create` * **Exemple d'utilisation:** `/api/assiduite/1/create` -> `[{date_debut: "2022-10-27T08:00",date_fin: "2022-10-27T10:00",etat: "absent"}]` +> `[{"date_debut": "2022-10-27T08:00","date_fin": "2022-10-27T10:00","etat": "absent"}]` * **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:** [assiduite_create.json](samples/sample_assiduite_create.json.md) @@ -1659,7 +1683,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** `/assiduite//edit` * **Exemple d'utilisation:** `/api/assiduite/1/edit` -> `{etat: "absent"}` +> `{"etat": "absent"}` * **Résultat:** Modifie l'assiduité désignée. Renvoie une erreur si la modification rend incompatible la plage de l'assiduité par rapport aux autres @@ -1675,10 +1699,10 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. ```json [ { - "etudid": + "etudid":, "etat"?: , - "moduleimpl_id"?: - "desc"?: + "moduleimpl_id"?: , + "desc"?:, }, ... ] @@ -1688,7 +1712,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * `/assiduites/edit` * **Exemple d'utilisation:** `/api/assiduites/edit` -> `[{etat: "absent",assiduite_id:1},{etat: "retard",moduleimpl_id:12,assiduite_id:2}]` +> `[{"etat": "absent","assiduite_id":1},{"etat": "retard","moduleimpl_id":12,"assiduite_id":2}]` * **Résultat:** Retourne un objet en deux parties (errors et success) contenant le retour de chaque objet donné dans la requête POST. @@ -1718,14 +1742,15 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. | 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 | -| *entry_date* | string | date ISO de l'entrée du justificatif | +| *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 | identifiant de l'utilisateur ayant créé le justificatif | +| *entry_date* | string | date ISO de l'entrée du justificatif | #### **justificatif** @@ -1741,14 +1766,23 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** GET * **Permission: `ScoView`** -* **Paramètres:** `etudid` +* **Paramètres:** + * `etudid` + * `nip` + * `ine` * **Query string:** * `etat` ( attente, valide, non_valide, modifie) * `date_debut` (X : date format ISO) * `date_fin` (X : date format ISO) * **Routes:** * `/justificatifs/` - * `/justificatifs//query?etat=VALIDE` + * `/justificatifs//query` + * `/justificatifs/etudid/` + * `/justificatifs/etudid/etudid>/query` + * `/justificatifs/nip/` + * `/justificatifs/nip//query` + * `/justificatifs/ine/` + * `/justificatifs/ine//query` * **Exemple d'utilisation:** * `/api/justificatifs/1` * `/api/justificatifs/1/query?etat=modifie` @@ -1760,7 +1794,10 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** POST * **Permission: `ScoJustifChange`** -* **Paramètres:** `etudid` +* **Paramètres:** + * `etudid` + * `nip` + * `ine` * **Data:** ```json @@ -1777,7 +1814,11 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. > Un fichier justificatif peut être importé dans scodoc après avoir créer l'objet justificatif voir [importer un justificatif](FichiersJustificatifs.md#importer-un-fichier) -* **Routes:** `/justificatif//create` +* **Routes:** + * `/justificatif//create` + * `/justificatif/etudid//create` + * `/justificatif/nip//create` + * `/justificatif/ine//create` * **Exemple d'utilisation:** `/api/justificatif/1/create` ```json @@ -1814,7 +1855,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** `/justificatif//edit` * **Exemple d'utilisation:** `/api/justificatif/1/edit` -> `{etat: "valide"}` +> `{"etat": "valide"}` * **Résultat:** Modifie le justificatif désigné. * **Exemple de résultat:** [justificatif-edit.json](samples/sample_justificatif_edit.json.md) @@ -1823,7 +1864,6 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Méthode:** POST * **Permission: `ScoJustifChange`** -* **Paramètres:** `etudid` * **Data:** ```json @@ -1883,7 +1923,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. * **Routes:** `/justificatif//remove` -* **Résultat:** `{response:"removed"}` ou une erreur +* **Résultat:** `{"response":"removed"}` ou une erreur * **Exemple de résultat:** [justificatif-remove.json](samples/sample_justificatif_remove.json.md) #### **justificatif-list** diff --git a/docs/samples/sample_assiduite.json.md b/docs/samples/sample_assiduite.json.md index 3fcb2ae3..78cae052 100644 --- a/docs/samples/sample_assiduite.json.md +++ b/docs/samples/sample_assiduite.json.md @@ -1,16 +1,18 @@ ### 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 + "assiduite_id": 1, + "date_debut": "2022-09-25T08:00:00+0200", + "date_fin": "2022-09-25T08:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "PRESENT", + "etudid": 1, + "moduleimpl_id": 8, + "user_id": null } ``` - diff --git a/docs/samples/sample_assiduite_create.json.md b/docs/samples/sample_assiduite_create.json.md index a7b1f578..1c4c89c2 100644 --- a/docs/samples/sample_assiduite_create.json.md +++ b/docs/samples/sample_assiduite_create.json.md @@ -1,18 +1,21 @@ ### 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 - } + "errors": [], + "success": [ + { + "indice": 0, + "message": { + "assiduite_id": 60 + } } + ] } ``` - diff --git a/docs/samples/sample_assiduite_delete.json.md b/docs/samples/sample_assiduite_delete.json.md index 48738daf..76764a78 100644 --- a/docs/samples/sample_assiduite_delete.json.md +++ b/docs/samples/sample_assiduite_delete.json.md @@ -1,23 +1,28 @@ ### 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 - } + "errors": [ + { + "indice": 1, + "message": "Assiduite non existante" } + ], + "success": [ + { + "indice": 0, + "message": "OK" + }, + { + "indice": 2, + "message": "OK" + } + ] } ``` - diff --git a/docs/samples/sample_assiduite_edit.json.md b/docs/samples/sample_assiduite_edit.json.md index a7b9162c..007ec64b 100644 --- a/docs/samples/sample_assiduite_edit.json.md +++ b/docs/samples/sample_assiduite_edit.json.md @@ -1,35 +1,37 @@ ### 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 + "OK": true } ``` +#### 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 +} +``` diff --git a/docs/samples/sample_assiduites.json.md b/docs/samples/sample_assiduites.json.md index 552887d9..6d148d9f 100644 --- a/docs/samples/sample_assiduites.json.md +++ b/docs/samples/sample_assiduites.json.md @@ -1,63 +1,71 @@ ### 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 - }, - "..." + { + "assiduite_id": 1, + "date_debut": "2022-09-25T08:00:00+0200", + "date_fin": "2022-09-25T08:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "PRESENT", + "etudid": 1, + "moduleimpl_id": 8, + "user_id": null + }, + { + "assiduite_id": 2, + "date_debut": "2022-09-26T08:00:00+0200", + "date_fin": "2022-09-26T09:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "RETARD", + "etudid": 1, + "moduleimpl_id": 13, + "user_id": null + }, + "..." ] ``` #### 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 - }, - "..." + { + "assiduite_id": 2, + "date_debut": "2022-09-26T08:00:00+0200", + "date_fin": "2022-09-26T09:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "RETARD", + "etudid": 1, + "moduleimpl_id": 13, + "user_id": null + }, + { + "assiduite_id": 3, + "date_debut": "2022-09-27T08:00:00+0200", + "date_fin": "2022-09-27T10:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "RETARD", + "etudid": 1, + "moduleimpl_id": 14, + "user_id": null + }, + "..." ] ``` #### GET /assiduites/1/query?moduleimpl_id=1 -```json -[ - "..." -] -``` +```json +["..."] +``` diff --git a/docs/samples/sample_assiduites_count.json.md b/docs/samples/sample_assiduites_count.json.md index bd95f2b7..e02320d9 100644 --- a/docs/samples/sample_assiduites_count.json.md +++ b/docs/samples/sample_assiduites_count.json.md @@ -1,30 +1,32 @@ ### assiduites_count #### GET /assiduites/1/count + ```json { - "compte": 4, - "demi": 3, - "heure": 6.0, - "journee": 4 + "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 + "compte": 4, + "heure": 6.0 } ``` #### GET /assiduites/1/count/query?etat=retard + ```json { - "compte": 3, - "demi": 3, - "heure": 6.0, - "journee": 3 + "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 index dfa44f55..d51e4130 100644 --- a/docs/samples/sample_assiduites_formsemestre.json.md +++ b/docs/samples/sample_assiduites_formsemestre.json.md @@ -1,23 +1,73 @@ ### assiduites_formsemestre #### GET /assiduites/formsemestre/1 + ```json [ - "..." + { + "assiduite_id": 1, + "date_debut": "2022-09-25T08:00:00+0200", + "date_fin": "2022-09-25T08:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "PRESENT", + "etudid": 1, + "moduleimpl_id": 8, + "user_id": null + }, + { + "assiduite_id": 2, + "date_debut": "2022-09-26T08:00:00+0200", + "date_fin": "2022-09-26T09:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "RETARD", + "etudid": 1, + "moduleimpl_id": 13, + "user_id": null + }, + "..." ] ``` #### GET /assiduites/formsemestre/1/query?etat=retard + ```json [ - "..." + { + "assiduite_id": 2, + "date_debut": "2022-09-26T08:00:00+0200", + "date_fin": "2022-09-26T09:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "RETARD", + "etudid": 1, + "moduleimpl_id": 13, + "user_id": null + }, + "..." ] ``` #### GET /assiduites/formsemestre/1/query?moduleimpl_id=1 + ```json [ - "..." + { + "assiduite_id": 3, + "date_debut": "2022-09-27T08:00:00+0200", + "date_fin": "2022-09-27T08:00:00+0200", + "desc": null, + "entry_date": "2023-07-28T11:13:45+0200", + "est_just": false, + "etat": "PRESENT", + "etudid": 1, + "moduleimpl_id": 1, + "user_id": null + }, + "..." ] ``` - diff --git a/docs/samples/sample_assiduites_formsemestre_count.json.md b/docs/samples/sample_assiduites_formsemestre_count.json.md index 14dde74c..5e139064 100644 --- a/docs/samples/sample_assiduites_formsemestre_count.json.md +++ b/docs/samples/sample_assiduites_formsemestre_count.json.md @@ -1,30 +1,32 @@ ### assiduites_formsemestre_count #### GET /assiduites/formsemestre/1/count + ```json { - "compte": 0, - "demi": 0, - "heure": 0.0, - "journee": 0 + "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 + "compte": 0, + "heure": 0.0 } ``` #### GET /assiduites/formsemestre/1/count/query?etat=retard + ```json { - "compte": 0, - "demi": 0, - "heure": 0.0, - "journee": 0 + "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 index 452926c5..249fb6bc 100644 --- a/docs/samples/sample_justificatif.json.md +++ b/docs/samples/sample_justificatif.json.md @@ -3,14 +3,15 @@ #### 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", + "date_debut": "2022-09-25T08:00:00+0200", + "date_fin": "2022-09-25T16:00:00+0200", + "entry_date": "2023-07-28T11:13:45+0200", "etat": "VALIDE", "etudid": 1, "fichier": null, "justif_id": 1, - "raison": "raison" + "raison": "raison", + "user_id": null } ``` diff --git a/docs/samples/sample_justificatif_create.json.md b/docs/samples/sample_justificatif_create.json.md index 80853445..b748642e 100644 --- a/docs/samples/sample_justificatif_create.json.md +++ b/docs/samples/sample_justificatif_create.json.md @@ -1,18 +1,22 @@ ### 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 - } + "errors": [], + "success": [ + { + "indice": 0, + "message": { + "couverture": [], + "justif_id": 12 + } } + ] } ``` - diff --git a/docs/samples/sample_justificatif_delete.json.md b/docs/samples/sample_justificatif_delete.json.md index 52bff41e..06c4e323 100644 --- a/docs/samples/sample_justificatif_delete.json.md +++ b/docs/samples/sample_justificatif_delete.json.md @@ -1,23 +1,28 @@ ### 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 - } + "errors": [ + { + "indice": 1, + "message": "Justificatif non existant" } + ], + "success": [ + { + "indice": 0, + "message": "OK" + }, + { + "indice": 2, + "message": "OK" + } + ] } ``` - diff --git a/docs/samples/sample_justificatif_edit.json.md b/docs/samples/sample_justificatif_edit.json.md index 5946ad10..6c14f8b7 100644 --- a/docs/samples/sample_justificatif_edit.json.md +++ b/docs/samples/sample_justificatif_edit.json.md @@ -1,24 +1,31 @@ ### justificatif_edit #### POST /justificatif/1/edit + > `Content-Type: application/json` -> +> > `{"etat":"valide"}` ```json { - "OK": true + "couverture": { + "apr\u00e8s": [26], + "avant": [1, 26, 38] + } } ``` #### POST /justificatif/1/edit + > `Content-Type: application/json` -> +> > `{"raison":"MEDIC"}` ```json { - "OK": true + "couverture": { + "apr\u00e8s": [26], + "avant": [1, 26, 38] + } } ``` - diff --git a/docs/samples/sample_justificatifs.json.md b/docs/samples/sample_justificatifs.json.md index 3873f60e..b8107881 100644 --- a/docs/samples/sample_justificatifs.json.md +++ b/docs/samples/sample_justificatifs.json.md @@ -1,26 +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" - }, - "..." + { + "date_debut": "2022-09-25T08:00:00+0200", + "date_fin": "2022-09-25T16:00:00+0200", + "entry_date": "2023-07-28T11:13:45+0200", + "etat": "VALIDE", + "etudid": 1, + "fichier": null, + "justif_id": 1, + "raison": "raison", + "user_id": null + }, + "..." ] ``` #### GET /justificatifs/1/query?etat=attente -```json -[ - "..." -] -``` +```json +["..."] +``` From ebe4e92639daeb5b45cc8e0152feed15e2b8c21d Mon Sep 17 00:00:00 2001 From: iziram Date: Fri, 28 Jul 2023 14:41:01 +0200 Subject: [PATCH 2/2] 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" +} +```