From 31606710959b3f6d65e06af25efbca1a5281ffb0 Mon Sep 17 00:00:00 2001 From: viennet Date: Wed, 3 Jul 2024 22:41:17 +0200 Subject: [PATCH] Ajout module-edit, ue-edit --- docs/ScoDoc9API.md | 59 ++++++++++++++++++++++++++++++++++++++++++ docs/img/API_Chart.svg | 2 +- 2 files changed, 60 insertions(+), 1 deletion(-) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 87f3240d0..e229f9496 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -240,6 +240,8 @@ permet de rechercher une entrée à partir du résultat attendu. +(carte générée avec `flask gen-api-map -e "api."`) + ### Tableau récapitulatif des entrées de l'API Ce tableau est trié selon le type des informations renvoyées: @@ -838,6 +840,63 @@ Note: les poids ne sont utilisés que dans les formations APC (BUT). * **Résultat:** Description de la formation. * **Exemple de résultat:** [formation.json](samples/sample_formation.json.md) +#### **`module-edit`** + +* **Méthode:** POST +* **Permission: `EditFormation`** +* **Paramètres:** `module_id` +* **Data:** +```json +{ + "titre" : str, + "abbrev" : str, + "code" + "heures_cours" : float, + "heures_td" : float, + "heures_tp" : float, + "coefficient" : float, + "ects" : float, + "matiere_id" : int, // must be in same UE + "semestre_id" : int, // le rang du semestre (S1, ...) + "numero" : int, // ordre d'affichage + "code_apogee" : str, + "edt_id" : str, + "module_type" : int, // 0 std, 1 malus, 2 ressource, 3 SAÉ + "parcours" : [ id de parcours ], +} +``` +* **Routes:** `/formation/module//edit` +* **Résultat:** le module modifié. + +#### **`ue-edit`** + +* **Méthode:** POST +* **Permission: `EditFormation`** +* **Paramètres:** `ue_id` +* **Data:** +```json +{ + "acronyme" : str, + "numero" : int, // ordre d'affichage + "titre" : str, + "semestre_idx" : int, // le rang du semestre (S1, ...) + "type": int, // 0 std, 1 bonus sport, 2 projet&stage (old LP) + "ue_code" : str, + "ects" : float, + "is_external" : bool, // true pour externes + "code_apogee" : str, + "code_apogee_rcue" : str, + "coef_rcue" : float, + "coefficient" : float, // si option use_ue_coefs + "ects" : float, + "matiere_id" : int, // must be in same UE +} +``` +* **Routes:** `/formation/ue//edit` +* **Résultat:** l'UE modifiée. + + + ### **API Formsemestre** Les sessions de formation (qu'elles durent une année ou un mois) sont représentées par les `formsemestre`. diff --git a/docs/img/API_Chart.svg b/docs/img/API_Chart.svg index 1c618c427..a6c558bf7 100644 --- a/docs/img/API_Chart.svg +++ b/docs/img/API_Chart.svg @@ -1,2 +1,2 @@ -/ScoDoc/api/tokens?assiduite/<int:assiduite_id>/justificatifs/long?edit??ine/<ine>/create?nip/<nip>/create?etudid/<int:etudid>/create?<int:etudid>/create?delete?assiduites/ine/<ine>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?nip/<nip>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?etudid/<int:etudid>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?<int:etudid>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?group/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&?formsemestre/<int:formsemestre_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&?count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?create?edit?evaluation/<int:evaluation_id>/assiduites?notes/set??delete?billets_absence/etudiant/<int:etudid>?create?<int:billet_id>/delete?departements?departements_ids?departement/<string:acronym>/edit?delete?etudiants?formsemestres_ids?formsemestres_courants?date_courante=<string:date_courante>??id/<int:dept_id>/etudiants?formsemestres_ids?formsemestres_courants?date_courante=<string:date_courante>?logos?logo/<string:logoname>??create?<string:departement>/logos?logo/<string:logoname>?etudiants/courants/long?date_courante=<string:date_courante>?ine/<string:ine>?nip/<string:nip>?etudid/<int:etudid>?name/<string:start>?etudiant/ine/<string:ine>/photo?size=<string:size>?formsemestres??nip/<string:nip>/photo?size=<string:size>?formsemestres??etudid/<int:etudid>/photo?size=<string:size>?formsemestres?formsemestre/<int:formsemestre_id>/groups??<string:code_type>/<string:code>/formsemestre/<int:formsemestre_id>/bulletin/<string:version>/pdf/nosig?edit?annotation/<int:annotation_id>/delete??create/force?<int:etudid>/jury/validation_ue/<int:validation_id>/delete?validation_formsemestre/<int:validation_id>/delete?autorisation_inscription/<int:validation_id>/delete?validation_rcue/record?<int:validation_id>/delete?validation_annee_but/<int:validation_id>/delete?moduleimpl/<int:moduleimpl_id>/evaluations?evaluation/create?inscriptions?notes?formations?formations_ids?formation/<int:formation_id>/export_with_ids?export?referentiel_competences??ue/<int:ue_id>/set_parcours?assoc_niveau/<int:niveau_id>?desassoc_niveau?set_code_apogee/<string:code_apogee>??set_code_apogee_rcue/<string:code_apogee>??set_code_apogee?module/<int:module_id>/set_code_apogee/<string:code_apogee>??edit??set_code_apogee?formsemestre/<int:formsemestre_id>/edit?bulletins/<string:version>?programme?etudiants/long/query?etat=<string:etat>?query?etat=<string:etat>?etat_evals?resultats?format=<string:format>?get_groups_auto_assignment?save_groups_auto_assignment?edt?group_ids=<string:group_ids>&show_modules_titles=<bool:show_modules_titles>&?decisions_jury?partitions/order??partition/create??apo/set_etapes?set_elt_sem?set_elt_annee?set_elt_passage?formsemestres/query?etape_apo=<string:etape_apo>&annee_scolaire=<string:annee_scolaire>&dept_acronym=<string:dept_acronym>&dept_id=<int:dept_id>&etat=<int:etat>&nip=<string:nip>&ine=<string:ine>&?justificatif/<int:justif_id>/edit?import?export/<filename>?remove?list?justifies??ine/<ine>/create?nip/<nip>/create?etudid/<int:etudid>/create?<int:etudid>/create?delete?justificatifs/ine/<ine>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?nip/<nip>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?etudid/<int:etudid>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?<int:etudid>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?dept/<int:dept_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?formsemestre/<int:formsemestre_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?logos?logo/<string:logoname>?partition/<int:partition_id>/remove_etudiant/<int:etudid>?group/create?groups/order?edit?delete??group/<int:group_id>/etudiants/query?etat=<string:etat>??set_etudiant/<int:etudid>?remove_etudiant/<int:etudid>?delete?edit?set_edt_id/<string:edt_id>?user/<int:uid>/edit?password?role/<string:role_name>/add/departement/<string:dept>?remove/departement/<string:dept>??create?users/query?active=<bool:active>&departement=<string:departement>&starts_with=<string:starts_with>&?permissions?role/<string:role_name>/add_permission/<string:perm_name>?remove_permission/<string:perm_name>?edit?delete??create/<string:role_name>?roles? \ No newline at end of file +/ScoDoc/api/tokens?assiduite/<int:assiduite_id>/justificatifs/long?edit??ine/<ine>/create?nip/<nip>/create?etudid/<int:etudid>/create?<int:etudid>/create?delete?assiduites/ine/<ine>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?nip/<nip>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?etudid/<int:etudid>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?<int:etudid>/count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&?evaluations?group/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&?formsemestre/<int:formsemestre_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&?count/query?user_id=<int:user_id>&est_just=<bool:est_just>&moduleimpl_id=<int:moduleimpl_id>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&formsemestre_id=<int:formsemestre_id>&metric=<array[string]:metric>&split=<bool:split>&?create?edit?evaluation/<int:evaluation_id>/assiduites?notes/set??delete?billets_absence/etudiant/<int:etudid>?create?<int:billet_id>/delete?departements?departements_ids?departement/<string:acronym>/edit?delete?etudiants?formsemestres_ids?formsemestres_courants?date_courante=<string:date_courante>??id/<int:dept_id>/etudiants?formsemestres_ids?formsemestres_courants?date_courante=<string:date_courante>?logos?logo/<string:logoname>??create?<string:departement>/logos?logo/<string:logoname>?etudiants/courants/long?date_courante=<string:date_courante>?ine/<string:ine>?nip/<string:nip>?etudid/<int:etudid>?name/<string:start>?etudiant/ine/<string:ine>/photo?size=<string:size>?formsemestres??nip/<string:nip>/photo?size=<string:size>?formsemestres??etudid/<int:etudid>/photo?size=<string:size>?formsemestres?formsemestre/<int:formsemestre_id>/groups??<string:code_type>/<string:code>/formsemestre/<int:formsemestre_id>/bulletin/<string:version>/pdf/nosig?edit?annotation/<int:annotation_id>/delete??create/force?<int:etudid>/jury/validation_ue/<int:validation_id>/delete?validation_formsemestre/<int:validation_id>/delete?autorisation_inscription/<int:validation_id>/delete?validation_rcue/record?<int:validation_id>/delete?validation_annee_but/<int:validation_id>/delete?moduleimpl/<int:moduleimpl_id>/evaluations?evaluation/create?inscriptions?notes?formations?formations_ids?formation/<int:formation_id>/export_with_ids?export?referentiel_competences??ue/<int:ue_id>/set_parcours?assoc_niveau/<int:niveau_id>?desassoc_niveau?set_code_apogee/<string:code_apogee>??set_code_apogee_rcue/<string:code_apogee>??edit?set_code_apogee?module/<int:module_id>/set_code_apogee/<string:code_apogee>??edit??set_code_apogee?formsemestre/<int:formsemestre_id>/edit?bulletins/<string:version>?programme?etudiants/long/query?etat=<string:etat>?query?etat=<string:etat>?etat_evals?resultats?format=<string:format>?get_groups_auto_assignment?save_groups_auto_assignment?edt?group_ids=<string:group_ids>&show_modules_titles=<bool:show_modules_titles>&?decisions_jury?partitions/order??partition/create??apo/set_etapes?set_elt_sem?set_elt_annee?set_elt_passage?formsemestres/query?etape_apo=<string:etape_apo>&annee_scolaire=<string:annee_scolaire>&dept_acronym=<string:dept_acronym>&dept_id=<int:dept_id>&etat=<int:etat>&nip=<string:nip>&ine=<string:ine>&?justificatif/<int:justif_id>/edit?import?export/<filename>?remove?list?justifies??ine/<ine>/create?nip/<nip>/create?etudid/<int:etudid>/create?<int:etudid>/create?delete?justificatifs/ine/<ine>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?nip/<nip>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?etudid/<int:etudid>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?<int:etudid>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?dept/<int:dept_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?formsemestre/<int:formsemestre_id>/query?user_id=<int:user_id>&est_just=<bool:est_just>&date_debut=<string:date_debut_iso>&date_fin=<string:date_fin_iso>&etat=<array[string]:etat>&order=<bool:order>&courant=<bool:courant>&group_id=<int:group_id>&?logos?logo/<string:logoname>?partition/<int:partition_id>/remove_etudiant/<int:etudid>?group/create?groups/order?edit?delete??group/<int:group_id>/etudiants/query?etat=<string:etat>??set_etudiant/<int:etudid>?remove_etudiant/<int:etudid>?delete?edit?set_edt_id/<string:edt_id>?user/<int:uid>/edit?password?role/<string:role_name>/add/departement/<string:dept>?remove/departement/<string:dept>??create?users/query?active=<bool:active>&departement=<string:departement>&starts_with=<string:starts_with>&?permissions?role/<string:role_name>/add_permission/<string:perm_name>?remove_permission/<string:perm_name>?edit?delete??create/<string:role_name>?roles? \ No newline at end of file