diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 54bc6f51..07292ce1 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -160,7 +160,6 @@ par le serveur ScoDoc. incorrecte, paramètre manquant, ou objet inexistant. * [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur inconnue côté serveur. - ## Départements @@ -173,7 +172,7 @@ par le serveur ScoDoc. ```json [ 1888, 999, 165 ] ``` - + #### **departement** * **Méthode:** GET @@ -182,15 +181,15 @@ par le serveur ScoDoc. * `/departement/` * **Résultat:** Un département * **Exemple de résultat:** - ```json - { +```json +{ "id": 1, "acronym": "TAPI", "description": null, "visible": true, "date_creation": "Fri, 15 Apr 2022 12:19:28 GMT" - }, - ``` +} +``` #### **departements** @@ -235,7 +234,7 @@ par le serveur ScoDoc. ... ] ``` - + #### **Formsemestres d'un département** * **Méthode:** GET @@ -259,7 +258,6 @@ par le serveur ScoDoc. * **Résultat:** Liste des formsemestres en cours d'un département donné. * **Exemple de résultat:** [formsemestre-courants.json](samples/sample_formsemestres-courants.json.md) - ### **Semestres** #### **Formsemestre** @@ -278,7 +276,7 @@ par le serveur ScoDoc. * ** Query string:** `etape_apo`, `annee_scolaire`, `dept_acronym`, `dept_id` * **Route:** `/formsemestres/query * **Exemple d'utilisation:** `/api/formsemestres/query?etape_apo=V7HU1&annee_scolaire=2021` -* **Résultat:** Données d'un formsemestre spécifié par son id. +* **Résultat:** Données d'un formsemestre spécifié par son id. Si plusieurs paramètres sont donnés, c'est la conjonction (ET) des critères qui est recherchée. Si aucun formsemestre ne satisfait la requ^te, une liste vide est retournée * **Exemple de résultat:** [formsemestres.json](samples/sample_formsemestres.json.md) #### **Bulletins d'un formsemestre** @@ -363,84 +361,30 @@ mais pas JSON compliant à cause des _NaN_. l'id passé en paramètres. Les codes INE et NIP sont uniques au sein d'un département. Si plusieurs objets étudiant ont le même code, on ramène le plus récemment inscrit. - * **Exemple de résultat:** - ``` - { - "civilite": "X", - "code_ine": "1", - "code_nip": "1", - "date_naissance": "", - "dept_id": 1, - "dept_acronym": "TAPI", - "email": "SACHA.COSTA@example.com", - "emailperso": "", - "etudid": 1, - "nom": "COSTA", - "prenom": "SACHA", - "nomprenom": "Sacha COSTA", - "lieu_naissance": "", - "dept_naissance": "", - "nationalite": "", - "boursier": "", - "id": 1, - "codepostaldomicile": "", - "paysdomicile": "", - "telephonemobile": "", - "typeadresse": "domicile", - "domicile": "", - "villedomicile": "", - "telephone": "", - "fax": "", - "description": "" - } - ``` + * **Exemple de résultat:** [etudiant.json](samples/sample_etudiant.json.md) + +#### **`tous les etudiants` (TODO)** + + * **Méthode:** GET + * **Routes:** `/etudiants + * **Exemple d'utilisation:** `/api/etudiants` + * **Résultat:** Liste complète de tous les étudiants (passés ou présents) pour lequel l'utilisateur a la permission ScoView. + * **Exemple de résultat:** [tous-les-etudiant.json](samples/sample_tous-les-etudiants.json.md) #### **`etudiants`** - * **Méthode:** GET - * **Paramètres:** `etudid`, `nip`, `ine` - * **Routes:** `/etudiants/etudid/` ou `/etudiants/nip/` ou `/etudiants/ine/` - * **Exemple d'utilisation:** `/api/etudiants/nip/1` - * **Résultat:** Info sur le ou les étudiants correspondants. - Comme `/etudiant` mais renvoie toujours une liste. +* **Méthode:** GET +* **Paramètres:** `etudid`, `nip`, `ine` +* **Routes:** `/etudiants/etudid/` ou `/etudiants/nip/` ou `/etudiants/ine/` +* **Exemple d'utilisation:** `/api/etudiants/nip/1` +* **Résultat:** Info sur le ou les étudiants correspondants. + Comme [`/etudiant`](ScoDoc9API.md#etudiant) mais renvoie toujours une liste. Si non trouvé, liste vide, pas d'erreur. Dans 99% des cas, la liste contient un seul étudiant, mais si l'étudiant a été inscrit dans plusieurs départements, on a plusieurs objets (1 par - dept.). - * **Exemple de résultat:** - ``` - [ - { - "civilite": "X", - "code_ine": "1", - "code_nip": "1", - "date_naissance": "", - "dept_id": 1, - "dept_acronym": "TAPI", - "email": "SACHA.COSTA@example.com", - "emailperso": "", - "etudid": 1, - "nom": "COSTA", - "prenom": "SACHA", - "nomprenom": "Sacha COSTA", - "lieu_naissance": "", - "dept_naissance": "", - "nationalite": "", - "boursier": "", - "id": 1, - "codepostaldomicile": "", - "paysdomicile": "", - "telephonemobile": "", - "typeadresse": "domicile", - "domicile": "", - "villedomicile": "", - "telephone": "", - "fax": "", - "description": "" - } - ] - ``` - + dept.). +* **Exemple de résultat:** [etudiants.json](samples/sample_etudiants.json.md) + ### Cursus #### **etudiant_formsemestres** @@ -456,7 +400,7 @@ mais pas JSON compliant à cause des _NaN_. ### Bulletin -#### **`etudiant_bulletin_semestre`** +#### **Bulletin d'un formsemestre d'un étudiant ** * **Méthode:** GET * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` @@ -472,216 +416,17 @@ mais pas JSON compliant à cause des _NaN_. Deux versions disponibles `long` et `short` (par défaut `long` ajoutez `/short` pour la version plus courte). - * **Exemple de résultat:** - ``` - { - "version": "0", - "type": "BUT", - "date": "2022-04-27T07:18:16.450634Z", - "publie": true, - "etudiant": { - "civilite": "X", - "code_ine": "1", - "code_nip": "1", - "date_naissance": "", - "email": "SACHA.COSTA@example.com", - "emailperso": "", - "etudid": 1, - "nom": "COSTA", - "prenom": "SACHA", - "nomprenom": "Sacha COSTA", - "lieu_naissance": "", - "dept_naissance": "", - "nationalite": "", - "boursier": "", - "fiche_url": "/ScoDoc/TAPI/Scolarite/ficheEtud?etudid=1", - "photo_url": "/ScoDoc/TAPI/Scolarite/get_photo_image?etudid=1&size=small", - "id": 1, - "codepostaldomicile": "", - "paysdomicile": "", - "telephonemobile": "", - "typeadresse": "domicile", - "domicile": "", - "villedomicile": "", - "telephone": "", - "fax": "", - "description": "" - }, - "formation": { - "id": 1, - "acronyme": "BUT R&T", - "titre_officiel": "Bachelor technologique réseaux et télécommunications", - "titre": "BUT R&T" - }, - "formsemestre_id": 1, - "etat_inscription": "I", - "options": { - "show_abs": true, - "show_abs_modules": false, - "show_ects": true, - "show_codemodules": false, - "show_matieres": false, - "show_rangs": true, - "show_ue_rangs": true, - "show_mod_rangs": true, - "show_moypromo": false, - "show_minmax": false, - "show_minmax_mod": false, - "show_minmax_eval": false, - "show_coef": true, - "show_ue_cap_details": false, - "show_ue_cap_current": true, - "show_temporary": true, - "temporary_txt": "Provisoire", - "show_uevalid": true, - "show_date_inscr": true - }, - "ressources": { - "R101": { - "id": 1, - "titre": "Initiation aux réseaux informatiques", - "code_apogee": null, - "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1", - "moyenne": {}, - "evaluations": [ - { - "id": 1, - "description": "eval1", - "date": "2022-04-20", - "heure_debut": "08:00", - "heure_fin": "09:00", - "coef": "01.00", - "poids": { - "RT1.1": 1 - }, - "note": { - "value": "12.00", - "min": "00.00", - "max": "18.00", - "moy": "10.88" - }, - "url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1" - } - ] - } - }, - "saes": { - "SAE11": { - "id": 2, - "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité", - "code_apogee": null, - "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2", - "moyenne": {}, - "evaluations": [] - } - }, - "ues": { - "RT1.1": { - "id": 1, - "titre": "Administrer les réseaux et l’Internet", - "numero": 1, - "type": 0, - "color": "#B80004", - "competence": null, - "moyenne": { - "value": "08.50", - "min": "06.00", - "max": "16.50", - "moy": "11.31", - "rang": "12", - "total": 16 - }, - "bonus": "00.00", - "malus": "00.00", - "capitalise": null, - "ressources": { - "R101": { - "id": 1, - "coef": 12, - "moyenne": "12.00" - } - }, - "saes": { - "SAE11": { - "id": 2, - "coef": 16, - "moyenne": "~" - } - }, - "ECTS": { - "acquis": 0, - "total": 12 - } - }, - "semestre": { - "etapes": [], - "date_debut": "2021-09-01", - "date_fin": "2022-08-31", - "annee_universitaire": "2021 - 2022", - "numero": 1, - "inscription": "", - "groupes": [], - "absences": { - "injustifie": 1, - "total": 2 - }, - "ECTS": { - "acquis": 0, - "total": 30 - }, - "notes": { - "value": "10.60", - "min": "02.40", - "moy": "11.05", - "max": "17.40" - }, - "rang": { - "value": "10", - "total": 16 - } - } - } - } - ``` + * **Exemple de résultat:** [bulletin-formsemestre-etudiant.json](samples/sample_bulletin-formsemestre-etudiant.json.md) -#### **`etudiant_groups`** +#### **Groupes d'un formsemestre d'un étudiant** * **Méthode:** GET * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Routes:** `/etudiant/etudid//semestre//groups` ou `/etudiant/nip//semestre//groups` ou `/etudiant/ine//semestre//groups` * **Exemple d'utilisation:** `/etudiant/nip/1/semestre/1/groups` * **Résultat:** Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json) - * **Exemple de résultat:** - ``` - [ - { - "partition_id": 1, - "id": 1, - "formsemestre_id": 1, - "partition_name": "TD", - "numero": 0, - "bul_show_rank": false, - "show_in_lists": true, - "group_id": 1, - "group_name": "B" - }, - { - "partition_id": 2, - "id": 2, - "formsemestre_id": 1, - "partition_name": "TP", - "numero": 1, - "bul_show_rank": false, - "show_in_lists": true, - "group_id": 2, - "group_name": "A" - }, - ... - ] - ``` - - + * **Exemple de résultat:** [groupes-formsemestre-etudiant.json](samples/sample_groupes-formsemestre-etudiant.json.md) ## Programmes de formations @@ -724,106 +469,21 @@ mais pas JSON compliant à cause des _NaN_. * **Exemple d'utilisation:** `/ScoDoc/api/formations` * **Résultat:** Retourne la liste de toutes les formations (tous départements) - + ### Export programme -#### **`formation_export`** +#### **`formation export`** * **Méthode:** GET * **Paramètres:** `formation_id`, `export_ids` (False par défaut. Ajouter `/with_ids` pour le passer à True) - * **Routes:** `/formation/formation_export/` + * **Routes:** + * `/formation/export/` + * `/formation/export//with_ids` * **Exemple d'utilisation:** `/ScoDoc/api/formation/formation_export/1` * **Résultat:** Retourne la formation, avec UE, matières, modules * **Exemple de résultat:** - ``` - { - "id": 1, - "acronyme": "BUT R&T", - "titre_officiel": "Bachelor technologique réseaux et télécommunications", - "formation_code": "V1RET", - "code_specialite": null, - "dept_id": 1, - "titre": "BUT R&T", - "version": 1, - "type_parcours": 700, - "referentiel_competence_id": null, - "formation_id": 1, - "ue": [ - { - "acronyme": "RT1.1", - "numero": 1, - "titre": "Administrer les réseaux et l’Internet", - "type": 0, - "ue_code": "UCOD11", - "ects": 12, - "is_external": false, - "code_apogee": "", - "coefficient": 0, - "semestre_idx": 1, - "color": "#B80004", - "reference": 1, - "matiere": [ - { - "titre": "Administrer les réseaux et l’Internet", - "numero": 1, - "module": [ - { - "titre": "Initiation aux réseaux informatiques", - "abbrev": "Init aux réseaux informatiques", - "code": "R101", - "heures_cours": 0, - "heures_td": 0, - "heures_tp": 0, - "coefficient": 1, - "ects": "", - "semestre_id": 1, - "numero": 10, - "code_apogee": "", - "module_type": 2, - "coefficients": [ - { - "ue_reference": "1", - "coef": "12.0" - }, - { - "ue_reference": "2", - "coef": "4.0" - }, - { - "ue_reference": "3", - "coef": "4.0" - } - ] - }, - { - "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité", - "abbrev": "Hygiène informatique", - "code": "SAE11", - "heures_cours": 0, - "heures_td": 0, - "heures_tp": 0, - "coefficient": 1, - "ects": "", - "semestre_id": 1, - "numero": 10, - "code_apogee": "", - "module_type": 3, - "coefficients": [ - { - "ue_reference": "1", - "coef": "16.0" - } - ] - } - ] - } - ] - } - ] - } - ``` -#### Référentiel de compétences +#### Référentiel de compétences [formation-export.json](samples/sample_formation-export.json.md) #### **`referentiel_competences`** @@ -834,7 +494,6 @@ mais pas JSON compliant à cause des _NaN_. * **Résultat:** Le référentiel de compétences d'une formation donnée (json). (_pas toujours présent_) XXX obtenir la liste des référentiels ? - ## Formsemestres @@ -896,7 +555,6 @@ Les sessions de formation (qu'elles durent une année ou un mois) sont représen [ { formsemestre comme ci-dessus }, ... ] ``` - ### Note sur les identifiants de formsemestre Le `session_id` peut être utilisé pour identifier de façon prévisible et (presque) unique un formsemestre) dans un établissement, ce qui est utile @@ -918,7 +576,7 @@ des informations suivantes: **Exemple:** `INFO-DUT-FI-S1-2014` équivaut à un semestre S1 d'un DUT informatique de 2014 en formation initiale (FI) ### Étudiants inscrits et bulletins -#### **etudiants** +#### **etudiants d'un formsemestre** * **Méthode:** GET * **Paramètres:** `formsemestre_id`, `etat` (par défaut égal à "I" pour les étudiants inscrits) * **Routes:** `/formsemestre//etudiants` XXX voir si @@ -926,7 +584,7 @@ des informations suivantes: * **Résultat:** les étudiants inscrits à ce semestres XXX préciser état (DEM, DEF)) -#### * **`bulletins`** +#### * **`bulletins d'un formsemestre`** * **Méthode:** GET * **Paramètres:** `formsemestre_id` @@ -1107,7 +765,7 @@ des informations suivantes: ] ``` -#### **etat_evals** +#### **etat_evals d'un formsemestre** * **Méthode:** GET * **Paramètres:** `formsemestre_id` diff --git a/docs/img/API_Chart.odg b/docs/img/API_Chart.odg index dd08d58e..ba11a638 100644 Binary files a/docs/img/API_Chart.odg and b/docs/img/API_Chart.odg differ diff --git a/docs/img/API_Chart.svg b/docs/img/API_Chart.svg index 8e21d442..9d470e78 100644 --- a/docs/img/API_Chart.svg +++ b/docs/img/API_Chart.svg @@ -92,7 +92,7 @@ - + @@ -619,119 +619,119 @@ - - - - formation + + + + formation - - - - formations_ids + + + + formations_ids - - - - / + + + + / - - - + + + - - - + + + - - - + + + - - - - <int:formation_id> + + + + <int:formation_id> - - - - moduleimpl + + + + moduleimpl - - - - / + + + + / - - - - <int:moduleimpl_id> + + + + <int:moduleimpl_id> - - - - formation_export + + + + formation_export - - - - / + + + + / - - - - <int:formation_id> + + + + <int:formation_id> - - - - with_ids + + + + with_ids - - - - referentiel_competence + + + + referentiel_competence @@ -791,1777 +791,2416 @@ - - - - / + + + + / - - - - ? - id317 + + + + ? + id388 - - - - ? - id318 + + + + ? + id389 - - - - ? - id319 + + + + ? + id390 - - - - ? - id320 + + + + ? + id391 - - - - ? - id321 + + + + ? + id392 - - - - formsemestres + + + + formsemestres - - - - / + + + + / - - - - query + + + + query - - - - ? + + + + ? - - - - & + + + + & - - - - etape_apo + + + + etape_apo - - - - = + + + + = - - - - <string:etape_apo> + + + + <string:etape_apo> - - - - annee_scolaire + + + + annee_scolaire - - - - = + + + + = - - - - <int:annee> + + + + <int:annee> - - - - dept_acronym + + + + dept_acronym - - - - = + + + + = - - - - <string:acronym> + + + + <string:acronym> - - - - dept_id + + + + dept_id - - - - = + + + + = - - - - <int:dept_id> + + + + <int:dept_id> - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - formsemestre + + + + formsemestre - - - - / + + + + / - - - - <int:formsemestre_id> + + + + <int:formsemestre_id> - - - - / + + + + / - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - ? + + + + ? - - - + + + - - - - bulletins + + + + bulletins - - - - jury + + + + jury - - - - programme + + + + programme - - - - etudiants + + + + etudiants - - - - / + + + + / - - - - demissionnaires + + + + demissionnaires - - - - defaillants + + + + defaillants - - - + + + - - - + + + - - - - etat_evals + + + + etat_evals - - - - partitions + + + + partitions - - - - resultats + + + + resultats - - - - ? + + + + ? - - - - format + + + + format - - - - = + + + + = - - - - raw + + + + raw - - - + + + - - - - / + + + + / - - - - create + + + + create - - - - logos + + + + logos - - - - / + + + + / - - - - <string:logo_name> + + + + <string:logo_name> - - - - user + + + + user - - - - / + + + + / - - - - <int:id> + + + + <int:id> - - - - order + + + + order - - - + + + - - - + + + - - - - group + + + + group - - - - / + + + + / - - - - <int:group_id> + + + + <int:group_id> - - - - / + + + + / - - - - etudiants + + + + etudiants - - - - query + + + + query - - - - edit + + + + edit - - - - delete + + + + delete - - - - ? + + + + ? - - - - etat + + + + etat - - - - = + + + + = - - - - <string:etat> + + + + <string:etat> - - - - set_etudiant + + + + set_etudiant - - - - / + + + + / - - - - <int:etudiant_id> + + + + <int:etudiant_id> - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - partition + + + + partition - - - - / + + + + / - - - - <int:partition_id> + + + + <int:partition_id> - - - - / + + + + / - - - + + + - - - + + + - - - + + + - - - - edit + + + + edit - - - - delete + + + + delete - - - - remove_etudiant + + + + remove_etudiant - - - - / + + + + / - - - - <int:etudiant_id> + + + + <int:etudiant_id> - - - - group + + + + group - - - - / + + + + / - - - - create + + + + create - - - + + + - - - - evaluations + + + + evaluations - - - - / + + + + / - - - - <int:moduleimpl_id> + + + + <int:moduleimpl_id> - - - - eval_notes + + + + eval_notes - - - - <int:evaluaton_id> + + + + <int:evaluaton_id> - - - + + + - - - + + + - - - - jury + + + + jury - - - - / + + + + / - - - - <int:formsemestre_id> + + + + <int:formsemestre_id> - - - - formsemestre + + + + formsemestre - - - - preparation_jury + + + + preparation_jury - - - - decisions_jury + + + + decisions_jury - - - + + + - - - + + + - - - - / + + + + / - - - - / + + + + / - - - - groups + + + + groups - - - - / + + + + / - - - - order + + + + order - - - + + + - - - - absences + + + + absences - - - - etudid + + + + etudid - - - - <int:etudid> + + + + <int:etudid> - - - - / + + + + / - - - - nip + + + + nip - - - - <string:nip> + + + + <string:nip> - - - - / + + + + / - - - - ine + + + + ine - - - - <int:ine> + + + + <int:ine> - - - - / + + + + / - - - - / + + + + / - - - + + + - - - + + + - - - + + + - - - + + + - - - - / + + + + / - - - + + + - - - + + + - - - - just + + + + just - - - - / + + + + / - - - + + + - - - + + + - - - - abs_annule + + + + abs_annule - - - + + + - - - - / + + + + / - - - - ? + + + + ? - - - + + + - - - - etudid + + + + etudid - - - - <int:etudid> + + + + <int:etudid> - - - - / + + + + / - - - - jour + + + + jour - - - - <string:jour> + + + + <string:jour> - - - - / + + + + / - - - - matin + + + + matin - - - - <string:matin> + + + + <string:matin> - - - - / + + + + / - - - - / + + + + / - - - - & + + + + & - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - <int:etudid> + + + + <int:etudid> - - - + + + - - - - abs_annule_justif + + + + abs_annule_justif - - - - etudid + + + + etudid - - - - <int:etudid> + + + + <int:etudid> - - - - / + + + + / - - - - jour + + + + jour - - - - <string:jour> + + + + <string:jour> - - - - / + + + + / - - - - matin + + + + matin - - - - <string:matin> + + + + <string:matin> - - - - / + + + + / - - - - / + + + + / - - - - ? + + + + ? - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - - abs_group_etat + + + + abs_group_etat - - - - <int:group_id> + + + + <int:group_id> - - - - / + + + + / - - - + + + - - - - / + + + + / - - - - date_debut + + + + date_debut - - - - / + + + + / - - - - <date:date_debut> + + + + <date:date_debut> - - - - / + + + + / - - - - date_fin + + + + date_fin - - - - / + + + + / - - - - <date:date_fin> + + + + <date:date_fin> - - - + + + - - - + + + - - - - / + + + + / - - - - ? + + + + ? - - - + + + - - - - list_abs + + + + list_abs - - - - / + + + + / - - - - / + + + + / - - - + + + - - - - / + + + + / - - - - <int:etudid> + + + + <int:etudid> - - - - <string:list_abs> + + + + <string:list_abs> - - - - / + + + + / - - - + + + - - - - reset_etud_abs + + + + reset_etud_abs - - - - only_not_just + + + + only_not_just - - - - only_just + + + + only_just - - - - / + + + + / - - - + + + - - - + + + - - - - / + + + + / + + + + + + + + ? + id393 + + + + + + + + ? + id394 + + + + + + + + ? + id395 + + + + + + + + ? + id396 + + + + + + + + ? + id397 + + + + + + + + ? + id398 + + + + + + + + ? + id399 + + + + + + + + ? + id400 + + + + + + + + ? + id401 + + + + + + + + ? + id402 + + + + + + + + ? + id403 + + + + + + + + ? + id404 + + + + + + + + ? + id405 + + + + + + + + ? + id406 + + + + + + + + ? + id407 + + + + + + + + ? + id408 + + + + + + + + ? + id409 + + + + + + + + ? + id410 + + + + + + + + ? + id411 + + + + + + + + ? + id412 + + + + + + + + ? + id413 + + + + + + + + ? + id414 + + + + + + + + ? + id415 + + + + + + + + ? + id416 + + + + + + + + ? + id417 + + + + + + + + ? + id418 + + + + + + + + ? + id419 + + + + + + + + ? + id420 + + + + + + + + ? + id421 + + + + + + + + ? + id422 + + + + + + + + ? + id423 + + + + + + + + ? + id424 + + + + + + + + ? + id425 + + + + + + + + ? + id426 + + + + + + + + ? + id427 + + + + + + + + ? + id428 + + + + + + + + ? + id429 + + + + + + + + ? + id430 + + + + + + + + ? + id431 + + + + + + + + ? + id432 + + + + + + + + ? + id433 + + + + + + + + ? + id434 + + + + + + + + ? + id435 + + + + + + + + ? + id436 + + + + + + + + ? + id437 + + + + + + + + ? + id438 + + + + + + + + ? + id439 + + + + + + + + ? + id440 + + + + + + + + ? + id441 + + + + + + + + ? + id442 + + + + + + + + ? + id443 + + + + + + + + ? + id444 + + + + + + + + ? + id445 + + + + + + + + ? + id446 + + + + + + + + ? + id447 + + + + + + + + ? + id448 + + + + + + + + ? + id449 + + + + + + + + ? + id450 + + + + + + + + ? + id451 + + + + + + + + ? + id452 + + + + + + + + ? + id453 + + + + + + + + ? + id454 + + + + + + + + ? + id455 + + + + + + + + ? + id456 + + + + + + + + ? + id457 + + + + + + + + ? + id458 + + + + + + + + ? + id459 + + + + + + + + ? + id460 + + + + + + + + ? + id461 + + + + + + + + ? + id462 + + + + + + + + ? + id463 diff --git a/docs/samples/sample_bulletin-formsemestre-etudiant.json.md b/docs/samples/sample_bulletin-formsemestre-etudiant.json.md new file mode 100644 index 00000000..8ef7932d --- /dev/null +++ b/docs/samples/sample_bulletin-formsemestre-etudiant.json.md @@ -0,0 +1,173 @@ +### bulletin-formsemestre-etudiant + + +```json + { + "version": "0", + "type": "BUT", + "date": "2022-04-27T07:18:16.450634Z", + "publie": true, + "etudiant": { + "civilite": "X", + "code_ine": "1", + "code_nip": "1", + "date_naissance": "", + "email": "SACHA.COSTA@example.com", + "emailperso": "", + "etudid": 1, + "nom": "COSTA", + "prenom": "SACHA", + "nomprenom": "Sacha COSTA", + "lieu_naissance": "", + "dept_naissance": "", + "nationalite": "", + "boursier": "", + "fiche_url": "/ScoDoc/TAPI/Scolarite/ficheEtud?etudid=1", + "photo_url": "/ScoDoc/TAPI/Scolarite/get_photo_image?etudid=1&size=small", + "id": 1, + "codepostaldomicile": "", + "paysdomicile": "", + "telephonemobile": "", + "typeadresse": "domicile", + "domicile": "", + "villedomicile": "", + "telephone": "", + "fax": "", + "description": "" + }, + "formation": { + "id": 1, + "acronyme": "BUT R&T", + "titre_officiel": "Bachelor technologique réseaux et télécommunications", + "titre": "BUT R&T" + }, + "formsemestre_id": 1, + "etat_inscription": "I", + "options": { + "show_abs": true, + "show_abs_modules": false, + "show_ects": true, + "show_codemodules": false, + "show_matieres": false, + "show_rangs": true, + "show_ue_rangs": true, + "show_mod_rangs": true, + "show_moypromo": false, + "show_minmax": false, + "show_minmax_mod": false, + "show_minmax_eval": false, + "show_coef": true, + "show_ue_cap_details": false, + "show_ue_cap_current": true, + "show_temporary": true, + "temporary_txt": "Provisoire", + "show_uevalid": true, + "show_date_inscr": true + }, + "ressources": { + "R101": { + "id": 1, + "titre": "Initiation aux réseaux informatiques", + "code_apogee": null, + "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1", + "moyenne": {}, + "evaluations": [ + { + "id": 1, + "description": "eval1", + "date": "2022-04-20", + "heure_debut": "08:00", + "heure_fin": "09:00", + "coef": "01.00", + "poids": { + "RT1.1": 1 + }, + "note": { + "value": "12.00", + "min": "00.00", + "max": "18.00", + "moy": "10.88" + }, + "url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1" + } + ] + } + }, + "saes": { + "SAE11": { + "id": 2, + "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité", + "code_apogee": null, + "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2", + "moyenne": {}, + "evaluations": [] + } + }, + "ues": { + "RT1.1": { + "id": 1, + "titre": "Administrer les réseaux et l’Internet", + "numero": 1, + "type": 0, + "color": "#B80004", + "competence": null, + "moyenne": { + "value": "08.50", + "min": "06.00", + "max": "16.50", + "moy": "11.31", + "rang": "12", + "total": 16 + }, + "bonus": "00.00", + "malus": "00.00", + "capitalise": null, + "ressources": { + "R101": { + "id": 1, + "coef": 12, + "moyenne": "12.00" + } + }, + "saes": { + "SAE11": { + "id": 2, + "coef": 16, + "moyenne": "~" + } + }, + "ECTS": { + "acquis": 0, + "total": 12 + } + }, + "semestre": { + "etapes": [], + "date_debut": "2021-09-01", + "date_fin": "2022-08-31", + "annee_universitaire": "2021 - 2022", + "numero": 1, + "inscription": "", + "groupes": [], + "absences": { + "injustifie": 1, + "total": 2 + }, + "ECTS": { + "acquis": 0, + "total": 30 + }, + "notes": { + "value": "10.60", + "min": "02.40", + "moy": "11.05", + "max": "17.40" + }, + "rang": { + "value": "10", + "total": 16 + } + } + } + } +``` diff --git a/docs/samples/sample_etudiant.json.md b/docs/samples/sample_etudiant.json.md index 8ac17ac2..56ccb9f7 100644 --- a/docs/samples/sample_etudiant.json.md +++ b/docs/samples/sample_etudiant.json.md @@ -1,4 +1,35 @@ -### etudiants_courant +### etudiant -`/api/etudiants/9537` +`/api/etudiant/9537` + +```json +{ + "civilite": "F", + "code_ine": "999999999GC", + "code_nip": "42101034", + "date_naissance": "29/09/2002", + "dept_id": 6, + "dept_acronym": "INFO", + "email": "anais.durand.etu@univ-lille.fr", + "emailperso": "anais.durand@laposte.net", + "etudid": 9537, + "nom": "DURAND", + "prenom": "ANAIS", + "nomprenom": "Mme Anais DURAND", + "lieu_naissance": "BESANCON", + "dept_naissance": "", + "nationalite": "FR", + "boursier": true, + "codepostaldomicile": "59251", + "paysdomicile": "FRANCE", + "telephonemobile": "0788498979", + "typeadresse": "domicile", + "id": 11911, + "domicile": "18b rue de scodoc", + "villedomicile": "ALLENNES LES MARAIS", + "telephone": "0720584624", + "fax": "", + "description": "(infos admission)" +} +``` diff --git a/docs/samples/sample_etudiants-courant.json.md b/docs/samples/sample_etudiants-courant.json.md index 99841a45..84bf46f1 100644 --- a/docs/samples/sample_etudiants-courant.json.md +++ b/docs/samples/sample_etudiants-courant.json.md @@ -27,7 +27,7 @@ ou -`/api/etudiants/courant` +`/api/etudiants/courant/long` ```json [ { diff --git a/docs/samples/sample_etudiants.json.md b/docs/samples/sample_etudiants.json.md new file mode 100644 index 00000000..2049e184 --- /dev/null +++ b/docs/samples/sample_etudiants.json.md @@ -0,0 +1,37 @@ +### etudiants + +`/api/etudiants/9537` + +```json +[ + { + "civilite": "F", + "code_ine": "999999999GC", + "code_nip": "42101034", + "date_naissance": "29/09/2002", + "dept_id": 6, + "dept_acronym": "INFO", + "email": "anais.durand.etu@univ-lille.fr", + "emailperso": "anais.durand@laposte.net", + "etudid": 9537, + "nom": "DURAND", + "prenom": "ANAIS", + "nomprenom": "Mme Anais DURAND", + "lieu_naissance": "BESANCON", + "dept_naissance": "", + "nationalite": "FR", + "boursier": true, + "codepostaldomicile": "59251", + "paysdomicile": "FRANCE", + "telephonemobile": "0788498979", + "typeadresse": "domicile", + "id": 11911, + "domicile": "18b rue de scodoc", + "villedomicile": "ALLENNES LES MARAIS", + "telephone": "0720584624", + "fax": "", + "description": "(infos admission)" + } +] +``` + diff --git a/docs/samples/sample_formation-export.json.md b/docs/samples/sample_formation-export.json.md new file mode 100644 index 00000000..df7f73eb --- /dev/null +++ b/docs/samples/sample_formation-export.json.md @@ -0,0 +1,80 @@ +### formation-export + +/api/formation/export/1 + +```json +{ + "id": 374, + "acronyme": "BUT Informatique", + "titre_officiel": "Licence professionnelle", + "formation_code": "BUT_INFO", + "code_specialite": null, + "dept_id": 6, + "titre": "BUT Informatique", + "version": 2, + "type_parcours": 700, + "referentiel_competence_id": null, + "departement": { + "id": 6, + "acronym": "INFO", + "description": "migré de ScoDoc7", + "visible": true, + "date_creation": "Thu, 04 Nov 2021 14:45:13 GMT" + }, + "formation_id": 374, + "ue": [ + { + "acronyme": "UE 1.1", + "numero": 1, + "titre": "Réaliser un développement d'application", + "type": 0, + "ue_code": "UCOD11", + "ects": 1.0, + "is_external": false, + "code_apogee": "", + "coefficient": 0.0, + "semestre_idx": 1, + "color": "#B80004", + "niveau_competence_id": "", + "coef_rcue": 1.0, + "reference": 2074, + "matiere": [ + { + "titre": "Réaliser un développement d'application", + "numero": 1, + "module": [ + { + "titre": "Initiation au dév.", + "abbrev": "Dév", + "code": "R1.01", + "heures_cours": 0.0, + "heures_td": 0.0, + "heures_tp": 0.0, + "coefficient": 1.0, + "ects": "", + "semestre_id": 1, + "numero": 10, + "code_apogee": "", + "module_type": 2, + "coefficients": [ + { + "ue_reference": "2074", + "coef": "0.42" + }, + { + "ue_reference": "2081", + "coef": "0.24" + }, + ... + ] + }, + ... + ] + }, + ... + ] + }, + ... + ] +} +``` diff --git a/docs/samples/sample_formsemestres.json.md b/docs/samples/sample_formsemestres.json.md index 2e60e944..31f539f8 100644 --- a/docs/samples/sample_formsemestres.json.md +++ b/docs/samples/sample_formsemestres.json.md @@ -1,39 +1,110 @@ ### formsemestres -`/api/formsemestres/query?etape_apo=V7HU1&annee_scolaire=2021` +`/api/formsemestres/query?etape_apo=XIT123&annee_scolaire=2021` -```json -{ - "block_moyennes": false, - "bul_bgcolor": "white", - "bul_hide_xml": false, - "date_debut_iso": "2021-09-01", - "date_debut": "01/09/2021", - "date_fin_iso": "2022-08-31", - "date_fin": "31/08/2022", - "dept_id": 1, - "elt_annee_apo": "V7HU", - "elt_sem_apo": null, - "ens_can_edit_eval": false, - "etat": true, - "formation_id": 1, - "formsemestre_id": 1, - "gestion_compensation": false, - "gestion_semestrielle": false, - "id": 1, - "modalite": "FI", - "resp_can_change_ens": true, - "resp_can_edit": false, - "responsables": [ - 12, - 42 - ], - "scodoc7_id": null, - "semestre_id": 1, - "titre_num": "BUT MMI semestre 1", - "titre": "BUT MMI", - "titre_formation": "BUT MMI" - } -``` Le `titre`est celui donné par l'utilisateur dans le formsemestre, tandis que le `titre_formation` est l'acronyme de la formation (défini dans son programme pédagogique). + +```json +[ + { + "id": 819, + "modalite": "FI", + "ens_can_edit_eval": true, + "formation_id": 301, + "gestion_compensation": true, + "elt_sem_apo": null, + "semestre_id": 3, + "bul_hide_xml": false, + "elt_annee_apo": null, + "titre": "DUT Informatique (PPN 2013)", + "block_moyennes": false, + "scodoc7_id": "SEM43037", + "date_debut": "01/09/2021", + "gestion_semestrielle": true, + "date_fin": "31/01/2022", + "bul_bgcolor": "white", + "etat": false, + "resp_can_edit": true, + "dept_id": 6, + "resp_can_change_ens": false, + "parcours": [], + "annee_scolaire": "2021 - 2022", + "formsemestre_id": 819, + "titre_num": "DUT Informatique (PPN 2013) semestre 3", + "date_debut_iso": "2021-09-01", + "date_fin_iso": "2022-01-31", + "responsables": [ + 565 + ], + "titre_court": "DUT Info.", + "session_id": "INFO-DUT-FI-S3-2021" + }, + { + "id": 909, + "modalite": "FI", + "ens_can_edit_eval": false, + "formation_id": 301, + "gestion_compensation": false, + "elt_sem_apo": null, + "semestre_id": 4, + "bul_hide_xml": false, + "elt_annee_apo": null, + "titre": "DUT Informatique (PPN 2013)", + "block_moyennes": false, + "scodoc7_id": null, + "date_debut": "17/01/2022", + "gestion_semestrielle": false, + "date_fin": "30/06/2022", + "bul_bgcolor": "white", + "etat": false, + "resp_can_edit": false, + "dept_id": 6, + "resp_can_change_ens": false, + "parcours": [], + "annee_scolaire": "2021 - 2022", + "formsemestre_id": 909, + "titre_num": "DUT Informatique (PPN 2013) semestre 4", + "date_debut_iso": "2022-01-17", + "date_fin_iso": "2022-06-30", + "responsables": [ + 565 + ], + "titre_court": "DUT Info.", + "session_id": "INFO-DUT-FI-S4-2021" + }, + { + "id": 912, + "modalite": "FC", + "ens_can_edit_eval": true, + "formation_id": 332, + "gestion_compensation": false, + "elt_sem_apo": null, + "semestre_id": 4, + "bul_hide_xml": false, + "elt_annee_apo": null, + "titre": "DUT Informatique (PPN 2013)", + "block_moyennes": false, + "scodoc7_id": null, + "date_debut": "17/01/2022", + "gestion_semestrielle": false, + "date_fin": "30/06/2022", + "bul_bgcolor": "white", + "etat": false, + "resp_can_edit": true, + "dept_id": 6, + "resp_can_change_ens": true, + "parcours": [], + "annee_scolaire": "2021 - 2022", + "formsemestre_id": 912, + "titre_num": "DUT Informatique (PPN 2013) semestre 4", + "date_debut_iso": "2022-01-17", + "date_fin_iso": "2022-06-30", + "responsables": [ + 565 + ], + "titre_court": "DUT Info. FC", + "session_id": "INFO-DUT-FC-S4-2021" + } +] +``` diff --git a/docs/samples/sample_groupes-formsemestre-etudiant.json.md b/docs/samples/sample_groupes-formsemestre-etudiant.json.md new file mode 100644 index 00000000..6dffd8be --- /dev/null +++ b/docs/samples/sample_groupes-formsemestre-etudiant.json.md @@ -0,0 +1,31 @@ +### groupes-formsemestre-etudiant + +`/api/etudiants/9537` + +```json +[ + { + "partition_id": 1, + "id": 1, + "formsemestre_id": 1, + "partition_name": "TD", + "numero": 0, + "bul_show_rank": false, + "show_in_lists": true, + "group_id": 1, + "group_name": "B" + }, + { + "partition_id": 2, + "id": 2, + "formsemestre_id": 1, + "partition_name": "TP", + "numero": 1, + "bul_show_rank": false, + "show_in_lists": true, + "group_id": 2, + "group_name": "A" + }, + ... +] +``` diff --git a/docs/samples/sample_tous-les-etudiants.json.md b/docs/samples/sample_tous-les-etudiants.json.md new file mode 100644 index 00000000..05d0eec9 --- /dev/null +++ b/docs/samples/sample_tous-les-etudiants.json.md @@ -0,0 +1,38 @@ +### tous les etudiants + +`/api/etudiants/` + +```json +[ + { + "civilite": "X", + "code_ine": "1", + "code_nip": "1", + "date_naissance": "", + "dept_id": 1, + "dept_acronym": "TAPI", + "email": "SACHA.COSTA@example.com", + "emailperso": "", + "etudid": 1, + "nom": "COSTA", + "prenom": "SACHA", + "nomprenom": "Sacha COSTA", + "lieu_naissance": "", + "dept_naissance": "", + "nationalite": "", + "boursier": "", + "id": 1, + "codepostaldomicile": "", + "paysdomicile": "", + "telephonemobile": "", + "typeadresse": "domicile", + "domicile": "", + "villedomicile": "", + "telephone": "", + "fax": "", + "description": "" + }, + ... +] +``` +