diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 9f333982..42b80cdc 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -247,82 +247,6 @@ informations suivantes: * **Exemple d'utilisation:** `api/departements/MMI/formations/1/referentiel_competences` * **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 - - - * **`semestre_index`** - * **Méthode:** GET - * **Paramètres:** `dept`, `formsemestre_id` - * **Routes:** `/departements//formsemestre//programme` - * **Exemple d'utilisation:** `api/departements/MMI/formsemestre/1/programme` - * **Résultat:** Retourne la liste des Ues, ressources et SAE d'un semestre (json). - * **Exemple de résultat:** - ``` - { - "ues": [ - { - "type": 0, - "formation_id": 1, - "ue_code": "UCOD11", - "id": 1, - "ects": 12, - "acronyme": "RT1.1", - "is_external": false, - "numero": 1, - "code_apogee": "", - "titre": "Administrer les réseaux et l’Internet", - "coefficient": 0, - "semestre_idx": 1, - "color": "#B80004", - "ue_id": 1 - }, - ... - ], - "ressources": [ - { - "titre": "Fondamentaux de la programmation", - "coefficient": 1, - "module_type": 2, - "id": 17, - "ects": null, - "abbrev": null, - "ue_id": 3, - "code": "R107", - "formation_id": 1, - "heures_cours": 0, - "matiere_id": 3, - "heures_td": 0, - "semestre_id": 1, - "heures_tp": 0, - "numero": 70, - "code_apogee": "", - "module_id": 17 - }, - ... - ], - "saes": [ - { - "titre": "Se présenter sur Internet", - "coefficient": 1, - "module_type": 3, - "id": 14, - "ects": null, - "abbrev": null, - "ue_id": 3, - "code": "SAE14", - "formation_id": 1, - "heures_cours": 0, - "matiere_id": 3, - "heures_td": 0, - "semestre_id": 1, - "heures_tp": 0, - "numero": 40, - "code_apogee": "", - "module_id": 14 - }, - ... - ] - } - ``` @@ -337,28 +261,19 @@ informations suivantes: ``` [ { - "civilite": "X", - "code_ine": null, - "code_nip": null, - "date_naissance": null, - "email": null, - "emailperso": null, - "etudid": 18, + "id": 1, + "nip": 1, "nom": "MOREL", - "prenom": "JACQUES" + "prenom": "JACQUES", + "civilite": "X" }, { - "civilite": "X", - "code_ine": null, - "code_nip": null, - "date_naissance": null, - "email": null, - "emailperso": null, - "etudid": 19, - "nom": "FOURNIER", - "prenom": "ANNE" - }, - ... + "id": 2, + "nip": 2, + "nom": "GILLES", + "prenom": "MAXIME", + "civilite": "X" + } ] ``` @@ -372,14 +287,29 @@ informations suivantes: ``` { "civilite": "X", - "code_ine": null, - "code_nip": null, - "date_naissance": null, - "email": null, - "emailperso": null, - "etudid": 18, - "nom": "MOREL", - "prenom": "JACQUES" + "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": "", + "id": 1, + "codepostaldomicile": "", + "paysdomicile": "", + "telephonemobile": "", + "typeadresse": "domicile", + "domicile": "", + "villedomicile": "", + "telephone": "", + "fax": "", + "description": "" } ``` @@ -1164,13 +1094,88 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann ``` XXX A COMPLETER ``` + + * **`semestre_index`** + * **Méthode:** GET + * **Paramètres:** `dept`, `formsemestre_id` + * **Routes:** `/formsemestre//programme` + * **Exemple d'utilisation:** `api/formsemestre/1/programme` + * **Résultat:** Retourne la liste des Ues, ressources et SAE d'un semestre (json). + * **Exemple de résultat:** + ``` + { + "ues": [ + { + "type": 0, + "formation_id": 1, + "ue_code": "UCOD11", + "id": 1, + "ects": 12, + "acronyme": "RT1.1", + "is_external": false, + "numero": 1, + "code_apogee": "", + "titre": "Administrer les réseaux et l’Internet", + "coefficient": 0, + "semestre_idx": 1, + "color": "#B80004", + "ue_id": 1 + }, + ... + ], + "ressources": [ + { + "titre": "Fondamentaux de la programmation", + "coefficient": 1, + "module_type": 2, + "id": 17, + "ects": null, + "abbrev": null, + "ue_id": 3, + "code": "R107", + "formation_id": 1, + "heures_cours": 0, + "matiere_id": 3, + "heures_td": 0, + "semestre_id": 1, + "heures_tp": 0, + "numero": 70, + "code_apogee": "", + "module_id": 17 + }, + ... + ], + "saes": [ + { + "titre": "Se présenter sur Internet", + "coefficient": 1, + "module_type": 3, + "id": 14, + "ects": null, + "abbrev": null, + "ue_id": 3, + "code": "SAE14", + "formation_id": 1, + "heures_cours": 0, + "matiere_id": 3, + "heures_td": 0, + "semestre_id": 1, + "heures_tp": 0, + "numero": 40, + "code_apogee": "", + "module_id": 14 + }, + ... + ] + } + ``` ### Modules de formation Les moduleimpl sont les modules d'un semestre, ou les ressources, ou les SAÉs. On peut récupérer soit un module par son id, soit la listes des modules d'un semestre. - * **`moduleimpls`** + * **`moduleimpl`** * **Méthode:** GET * **Paramètres:** `moduleimpl_id` * **Routes:** `/formations/moduleimpl/` @@ -1178,7 +1183,34 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s * **Résultat:** Retourne la liste des moduleimpl * **Exemple de résultat:** ``` - XXX A COMPLETER + { + "id": 1, + "formsemestre_id": 1, + "computation_expr": null, + "module_id": 1, + "responsable_id": 2, + "moduleimpl_id": 1, + "ens": [], + "module": { + "heures_tp": 0, + "code_apogee": "", + "titre": "Initiation aux réseaux informatiques", + "coefficient": 1, + "module_type": 2, + "id": 1, + "ects": null, + "abbrev": "Init aux réseaux informatiques", + "ue_id": 1, + "code": "R101", + "formation_id": 1, + "heures_cours": 0, + "matiere_id": 1, + "heures_td": 0, + "semestre_id": 1, + "numero": 10, + "module_id": 1 + } + } ``` * **`moduleimpls_sem`**