From 6976a485b2ce0be66250db2a981f2ad8a36bd9d6 Mon Sep 17 00:00:00 2001 From: viennet Date: Thu, 23 Nov 2023 17:43:44 +0100 Subject: [PATCH] API etudiant/create,edit --- docs/GuideInstallDebian11Advanced.md | 4 +- docs/ScoDoc9API.md | 83 ++++++++++++++++++++++++++++ docs/index.md | 18 +++--- 3 files changed, 93 insertions(+), 12 deletions(-) diff --git a/docs/GuideInstallDebian11Advanced.md b/docs/GuideInstallDebian11Advanced.md index 3784a0d7e..8c2fb97d7 100644 --- a/docs/GuideInstallDebian11Advanced.md +++ b/docs/GuideInstallDebian11Advanced.md @@ -1,4 +1,4 @@ -# Configuration manuelle de ScoDoc sur Debian 11 (Bullseye) +# Configuration manuelle de ScoDoc sur Debian 11 (Bullseye) Instructions pour utilisateurs ne souhaitant pas utiliser le script @@ -8,7 +8,7 @@ Toutes les opérations décrites sur cette page sont effectuées par ce script. Cette page est donc destinée aux curieux et futurs développeurs. Se référer au script lui même pour les détails. -## Activation du firewall +## Activation du firewall (optionnel, recommandé) diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index e7d72ecf1..4b6011de1 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -310,6 +310,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 | | bulletin**`*`** | | GET | [formsemestre-bulletin](#formsemestre-bulletin) | ScoView | | bulletin | | GET | [etudiant-formsemestre-bulletin](#etudiant-formsemestre-bulletin) | ScoView | | programme | | GET | [formsemestre-programme](#formsemestre-programme) | ScoView | @@ -524,6 +526,87 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post- * **Note:** Cette fonction est utilisée pour la complétion des champs de formulaire (choix d'un étudiant). +#### **`etudiant-create`** + +* **Méthode: POST** +* **Permission: `ScoEtudInscrit`** +* **Paramètres:** `` +* **Data:** + +```json + { + "boursier" : , + "civilite" : , // M, F, X + "civilite_etat_civil" : , + "code_ine" : , + "code_nip" : , + "date_naissance" : , // format ISO + "dept" : , // acronyme du département + "dept_naissance" : , + "lieu_naissance" : , + "nationalite" : , + "nom" : , // requis + "nom_usuel" : , + "prenom" : , + "prenom_etat_civil" : , + + // Données concernant l'admission (avant son cursus ScoDoc) + "admission" : { + "annee" : , + "bac" : , + "specialite" : , + "annee_bac" : , + "math" : , + "physique" : , + "anglais" : , + "francais" : , + // Rang dans les voeux du candidat (non connu avec Parcoursup) + "rang" : , + // Qualité et décision du jury d'admission (ou de l'examinateur) + "qualite" : , // mesure arbitraire local + "rapporteur":, // chaine libre + "decision":,// chaine libre + "score":, // score arbitraire local + "commentaire":, + // Lycée d'origine: + "nomlycee" : , + "villelycee" : , + "codepostallycee" : , + "codelycee" : , + }, + + "adresses" : [ // liste mais seule la première est utilisée ! + { + "email" : , // email universitaire en général + "emailperso" : , // email personnel (exterieur) + "domicile" : , + "codepostaldomicile" : , + "villedomicile" : , + "paysdomicile" : , + "telephone" : , + "telephonemobile" : , + "description" : , + } + ] + } +``` + +* **Routes:** `/etudiant/create`, `/etudiant/create/force` +* **Exemple d'utilisation:** `/etudiant/create` +* **Résultat:** Crée un étudiant dans le département indiqué. + + +#### **`etudiant-edit`** + +* **Méthode: POST** +* **Permission: `ScoEtudInscrit`** +* **Paramètres:** `` +* **Data:** exactement comme `etudiant/create`, seuls les données passées sont modifiées. +* **Routes:** `/etudiant/edit. +* **Résultat:** Modifie les données de l'étudiant. + + + #### **departement-etudiants** * **Méthode:** GET diff --git a/docs/index.md b/docs/index.md index 240ca207f..9a4294037 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,5 @@ # ScoDoc: un logiciel libre pour le suivi de la scolarité - ScoDoc est un logiciel libre créé par Emmanuel Viennet pour suivre la scolarité des étudiants universitaires. Il est principalement utilisé dans les IUT, mais aussi apprécié par plusieurs Écoles et Masters en France et à l'étranger. Il @@ -49,11 +48,11 @@ retourner à `Emmanuel.Viennet at gmail.com`. ## Actualités -### Parution de ScoDoc 9.6.x pour Debian 12 +### Septembre 2023: parution de ScoDoc 9.6.x pour Debian 12 **9.6.x** est la version en production de ScoDoc. Y sont régulièrement intégrées des améliorations et de nouvelles fonctionnalités. Elle inclue notamment le -nouveau système de gestion des absences ("assiduités"), beaucoup plus riche que +nouveau système de gestion des absences ("assiduités"), beaucoup plus riche que l'ancien. **Il est conseillé de migrer au plus vite**: voir [la procédure de mise à @@ -81,14 +80,13 @@ gestion du *[Bachelor Universitaire de Technologie (BUT)](BUT.md)*. ### Contrats d'apprentissage -Depuis 2021, plusieurs étudiants ont été recrutés (BUT R&T Lannion, LP IUT -Orléans, LP IUT Villetaneuse): - - - développement d'une nouvelle API pour ScoDoc 9 (mise en service en juillet 2022); - - développement d'un nouveau module de gestion des relations entreprises: - fichier, contacts, stages, alternance (publiée en août 2022); - - refonte du module de gestion des absences (en cours en 2022-2023). +Depuis 2021, de nombreux étudiants ont été recrutés par l'association (BUT R&T +Lannion, LP IUT Orléans, LP IUT Villetaneuse, BUT Informatique Lannion): +- développement d'une nouvelle API pour ScoDoc 9 (mise en service en juillet 2022); +- développement d'un nouveau module de gestion des relations entreprises: + fichier, contacts, stages, alternance (publiée en août 2022); +- refonte du module de gestion des absences (en cours en 2022-2023, puis 2023-2024). ### Stagiaires