diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 1433beeb..100fb2c7 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -253,17 +253,17 @@ Ce tableau est trié selon le type des informations renvoyées: | assiduite**`*`** | liste d'assiduités d'un étudiant | GET | [assiduités](#assiduites) | ScoView | | assiduite**`*`** | liste d'assiduités d'un formsemestre | GET | [assiduités-formsemestre](#assiduites-formsemestre) | ScoView | | assiduite**`#`** | liste d'id d'assiduités justifiées | GET | [justificatif-justifies](#justificatif-justifies) | ScoView | -| assiduite:CREATE | création d'assiduité | POST | [assiduite-create](#assiduite-create) | ScoAssiduiteChange | -| assiduite:EDIT | édition d'assiduité | POST | [assiduite-edit](#assiduite-edit) | ScoAssiduiteChange | -| assiduite:DELETE | suppression d'assiduité | POST | [assiduite-delete](#assiduite-delete) | ScoAssiduiteChange | +| assiduite:CREATE | création d'assiduité | POST | [assiduite-create](#assiduite-create) | AbsChange | +| assiduite:EDIT | édition d'assiduité | POST | [assiduite-edit](#assiduite-edit) | AbsChange | +| assiduite:DELETE | suppression d'assiduité | POST | [assiduite-delete](#assiduite-delete) | AbsChange | | justificatif | un justificatif | GET | [justificatif](#justificatif) | ScoView | | justificatif**`*`** | liste de justificatif d'un étudiant | GET | [justificatifs](#justificatifs) | ScoView | -| justificatif:CREATE | création de justificatif | POST | [justificatif-create](#justificatif-create) | ScoJustifChange | -| justificatif:EDIT | édition de justificatif | POST | [justificatif-edit](#justificatif-edit) | ScoJustifChange | -| justificatif:DELETE | suppression de justificatif | POST | [justificatif-delete](#justificatif-delete) | ScoJustifChange | -| justificatif:IMPORT | importation de fichier justificatif | POST | [justificatif-import](#justificatif-import) | ScoJustifChange | -| justificatif:EXPORT | exportation de fichier justificatif | POST | [justificatif-export](#justificatif-export) | ScoJustifChange | -| justificatif:REMOVE | suppression de fichier justificatif | POST | [justificatif-remove](#justificatif-remove) | ScoJustifChange | +| justificatif:CREATE | création de justificatif | POST | [justificatif-create](#justificatif-create) | AbsChange | +| justificatif:EDIT | édition de justificatif | POST | [justificatif-edit](#justificatif-edit) | AbsChange | +| justificatif:DELETE | suppression de justificatif | POST | [justificatif-delete](#justificatif-delete) | AbsChange | +| justificatif:IMPORT | importation de fichier justificatif | POST | [justificatif-import](#justificatif-import) | AbsChange | +| justificatif:EXPORT | exportation de fichier justificatif | POST | [justificatif-export](#justificatif-export) | AbsChange | +| justificatif:REMOVE | suppression de fichier justificatif | POST | [justificatif-remove](#justificatif-remove) | AbsChange | | departement**`*`** | tous les depts | GET | [departements](#departements) | | | departement**`#`** | tous les ids des depts | GET | [departements-ids](#departements-ids) | ScoView | | departement | recherche par id | GET | [departement](#departement) | ScoView | @@ -283,24 +283,25 @@ Ce tableau est trié selon le type des informations renvoyées: | formsemestre**`#`** | | GET | [departement-formsemestres_ids](#departement-formsemestres_ids) | ScoView | | formsemestre**`*`** | | GET | [departement-formsemestres_courants](#departement-formsemestres_courants) | ScoView | | formsemestre**`*`** | | GET | [formsemestre-query](#formsemestre-query) | ScoView | +| formsemestre:EDIT | | POST | [formsemestre-edit](#formsemestre-edit) | EditFormSemestre | | formsemestre**`*`** | | GET | [etudiant-formsemestres](#etudiant-formsemestres) | ScoView | | formsemestre | | GET | [formsemestre](#formsemestre) | ScoView | | moduleimpl | | GET | [moduleimpl](#moduleimpl) | ScoView | | moduleimpl-inscriptions | | GET | [moduleimpl](#moduleimpl-inscriptions) | ScoView | | partition**`*`** | | GET | [formsemestre-partitions](#formsemestre-partitions) | ScoView | | partition | | GET | [partition](#partition) | ScoView | -| partition:CREATE | | POST | [formsemestre-partition-create](#formsemestre-partition-create) | ScoEtudChangeGroups | -| partition:EDIT | | POST | [partition-edit](#partition-edit) | ScoEtudChangeGroups | -| partition:ACTION | | POST | [formsemestre-partitions-order](#formsemestre-partitions-order) | ScoEtudChangeGroups | -| partition:DELETE | | POST | [partition-delete](#partition-delete) | ScoEtudChangeGroups | -| partition:ACTION | | POST | [partition-remove_etudiant](#partition-remove_etudiant) | ScoEtudChangeGroups | -| group:CREATE | | POST | [partition-group-create](#partition-group-create) | ScoEtudChangeGroups | -| group:EDIT | | POST | [group-edit](#group-edit) | ScoEtudChangeGroups | -| group:ACTION | | POST | [partition-groups-order](#partition-groups-order) | ScoEtudChangeGroups | -| group:DELETE | | POST | [group-delete](#group-delete) | ScoEtudChangeGroups | +| partition:CREATE | | POST | [formsemestre-partition-create](#formsemestre-partition-create) | EtudChangeGroups | +| partition:EDIT | | POST | [partition-edit](#partition-edit) | EtudChangeGroups | +| partition:ACTION | | POST | [formsemestre-partitions-order](#formsemestre-partitions-order) | EtudChangeGroups | +| partition:DELETE | | POST | [partition-delete](#partition-delete) | EtudChangeGroups | +| partition:ACTION | | POST | [partition-remove_etudiant](#partition-remove_etudiant) | EtudChangeGroups | +| group:CREATE | | POST | [partition-group-create](#partition-group-create) | EtudChangeGroups | +| group:EDIT | | POST | [group-edit](#group-edit) | EtudChangeGroups | +| group:ACTION | | POST | [partition-groups-order](#partition-groups-order) | EtudChangeGroups | +| group:DELETE | | POST | [group-delete](#group-delete) | EtudChangeGroups | | group* | | GET | [etudiant-formsemestre-groups](#etudiant-formsemestre-groups) | ScoView | -| group:ACTION | | POST | [group-set_etudiant](#group-set_etudiant) | ScoEtudChangeGroups | -| group:ACTION | | POST | [group-remove_etudiant](#group-remove_etudiant) | ScoEtudChangeGroups | +| group:ACTION | | POST | [group-set_etudiant](#group-set_etudiant) | EtudChangeGroups | +| group:ACTION | | POST | [group-remove_etudiant](#group-remove_etudiant) | EtudChangeGroups | | etudiant**`*`** | recherche par etudid, nip ou ine | GET | [etudiants-clef](#etudiants-clef) | ScoView | | etudiant**`*`** | les étudiants actuels | GET | [etudiants-courant](#etudiants-courant) | ScoView | | etudiant**`*`** | étudiants dont le nom commence par | GET | [etudiants-name](#etudiants-name) | ScoView | @@ -310,8 +311,8 @@ Ce tableau est trié selon le type des informations renvoyées: | etudiant**`*`** | | GET | [group-etudiants-query](#group-etudiants) | ScoView | | etudiant**`*`** | | GET | [group-etudiants-query](#group-etudiants-query) | | etudiant | | GET | [etudiant](#etudiant) | ScoView | -| etudiant:CREATE | | GET | [etudiant-create](#etudiant-create) | ScoEtudInscrit | -| etudiant:EDIT | | GET | [etudiant-edit](#etudiant-edit) | ScoEtudInscrit | +| etudiant:CREATE | | GET | [etudiant-create](#etudiant-create) | EtudInscrit | +| etudiant:EDIT | | GET | [etudiant-edit](#etudiant-edit) | EtudInscrit | | bulletin**`*`** | | GET | [formsemestre-bulletin](#formsemestre-bulletin) | ScoView | | bulletin | | GET | [etudiant-formsemestre-bulletin](#etudiant-formsemestre-bulletin) | ScoView | | programme | | GET | [formsemestre-programme](#formsemestre-programme) | ScoView | @@ -324,21 +325,21 @@ Ce tableau est trié selon le type des informations renvoyées: | logo**`*`** | | GET | [departement-logos](#departement-logos) | ScoSuperAdmin | | logo | | GET | [logo](#logo) | ScoSuperAdmin | | logo | | GET | [departement-logo](#departement-logo) | ScoSuperAdmin | -| user | | GET | [user](#user) | ScoUsView | -| user**`*`** | | GET | [users-query](#users-query) | ScoUsView | -| user:CREATE | | POST | [user-create](#user-create) | ScoUserAdmin | -| user:EDIT | | POST | [user-edit](#user-edit) | ScoUserAdmin | -| user:PASSWORD | change le mot de passe d'un utilisateur | POST | [user-password](#user-password) | ScoUserAdmin | -| user:ACTION | | POST | [user-role-add](#user-role-add) | ScoUserAdmin | -| user:ACTION | | POST | [user-role-remove](#user-role-remove) | ScoUserAdmin | -| permission**`*`** | | GET | [permissions](#permissions) | ScoUsView | -| role**`*`** | | GET | [roles](#roles) | ScoUsView | -| role**`*`** | | GET | [role](#role) | ScoUsView | -| role:ACTION | | POST | [role-add_permission](#role-add_permission) | ScoUserAdmin | -| role:ACTION | | POST | [role-remove_permission](#role-remove_permission) | ScoUserAdmin | -| role:CREATE | | POST | [role-create](#role-create) | ScoUserAdmin | -| role:EDIT | | POST | [role-edit](#role-edit) | ScoUserAdmin | -| role:DELETE | | POST | [role-delete](#role-delete) | ScoUserAdmin | +| user | | GET | [user](#user) | UsersView | +| user**`*`** | | GET | [users-query](#users-query) | UsersView | +| user:CREATE | | POST | [user-create](#user-create) | UsersAdmin | +| user:EDIT | | POST | [user-edit](#user-edit) | UsersAdmin | +| user:PASSWORD | change le mot de passe d'un utilisateur | POST | [user-password](#user-password) | UsersAdmin | +| user:ACTION | | POST | [user-role-add](#user-role-add) | UsersAdmin | +| user:ACTION | | POST | [user-role-remove](#user-role-remove) | UsersAdmin | +| permission**`*`** | | GET | [permissions](#permissions) | UsersView | +| role**`*`** | | GET | [roles](#roles) | UsersView | +| role**`*`** | | GET | [role](#role) | UsersView | +| role:ACTION | | POST | [role-add_permission](#role-add_permission) | UsersAdmin | +| role:ACTION | | POST | [role-remove_permission](#role-remove_permission) | UsersAdmin | +| role:CREATE | | POST | [role-create](#role-create) | UsersAdmin | +| role:EDIT | | POST | [role-edit](#role-edit) | UsersAdmin | +| role:DELETE | | POST | [role-delete](#role-delete) | UsersAdmin | #### Note sur les exemples d'utilisation @@ -544,7 +545,7 @@ Sur l'application, elles sont affichées et modifiables sur la fiche de l'étudi #### **`etudiant-create`** * **Méthode: POST** -* **Permission: `ScoEtudInscrit`** +* **Permission: `EtudInscrit`** * **Paramètres:** `` * **Data:** @@ -614,7 +615,7 @@ Sur l'application, elles sont affichées et modifiables sur la fiche de l'étudi #### **`etudiant-edit`** * **Méthode: POST** -* **Permission: `ScoEtudInscrit`** +* **Permission: `EtudInscrit`** * **Paramètres:** `` * **Data:** exactement comme `etudiant/create`, seules les données passées sont modifiées. * **Routes:** @@ -626,7 +627,7 @@ Sur l'application, elles sont affichées et modifiables sur la fiche de l'étudi #### **`etudiant-annotation`** * **Méthode: POST** -* **Permission: `ScoEtudInscrit`+`ViewEtudData`** +* **Permission: `EtudInscrit`+`ViewEtudData`** * **Data:** `{ "comment" : "une annotation" }` * **Routes:** * `/etudiant/etudid//annotation` @@ -637,7 +638,7 @@ Sur l'application, elles sont affichées et modifiables sur la fiche de l'étudi #### **`etudiant-annotation-delete`** * **Méthode: POST** -* **Permission: `ScoEtudInscrit`** +* **Permission: `EtudInscrit`** * **Routes:** * `/etudiant/etudid//annotation//delete` * `/etudiant/nip//annotation/delete` @@ -887,6 +888,21 @@ informatique de 2014 en formation initiale (FI). | _**titre_court**_ | string | | | _**titre_num**_ | string | | + +#### **`formsemestre-create`** + +* **Méthode: POST** +* **Permission: `EditFormSemestre`** +* **Paramètres:** `formsemestre_id` +* **Data:** `{ ... }` +* **Routes:** `/formsemestre//edit` + +>`{ "titre" : "titre du semestre" }` + +* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/123/edit` +* **Résultat:** Modifie les paramètres d'un FormSemestre. +* **Exemple de résultat:** nd + #### **departement-formsemestres_ids** * **Méthode:** GET @@ -956,7 +972,7 @@ informatique de 2014 en formation initiale (FI). #### **`partition-group-create`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `partition_id` * **Data:** `{ group_name : }` * **Routes:** `/partition//group/create` @@ -970,7 +986,7 @@ informatique de 2014 en formation initiale (FI). #### **`group-edit`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `group_id` * **Data:** `{ group_name : }` * **Routes:** `/group//edit` @@ -984,7 +1000,7 @@ informatique de 2014 en formation initiale (FI). #### **`partition-groups-order`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `partition_id` * **Data:** `[ , , ... ]` * **Routes:** `/partition//groups/order` @@ -998,7 +1014,7 @@ informatique de 2014 en formation initiale (FI). #### **`group-delete`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `group_id` * **Routes:** `/group//delete` * **Exemple d'utilisation:** `/ScoDoc/api/group/4581/delete` @@ -1021,7 +1037,7 @@ informatique de 2014 en formation initiale (FI). #### **`group-set_etudiant`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `group_id`, `etudid` * **Routes:** `/group//set_etudiant/` * **Exemple d'utilisation:** `/ScoDoc/api/group/4085/set_etudiant/12108` @@ -1031,7 +1047,7 @@ informatique de 2014 en formation initiale (FI). #### **`group-remove_etudiant`** * **Méthode: POST** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `group_id`, `etudid` * **Routes:** `/group//remove_etudiant/` * **Exemple d'utilisation:** `/ScoDoc/api/group/4085/remove_etudiant/12108` @@ -1187,7 +1203,7 @@ d'un nombre quelconque de groupes d'étudiants. #### **`formsemestre-partition-create`** * **Méthode: POST** -* **Permission: `ScoEtudsChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `formsemestre_id` * **Data:** `{ "partition_name" : }` * **Routes:** `/formsemestre//partition/create` @@ -1201,7 +1217,7 @@ d'un nombre quelconque de groupes d'étudiants. #### **`partition-edit`** * **Méthode: POST** -* **Permission: `ScoEtudsChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `partition_id` * **Data:** `{ partition_name : }` * **Routes:** `/partition//edit` @@ -1215,7 +1231,7 @@ d'un nombre quelconque de groupes d'étudiants. #### **`formsemestre-partitions-order`** * **Méthode: POST** -* **Permission: `ScoEtudsChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `formsemestre_id` * **Data:** `[ , , ... ]` * **Routes:** `/formsemestre//partitions/order` @@ -1229,7 +1245,7 @@ d'un nombre quelconque de groupes d'étudiants. #### **`partition-delete`** * **Méthode: POST** -* **Permission: `ScoEtudsChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `partition_id` * **Routes:** `/partition//delete` * **Exemple d'utilisation:** `/ScoDoc/api/partition/2047/delete` @@ -1239,8 +1255,7 @@ d'un nombre quelconque de groupes d'étudiants. #### **`partition-remove_etudiant`** * **Méthode: POST** -* **Permission: `ScoEtudsChangeGroups`** -* **Permission: `ScoEtudChangeGroups`** +* **Permission: `EtudChangeGroups`** * **Paramètres:** `partition_id` * **Routes:** `/partition//remove_etudiant/` * **Exemple d'utilisation:** `/ScoDoc/api/partition/1962/remove_etudiant/12107` @@ -1854,7 +1869,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduites-create** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Data:** ```json @@ -1884,7 +1899,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-create** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** * `etudid` * `nip` @@ -1919,7 +1934,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-edit** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** `assiduite_id` * **Data:** @@ -1944,7 +1959,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduites-edit** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Data:** ```json @@ -1970,7 +1985,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **assiduite-delete** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Data:** ```json @@ -2045,7 +2060,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-create** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** * `etudid` * `nip` @@ -2091,7 +2106,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-edit** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** `justif_id` * **Data:** @@ -2115,7 +2130,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-delete** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Data:** ```json @@ -2140,7 +2155,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-import** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** `justif_id` > Procédure d'importation de fichier : [importer un justificatif](FichiersJustificatifs.md#importer-un-fichier) @@ -2153,7 +2168,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-export** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** * `justif_id` * `filename` @@ -2168,7 +2183,7 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-remove** * **Méthode:** POST -* **Permission: `ScoAbsChange`** +* **Permission: `AbsChange`** * **Paramètres:** `justif_id` > Procédure de suppression de fichier : [supprimer un justificatif](FichiersJustificatifs.md#supprimer-un-fichier) @@ -2181,9 +2196,9 @@ Cette API est disponible à partir de ScoDoc 9.6 et remplace les absences. #### **justificatif-list** * **Méthode:** GET -* **Permission: `ScoView` / `ScoJustifView`** +* **Permission: `ScoView` / `AbsJustifView`** * Si `ScoView` : retourne uniquement les fichiers fourni par le même utilisateur - * Si `ScoJustifView` : retourne tous les fichiers + * Si `AbsJustifView` : retourne tous les fichiers * **Paramètres:** `justif_id` * **Routes:** `/justificatif//list` * **Exemple d'utilisation:** `/api/justificatif/1/list`