From 43d13366eb92d89616be5d201153fc1132251065 Mon Sep 17 00:00:00 2001 From: viennet Date: Wed, 17 Jul 2024 16:08:10 +0300 Subject: [PATCH] =?UTF-8?q?Table=20r=C3=A9cap.=20API=20autog=C3=A9n=C3=A9r?= =?UTF-8?q?=C3=A9e?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/ScoDoc9API.md | 237 ++++++++++++++++++++++++++------------------- 1 file changed, 137 insertions(+), 100 deletions(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index d5dcf19b6..770cd3788 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -244,108 +244,145 @@ permet de rechercher une entrée à partir du résultat attendu. ### Tableau récapitulatif des entrées de l'API -Ce tableau est trié selon le type des informations renvoyées: +| Route | Méthode | Permission | +|---|---|---| +| [assiduite](#assiduite) | GET | ScoView | +| [assiduite_create](#assiduite-create) | POST | AbsChange | +| [assiduite_delete](#assiduite-delete) | POST | AbsChange | +| [assiduite_edit](#assiduite-edit) | POST | AbsChange | +| [assiduite_justificatifs](#assiduite-justificatifs) | GET | ScoView | +| [assiduites](#assiduites-query) | GET | ScoView | +| [assiduites_count](#assiduites-count-query) | GET | ScoView | +| [assiduites_create](#assiduites-create) | POST | AbsChange | +| [assiduites_edit](#assiduites-edit) | POST | AbsChange | +| [assiduites_evaluations](#assiduites-evaluations) | GET | ScoView | +| [assiduites_formsemestre](#assiduites-formsemestre-query) | GET | ScoView | +| [assiduites_formsemestre_count](#assiduites-formsemestre-count-query) | GET | ScoView | +| [assiduites_group](#assiduites-group-query) | GET | ScoView | +| [autorisation_inscription_delete](#autorisation-inscription-delete) | POST | EtudInscrit | +| [billets_absence_create](#billets-absence-create) | POST | Aucune permission requise | +| [billets_absence_delete](#billets-absence-delete) | POST | Aucune permission requise | +| [billets_absence_etudiant](#billets-absence-etudiant) | GET | Aucune permission requise | +| [bulletin](#bulletin) | GET | ScoView | +| [bulletins](#bulletins) | GET | ScoView | +| [decisions_jury](#decisions-jury) | GET | ScoView | +| [departement](#departement) | GET | Aucune permission requise | +| [departement_by_id](#departement-by-id) | GET | Aucune permission requise | +| [departement_create](#departement-create) | POST | Aucune permission requise | +| [departement_delete](#departement-delete) | POST | Aucune permission requise | +| [departement_edit](#departement-edit) | POST | Aucune permission requise | +| [departements_ids](#departements-ids) | GET | Aucune permission requise | +| [departements_list](#departements-list) | GET | Aucune permission requise | +| [dept_etudiants](#dept-etudiants) | GET | Aucune permission requise | +| [dept_etudiants_by_id](#dept-etudiants-by-id) | GET | Aucune permission requise | +| [dept_formsemestres_courants](#dept-formsemestres-courants-query) | GET | Aucune permission requise | +| [dept_formsemestres_ids](#dept-formsemestres-ids) | GET | Aucune permission requise | +| [dept_formsemestres_ids_by_id](#dept-formsemestres-ids-by-id) | GET | Aucune permission requise | +| [etudiant](#etudiant) | GET | ScoView | +| [etudiant_annotation](#etudiant-annotation) | POST | EtudInscrit | +| [etudiant_annotation_delete](#etudiant-annotation-delete) | POST | EtudInscrit | +| [etudiant_create](#etudiant-create) | POST | EtudInscrit | +| [etudiant_edit](#etudiant-edit) | POST | EtudInscrit | +| [etudiant_formsemestres](#etudiant-formsemestres) | GET | ScoView | +| [etudiant_get_photo_image](#etudiant-get-photo-image-query) | GET | ScoView | +| [etudiant_groups](#etudiant-groups) | GET | ScoView | +| [etudiants](#etudiants) | GET | ScoView | +| [etudiants_by_name](#etudiants-by-name) | GET | ScoView | +| [etudiants_courants](#etudiants-courants-query) | GET | ScoView | +| [evaluation_assiduites](#evaluation-assiduites) | GET | ScoView | +| [evaluation_create](#evaluation-create) | POST | EnsView | +| [evaluation_delete](#evaluation-delete) | POST | EnsView | +| [evaluation_notes](#evaluation-notes) | GET | ScoView | +| [evaluation_set_notes](#evaluation-set-notes) | POST | EnsView | +| [formation_by_id](#formation-by-id) | GET | ScoView | +| [formation_export_by_formation_id](#formation-export-by-formation-id) | GET | ScoView | +| [formation_module_edit](#formation-module-edit) | POST | EditFormation | +| [formation_module_get](#formation-module-get) | GET | ScoView | +| [formation_module_set_code_apogee](#formation-module-set-code-apogee) | POST | EditFormation | +| [formations](#formations) | GET | ScoView | +| [formations_ids](#formations-ids) | GET | ScoView | +| [formsemestre_edit](#formsemestre-edit) | POST | EditFormSemestre | +| [formsemestre_edt](#formsemestre-edt-query) | GET | ScoView | +| [formsemestre_etat_evaluations](#formsemestre-etat-evaluations) | GET | ScoView | +| [formsemestre_etudiants](#formsemestre-etudiants-query) | GET | ScoView | +| [formsemestre_infos](#formsemestre-infos) | GET | ScoView | +| [formsemestre_partitions](#formsemestre-partitions) | GET | ScoView | +| [formsemestre_programme](#formsemestre-programme) | GET | ScoView | +| [formsemestre_resultat](#formsemestre-resultat-query) | GET | ScoView | +| [formsemestre_set_apo_etapes](#formsemestre-set-apo-etapes) | POST | EditApogee | +| [formsemestre_set_elt_annee_apo](#formsemestre-set-elt-annee-apo) | POST | EditApogee | +| [formsemestre_set_elt_passage_apo](#formsemestre-set-elt-passage-apo) | POST | EditApogee | +| [formsemestre_set_elt_sem_apo](#formsemestre-set-elt-sem-apo) | POST | EditApogee | +| [formsemestre_set_partitions_order](#formsemestre-set-partitions-order) | POST | ScoView | +| [formsemestres_query](#formsemestres-query) | GET | ScoView | +| [group_create](#group-create) | POST | ScoView | +| [group_delete](#group-delete) | POST | ScoView | +| [group_edit](#group-edit) | POST | ScoView | +| [group_etudiants](#group-etudiants) | GET | ScoView | +| [group_etudiants_query](#group-etudiants-query) | GET | ScoView | +| [group_remove_etud](#group-remove-etud) | POST | ScoView | +| [group_set_edt_id](#group-set-edt-id) | POST | ScoView | +| [group_set_etudiant](#group-set-etudiant) | POST | ScoView | +| [groups_get_auto_assignment](#groups-get-auto-assignment) | GET | ScoView | +| [groups_save_auto_assignment](#groups-save-auto-assignment) | POST | ScoView | +| [justif_create](#justif-create) | POST | AbsChange | +| [justif_delete](#justif-delete) | POST | AbsChange | +| [justif_edit](#justif-edit) | POST | AbsChange | +| [justif_export](#justif-export) | POST | ScoView | +| [justif_import](#justif-import) | POST | AbsChange | +| [justif_justifies](#justif-justifies) | GET | AbsChange | +| [justif_list](#justif-list) | GET | ScoView | +| [justif_remove](#justif-remove) | POST | AbsChange | +| [justificatif](#justificatif) | GET | ScoView | +| [justificatifs](#justificatifs-query) | GET | ScoView | +| [justificatifs_dept](#justificatifs-dept-query) | GET | ScoView | +| [justificatifs_formsemestre](#justificatifs-formsemestre-query) | GET | ScoView | +| [logo_get_global](#logo-get-global) | GET | ScoSuperAdmin | +| [logo_get_local_by_acronym](#logo-get-local-by-acronym) | GET | ScoSuperAdmin | +| [logo_get_local_by_id](#logo-get-local-by-id) | GET | ScoSuperAdmin | +| [logo_get_local_dept_by_acronym](#logo-get-local-dept-by-acronym) | GET | ScoSuperAdmin | +| [logo_get_local_dept_by_id](#logo-get-local-dept-by-id) | GET | ScoSuperAdmin | +| [logo_list_globals](#logo-list-globals) | GET | ScoSuperAdmin | +| [moduleimpl_evaluations](#moduleimpl-evaluations) | GET | ScoView | +| [moduleimpl_inscriptions](#moduleimpl-inscriptions) | GET | ScoView | +| [moduleimpl_notes](#moduleimpl-notes) | GET | ScoView | +| [partition_create](#partition-create) | POST | ScoView | +| [partition_delete](#partition-delete) | POST | ScoView | +| [partition_edit](#partition-edit) | POST | ScoView | +| [partition_info](#partition-info) | GET | ScoView | +| [partition_order_groups](#partition-order-groups) | POST | ScoView | +| [partition_remove_etud](#partition-remove-etud) | POST | ScoView | +| [permissions_list](#permissions-list) | GET | UsersView | +| [referentiel_competences](#referentiel-competences) | GET | ScoView | +| [role_create](#role-create) | POST | ScoSuperAdmin | +| [role_delete](#role-delete) | POST | ScoSuperAdmin | +| [role_edit](#role-edit) | POST | ScoSuperAdmin | +| [role_get](#role-get) | GET | UsersView | +| [role_permission_add](#role-permission-add) | POST | ScoSuperAdmin | +| [role_permission_remove](#role-permission-remove) | POST | ScoSuperAdmin | +| [roles_list](#roles-list) | GET | UsersView | +| [token_get](#token-get) | POST | Aucune permission requise | +| [ue_assoc_niveau](#ue-assoc-niveau) | POST | EditFormation | +| [ue_desassoc_niveau](#ue-desassoc-niveau) | POST | EditFormation | +| [ue_edit](#ue-edit) | POST | EditFormation | +| [ue_set_code_apogee](#ue-set-code-apogee) | POST | EditFormation | +| [ue_set_code_apogee_rcue](#ue-set-code-apogee-rcue) | POST | EditFormation | +| [ue_set_parcours](#ue-set-parcours) | POST | EditFormation | +| [user_create](#user-create) | POST | UsersAdmin | +| [user_edit](#user-edit) | POST | UsersAdmin | +| [user_info](#user-info) | GET | UsersView | +| [user_password](#user-password) | POST | UsersAdmin | +| [user_role_add](#user-role-add) | POST | ScoSuperAdmin | +| [user_role_remove](#user-role-remove) | POST | ScoSuperAdmin | +| [users_info_query](#users-info-query) | GET | ScoView | +| [validation_annee_but_delete](#validation-annee-but-delete) | POST | EtudInscrit | +| [validation_dut120_delete](#validation-dut120-delete) | POST | EtudInscrit | +| [validation_formsemestre_delete](#validation-formsemestre-delete) | POST | ScoView | +| [validation_rcue_delete](#validation-rcue-delete) | POST | EtudInscrit | +| [validation_rcue_record](#validation-rcue-record) | POST | EtudInscrit | +| [validation_ue_delete](#validation-ue-delete) | POST | ScoView | -* un nom simple représente un seul objet de ce type; -* suivi de `+`désigne une forme 'longue' d'objet de ce type; -* suivi de `*` désigne une liste de 0, 1 ou plusieurs objets du type; -* suivi de `#` désigne une liste d'entiers (les ids des objets du type); -* suivi de `:` puis d'un nom en majuscule indique une requête (POST) qui modifie - les données de ScoDoc. -| Retour | Remarque | Méthode | Navigation | Permission | -|:------------------------|:----------------------------------------|---------|---------------------------------------------------------------------------|---------------------| -| assiduite | une assiduité | GET | [assiduité](#assiduite) | ScoView | -| 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) | 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) | 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 | -| departement | recherche par acronyme | GET | [departement](#departement) | ScoView | -| departement:CREATE | création d'un département | POST | [departement-create](#departement-create) | ScoSuperAdmin | -| departement:EDIT | modification d'un département | POST | [departement-edit](#departement-edit) | ScoSuperAdmin | -| departement:DELETE | suppression d'un département | POST | [departement-delete](#departement-delete) | ScoSuperAdmin | -| evaluation | une évaluation | GET | [evaluation](#evaluation) | ScoView | -| evaluation:CREATE | création d'une évaluation | POST | [evaluation-create](#evaluation-create) | - | -| evaluation:DELETE | suppression d'une évaluation | POST | [evaluation-delete](#evaluation-delete) | - | -| formation**`*`** | toutes les formations accessibles | GET | [formations](#formations) | ScoView | -| formation**`#`** | ids des formations accessibles | GET | [formations-ids](#formations-ids) | ScoView | -| formation | une formation | GET | [formation](#formation) | ScoView | -| export | | GET | [formation-export](#formation-export) | ScoView | -| export**`+`** | | GET | [formation-export_with_ids](#formation-export_with_ids) | ScoView | -| referentiel_competences | | GET | [formation-referenciel_competences](#formation-referenciel_competences) | ScoView | -| 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) | 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) | 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 | -| etudiant**`*`** | | GET | [departement-etudiants](#departement-etudiants) | ScoView | -| etudiant**`*`** | | GET | [formsemestre-etudiants](#formsemestre-etudiants) | ScoView | -| etudiant**`*`** | | GET | [formsemestre-etudiants-query](#formsemestre-etudiants-query) | ScoView | -| 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) | 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 | -| | | GET | [formsemestre-etat_evals](#formsemestre-etat_evals) | ScoView | -| | | GET | [formsemestre-resultats](#formsemestre-resultats) | ScoView | -| jury | | GET | [formsemestre-decisions_jury](#formsemestre-decisions_jury) | ScoView | -| note* | | GET | [evaluation-notes](#evaluation-notes) | ScoView | -| | | GET | [evaluation-notes-set](#evaluation-notes-set) | (contextuelle) | -| logo**`*`** | | GET | [logos](#logos) | ScoSuperAdmin | -| logo**`*`** | | GET | [departement-logos](#departement-logos) | ScoSuperAdmin | -| logo | | GET | [logo](#logo) | ScoSuperAdmin | -| logo | | GET | [departement-logo](#departement-logo) | ScoSuperAdmin | -| 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