ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Merge branch 'master' of https://scodoc.org/git/leonard.montalbano/DocScoDoc

Browse Source
This commit is contained in:
Emmanuel Viennet 2022-05-02 10:08:02 +02:00
commit 4622d5c95d
1 changed files with 468 additions and 479 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

353
docs/ScoDoc9API.md
View File

@ -264,13 +264,13 @@ informations suivantes:
"formation_id": 1, "formation_id": 1,
"ue_code": "UCOD11", "ue_code": "UCOD11",
"id": 1, "id": 1,
"ects": 12.0, "ects": 12,
"acronyme": "RT1.1", "acronyme": "RT1.1",
"is_external": false, "is_external": false,
"numero": 1, "numero": 1,
"code_apogee": "", "code_apogee": "",
"titre": "Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"coefficient": 0.0, "coefficient": 0,
"semestre_idx": 1, "semestre_idx": 1,
"color": "#B80004", "color": "#B80004",
"ue_id": 1 "ue_id": 1
@ -280,7 +280,7 @@ informations suivantes:
"ressources": [ "ressources": [
{ {
"titre": "Fondamentaux de la programmation", "titre": "Fondamentaux de la programmation",
"coefficient": 1.0, "coefficient": 1,
"module_type": 2, "module_type": 2,
"id": 17, "id": 17,
"ects": null, "ects": null,
@ -288,11 +288,11 @@ informations suivantes:
"ue_id": 3, "ue_id": 3,
"code": "R107", "code": "R107",
"formation_id": 1, "formation_id": 1,
"heures_cours": 0.0, "heures_cours": 0,
"matiere_id": 3, "matiere_id": 3,
"heures_td": 0.0, "heures_td": 0,
"semestre_id": 1, "semestre_id": 1,
"heures_tp": 0.0, "heures_tp": 0,
"numero": 70, "numero": 70,
"code_apogee": "", "code_apogee": "",
"module_id": 17 "module_id": 17
@ -301,8 +301,8 @@ informations suivantes:
], ],
"saes": [ "saes": [
{ {
"titre": "Se pr\u00e9senter sur Internet", "titre": "Se présenter sur Internet",
"coefficient": 1.0, "coefficient": 1,
"module_type": 3, "module_type": 3,
"id": 14, "id": 14,
"ects": null, "ects": null,
@ -310,11 +310,11 @@ informations suivantes:
"ue_id": 3, "ue_id": 3,
"code": "SAE14", "code": "SAE14",
"formation_id": 1, "formation_id": 1,
"heures_cours": 0.0, "heures_cours": 0,
"matiere_id": 3, "matiere_id": 3,
"heures_td": 0.0, "heures_td": 0,
"semestre_id": 1, "semestre_id": 1,
"heures_tp": 0.0, "heures_tp": 0,
"numero": 40, "numero": 40,
"code_apogee": "", "code_apogee": "",
"module_id": 14 "module_id": 14
@ -335,7 +335,7 @@ informations suivantes:
* **Résultat:** Retourne la liste des étudiants courant (json). * **Résultat:** Retourne la liste des étudiants courant (json).
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
{ [
{ {
"civilite": "X", "civilite": "X",
"code_ine": null, "code_ine": null,
@ -359,7 +359,7 @@ informations suivantes:
"prenom": "ANNE" "prenom": "ANNE"
}, },
... ...
} ]
``` ```
* **`etudiant`** * **`etudiant`**
@ -394,15 +394,11 @@ informations suivantes:
``` ```
[ [
{ {
"titre": "master machine info", "date_fin": "31/08/2022",
"gestion_semestrielle": false,
"date_debut": "01/09/2021",
"bul_bgcolor": null,
"date_fin": "15/12/2022",
"resp_can_edit": false, "resp_can_edit": false,
"dept_id": 1, "dept_id": 1,
"etat": true, "etat": true,
"resp_can_change_ens": false, "resp_can_change_ens": true,
"id": 1, "id": 1,
"modalite": "FI", "modalite": "FI",
"ens_can_edit_eval": false, "ens_can_edit_eval": false,
@ -412,17 +408,18 @@ informations suivantes:
"semestre_id": 1, "semestre_id": 1,
"bul_hide_xml": false, "bul_hide_xml": false,
"elt_annee_apo": null, "elt_annee_apo": null,
"titre": "Semestre test",
"block_moyennes": false, "block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"bul_bgcolor": "white",
"formsemestre_id": 1, "formsemestre_id": 1,
"titre_num": "master machine info semestre 1", "titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin_iso": "2022-12-15", "date_fin_iso": "2022-08-31",
"responsables": [ "responsables": []
3, }
2
]
},
...
] ]
``` ```
@ -471,7 +468,7 @@ informations suivantes:
"formation": { "formation": {
"id": 1, "id": 1,
"acronyme": "BUT R&T", "acronyme": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique réseaux et télécommunications",
"titre": "BUT R&T" "titre": "BUT R&T"
}, },
"formsemestre_id": 1, "formsemestre_id": 1,
@ -500,7 +497,7 @@ informations suivantes:
"ressources": { "ressources": {
"R101": { "R101": {
"id": 1, "id": 1,
"titre": "Initiation aux r\u00e9seaux informatiques", "titre": "Initiation aux réseaux informatiques",
"code_apogee": null, "code_apogee": null,
"url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1", "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1",
"moyenne": {}, "moyenne": {},
@ -513,7 +510,7 @@ informations suivantes:
"heure_fin": "09:00", "heure_fin": "09:00",
"coef": "01.00", "coef": "01.00",
"poids": { "poids": {
"RT1.1": 1.0, "RT1.1": 1
}, },
"note": { "note": {
"value": "12.00", "value": "12.00",
@ -524,22 +521,22 @@ informations suivantes:
"url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1" "url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1"
} }
] ]
}, }
}, },
"saes": { "saes": {
"SAE11": { "SAE11": {
"id": 2, "id": 2,
"titre": "Se sensibiliser \u00e0 l'hygi\u00e8ne informatique et \u00e0 la cybers\u00e9curit\u00e9", "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité",
"code_apogee": null, "code_apogee": null,
"url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2", "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2",
"moyenne": {}, "moyenne": {},
"evaluations": [] "evaluations": []
}, }
}, },
"ues": { "ues": {
"RT1.1": { "RT1.1": {
"id": 1, "id": 1,
"titre": "Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"numero": 1, "numero": 1,
"type": 0, "type": 0,
"color": "#B80004", "color": "#B80004",
@ -558,20 +555,20 @@ informations suivantes:
"ressources": { "ressources": {
"R101": { "R101": {
"id": 1, "id": 1,
"coef": 12.0, "coef": 12,
"moyenne": "12.00" "moyenne": "12.00"
}, }
}, },
"saes": { "saes": {
"SAE11": { "SAE11": {
"id": 2, "id": 2,
"coef": 16.0, "coef": 16,
"moyenne": "~" "moyenne": "~"
}, }
}, },
"ECTS": { "ECTS": {
"acquis": 0.0, "acquis": 0,
"total": 12.0 "total": 12
} }
}, },
"semestre": { "semestre": {
@ -588,7 +585,7 @@ informations suivantes:
}, },
"ECTS": { "ECTS": {
"acquis": 0, "acquis": 0,
"total": 30.0 "total": 30
}, },
"notes": { "notes": {
"value": "10.60", "value": "10.60",
@ -602,6 +599,7 @@ informations suivantes:
} }
} }
} }
}
``` ```
@ -623,7 +621,7 @@ informations suivantes:
"bul_show_rank": false, "bul_show_rank": false,
"show_in_lists": true, "show_in_lists": true,
"group_id": 1, "group_id": 1,
"group_name": B "group_name": "B"
}, },
{ {
"partition_id": 2, "partition_id": 2,
@ -654,7 +652,7 @@ informations suivantes:
{ {
"id": 1, "id": 1,
"acronyme": "BUT R&T", "acronyme": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique réseaux et télécommunications",
"formation_code": "V1RET", "formation_code": "V1RET",
"code_specialite": null, "code_specialite": null,
"dept_id": 1, "dept_id": 1,
@ -701,7 +699,7 @@ informations suivantes:
{ {
"id": 1, "id": 1,
"acronyme": "BUT R&T", "acronyme": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique réseaux et télécommunications",
"formation_code": "V1RET", "formation_code": "V1RET",
"code_specialite": null, "code_specialite": null,
"dept_id": 1, "dept_id": 1,
@ -714,29 +712,29 @@ informations suivantes:
{ {
"acronyme": "RT1.1", "acronyme": "RT1.1",
"numero": 1, "numero": 1,
"titre": "Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"type": 0, "type": 0,
"ue_code": "UCOD11", "ue_code": "UCOD11",
"ects": 12.0, "ects": 12,
"is_external": false, "is_external": false,
"code_apogee": "", "code_apogee": "",
"coefficient": 0.0, "coefficient": 0,
"semestre_idx": 1, "semestre_idx": 1,
"color": "#B80004", "color": "#B80004",
"reference": 1, "reference": 1,
"matiere": [ "matiere": [
{ {
"titre": "Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"numero": 1, "numero": 1,
"module": [ "module": [
{ {
"titre": "Initiation aux r\u00e9seaux informatiques", "titre": "Initiation aux réseaux informatiques",
"abbrev": "Init aux r\u00e9seaux informatiques", "abbrev": "Init aux réseaux informatiques",
"code": "R101", "code": "R101",
"heures_cours": 0.0, "heures_cours": 0,
"heures_td": 0.0, "heures_td": 0,
"heures_tp": 0.0, "heures_tp": 0,
"coefficient": 1.0, "coefficient": 1,
"ects": "", "ects": "",
"semestre_id": 1, "semestre_id": 1,
"numero": 10, "numero": 10,
@ -758,13 +756,13 @@ informations suivantes:
] ]
}, },
{ {
"titre": "Se sensibiliser \u00e0 l'hygi\u00e8ne informatique et \u00e0 la cybers\u00e9curit\u00e9", "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité",
"abbrev": "Hygi\u00e8ne informatique", "abbrev": "Hygiène informatique",
"code": "SAE11", "code": "SAE11",
"heures_cours": 0.0, "heures_cours": 0,
"heures_td": 0.0, "heures_td": 0,
"heures_tp": 0.0, "heures_tp": 0,
"coefficient": 1.0, "coefficient": 1,
"ects": "", "ects": "",
"semestre_id": 1, "semestre_id": 1,
"numero": 10, "numero": 10,
@ -776,13 +774,11 @@ informations suivantes:
"coef": "16.0" "coef": "16.0"
} }
] ]
}, }
...
] ]
}, }
...
] ]
}, }
] ]
} }
``` ```
@ -874,106 +870,103 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
* **Exemple de résultat:** * **Exemple de résultat:**
``` ```
{ {
"etudid":1, "etudid": 1,
"formsemestre_id":1, "formsemestre_id": 1,
"date":"2022-04-27T10:44:47.448094", "date": "2022-04-27T10:44:47.448094",
"publie":true, "publie": true,
"etapes":[ "etapes": [],
"etudiant": {
], "etudid": 1,
"etudiant":{ "code_nip": "1",
"etudid":1, "code_ine": "1",
"code_nip":"1", "nom": "COSTA",
"code_ine":"1", "prenom": "Sacha",
"nom":"COSTA", "civilite": "",
"prenom":"Sacha", "photo_url": "/ScoDoc/TAPI/Scolarite/get_photo_image?etudid=1&size=small",
"civilite":"", "email": "SACHA.COSTA@example.com",
"photo_url":"/ScoDoc/TAPI/Scolarite/get_photo_image?etudid=1&size=small", "emailperso": "",
"email":"SACHA.COSTA@example.com", "sexe": ""
"emailperso":"",
"sexe":""
}, },
"note":{ "note": {
"value":"10.60", "value": "10.60",
"min":"-", "min": "-",
"max":"-", "max": "-",
"moy":"-" "moy": "-"
}, },
"rang":{ "rang": {
"value":"10", "value": "10",
"ninscrits":16 "ninscrits": 16
}, },
"rang_group":[ "rang_group": [
{ {
"group_type":"TD", "group_type": "TD",
"group_name":"", "group_name": "",
"value":"", "value": "",
"ninscrits":"" "ninscrits": ""
} }
], ],
"note_max":{ "note_max": {
"value":20 "value": 20
}, },
"bonus_sport_culture":{ "bonus_sport_culture": {
"value":0.0 "value": 0
}, },
"ue":[ "ue": [
{ {
"id":1, "id": 1,
"numero":"1", "numero": "1",
"acronyme":"RT1.1", "acronyme": "RT1.1",
"titre":"Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"note":{ "note": {
"value":"08.50", "value": "08.50",
"min":"06.00", "min": "06.00",
"max":"16.50", "max": "16.50",
"moy":"11.31" "moy": "11.31"
}, },
"rang":"12", "rang": "12",
"effectif":16, "effectif": 16,
"ects":"12", "ects": "12",
"code_apogee":"", "code_apogee": "",
"module":[ "module": [
{ {
"id":1, "id": 1,
"code":"R101", "code": "R101",
"coefficient":1.0, "coefficient": 1,
"numero":10, "numero": 10,
"titre":"Initiation aux r\u00e9seaux informatiques", "titre": "Initiation aux réseaux informatiques",
"abbrev":"Init aux r\u00e9seaux informatiques", "abbrev": "Init aux réseaux informatiques",
"note":{ "note": {
"value":"12.00", "value": "12.00",
"moy":"-", "moy": "-",
"max":"-", "max": "-",
"min":"-", "min": "-",
"nb_notes":"-", "nb_notes": "-",
"nb_missing":"-", "nb_missing": "-",
"nb_valid_evals":"-" "nb_valid_evals": "-"
}, },
"code_apogee":"", "code_apogee": "",
"evaluation":[ "evaluation": [
{ {
"jour":"2022-04-20", "jour": "2022-04-20",
"heure_debut":"08:00:00", "heure_debut": "08:00:00",
"heure_fin":"09:00:00", "heure_fin": "09:00:00",
"coefficient":1.0, "coefficient": 1,
"evaluation_type":0, "evaluation_type": 0,
"evaluation_id":1, "evaluation_id": 1,
"description":"eval1", "description": "eval1",
"note":"12.00" "note": "12.00"
} }
] ]
}, }
...
] ]
} }
], ],
"ue_capitalisee":[], "ue_capitalisee": [],
"absences":{ "absences": {
"nbabs":2, "nbabs": 2,
"nbabsjust":1 "nbabsjust": 1
}, },
"appreciation":[] "appreciation": []
} }
``` ```
@ -1024,7 +1017,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"formation": { "formation": {
"id": 1, "id": 1,
"acronyme": "BUT R&T", "acronyme": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique réseaux et télécommunications",
"titre": "BUT R&T" "titre": "BUT R&T"
}, },
"formsemestre_id": 1, "formsemestre_id": 1,
@ -1053,7 +1046,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"ressources": { "ressources": {
"R101": { "R101": {
"id": 1, "id": 1,
"titre": "Initiation aux r\u00e9seaux informatiques", "titre": "Initiation aux réseaux informatiques",
"code_apogee": null, "code_apogee": null,
"url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1", "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=1",
"moyenne": {}, "moyenne": {},
@ -1066,7 +1059,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"heure_fin": "09:00", "heure_fin": "09:00",
"coef": "01.00", "coef": "01.00",
"poids": { "poids": {
"RT1.1": 1.0, "RT1.1": 1
}, },
"note": { "note": {
"value": "12.00", "value": "12.00",
@ -1077,22 +1070,22 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1" "url": "/ScoDoc/TAPI/Scolarite/Notes/evaluation_listenotes?evaluation_id=1"
} }
] ]
}, }
}, },
"saes": { "saes": {
"SAE11": { "SAE11": {
"id": 2, "id": 2,
"titre": "Se sensibiliser \u00e0 l'hygi\u00e8ne informatique et \u00e0 la cybers\u00e9curit\u00e9", "titre": "Se sensibiliser à l'hygiène informatique et à la cybersécurité",
"code_apogee": null, "code_apogee": null,
"url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2", "url": "/ScoDoc/TAPI/Scolarite/Notes/moduleimpl_status?moduleimpl_id=2",
"moyenne": {}, "moyenne": {},
"evaluations": [] "evaluations": []
}, }
}, },
"ues": { "ues": {
"RT1.1": { "RT1.1": {
"id": 1, "id": 1,
"titre": "Administrer les r\u00e9seaux et l\u2019Internet", "titre": "Administrer les réseaux et l’Internet",
"numero": 1, "numero": 1,
"type": 0, "type": 0,
"color": "#B80004", "color": "#B80004",
@ -1111,20 +1104,20 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"ressources": { "ressources": {
"R101": { "R101": {
"id": 1, "id": 1,
"coef": 12.0, "coef": 12,
"moyenne": "12.00" "moyenne": "12.00"
}, }
}, },
"saes": { "saes": {
"SAE11": { "SAE11": {
"id": 2, "id": 2,
"coef": 16.0, "coef": 16,
"moyenne": "~" "moyenne": "~"
}, }
}, },
"ECTS": { "ECTS": {
"acquis": 0.0, "acquis": 0,
"total": 12.0 "total": 12
} }
}, },
"semestre": { "semestre": {
@ -1141,7 +1134,7 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
}, },
"ECTS": { "ECTS": {
"acquis": 0, "acquis": 0,
"total": 30.0 "total": 30
}, },
"notes": { "notes": {
"value": "10.60", "value": "10.60",
@ -1154,8 +1147,8 @@ Les sessions de formation (dénommées "semestres" même si elles durent une ann
"total": 16 "total": 16
} }
} }
}, }
... }
] ]
``` ```
@ -1204,28 +1197,27 @@ On peut récupérer soit un module par son id, soit la listes des modules d'un s
"module_id": 1, "module_id": 1,
"responsable_id": 2, "responsable_id": 2,
"module": { "module": {
"heures_tp": 0.0, "heures_tp": 0,
"code_apogee": "", "code_apogee": "",
"titre": "Initiation aux r\u00e9seaux informatiques", "titre": "Initiation aux réseaux informatiques",
"coefficient": 1.0, "coefficient": 1,
"module_type": 2, "module_type": 2,
"id": 1, "id": 1,
"ects": null, "ects": null,
"abbrev": "Init aux r\u00e9seaux informatiques", "abbrev": "Init aux réseaux informatiques",
"ue_id": 1, "ue_id": 1,
"code": "R101", "code": "R101",
"formation_id": 1, "formation_id": 1,
"heures_cours": 0.0, "heures_cours": 0,
"matiere_id": 1, "matiere_id": 1,
"heures_td": 0.0, "heures_td": 0,
"semestre_id": 1, "semestre_id": 1,
"numero": 10, "numero": 10,
"module_id": 1 "module_id": 1
}, },
"moduleimpl_id": 1, "moduleimpl_id": 1,
"ens": [] "ens": []
}, }
...
] ]
``` ```
@ -1310,8 +1302,7 @@ d'un nombre quelconque de groupes d'étudiants.
"nomprenom": "Mme Marguerite BOUTET", "nomprenom": "Mme Marguerite BOUTET",
"ne": "e", "ne": "e",
"email_default": "MARGUERITE.BOUTET@example.com" "email_default": "MARGUERITE.BOUTET@example.com"
}, }
...
] ]
``` ```
@ -1339,22 +1330,21 @@ d'un nombre quelconque de groupes d'étudiants.
"jour": "20/04/2022", "jour": "20/04/2022",
"heure_debut": "08h00", "heure_debut": "08h00",
"description": "eval1", "description": "eval1",
"coefficient": 1.0, "coefficient": 1,
"publish_incomplete": false, "publish_incomplete": false,
"numero": 0, "numero": 0,
"id": 1, "id": 1,
"heure_fin": "09h00", "heure_fin": "09h00",
"note_max": 20.0, "note_max": 20,
"visibulletin": true, "visibulletin": true,
"evaluation_type": 0, "evaluation_type": 0,
"evaluation_id": 1, "evaluation_id": 1,
"jouriso": "2022-04-20", "jouriso": "2022-04-20",
"duree": "1h", "duree": "1h",
"descrheure": " de 08h00 \u00e0 09h00", "descrheure": " de 08h00 à 09h00",
"matin": 1, "matin": 1,
"apresmidi": 0 "apresmidi": 0
}, }
...
] ]
``` ```
@ -1372,7 +1362,7 @@ d'un nombre quelconque de groupes d'étudiants.
"id": 1, "id": 1,
"etudid": 10, "etudid": 10,
"evaluation_id": 1, "evaluation_id": 1,
"value": 15.0, "value": 15,
"comment": "", "comment": "",
"date": "Wed, 20 Apr 2022 06:49:05 GMT", "date": "Wed, 20 Apr 2022 06:49:05 GMT",
"uid": 2 "uid": 2
@ -1381,12 +1371,11 @@ d'un nombre quelconque de groupes d'étudiants.
"id": 2, "id": 2,
"etudid": 1, "etudid": 1,
"evaluation_id": 1, "evaluation_id": 1,
"value": 12.0, "value": 12,
"comment": "", "comment": "",
"date": "Wed, 20 Apr 2022 06:49:06 GMT", "date": "Wed, 20 Apr 2022 06:49:06 GMT",
"uid": 2 "uid": 2
}, }
...
} }
``` ```