forked from ScoDoc/DocScoDoc
réctification de la doc pour la partie département et étudiant
This commit is contained in:
leonard_montalbano
parent
5c8de2b9f2
commit
a12c4fe885
@ -114,315 +114,156 @@ Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succ
|
||||
### Départements
|
||||
* **`departements`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `viewable` (optionnel, si faux liste aussi les
|
||||
départements non accessibles à l'utilisateur courant), `format` (json,
|
||||
xml)
|
||||
* **Routes:** `/api/departements`
|
||||
* **Routes:** `/departements`
|
||||
* **Exemple d'utilisation:** `/api/departements`
|
||||
* **Résultat:** Liste des id de départements.
|
||||
* **Exemple de résultat:** `[id_1, id_2, id_3, ...]`
|
||||
* **Exemple de résultat:** `[1, 2, 3, ...]`
|
||||
|
||||
|
||||
* **`etudiants`** XXX à revoir
|
||||
* **`liste_etudiants`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `dept`, `semestre`
|
||||
* **Routes:** `/api/departements/<str:dept>/etudiants/liste/<int:formsemestre_id>`
|
||||
* **Paramètres:** `dept`, `formsemestre_id`
|
||||
* **Routes:** `/departements/<string:dept>/etudiants/liste` ou `/api/departements/<string:dept>/etudiants/liste/<int:formsemestre_id>`
|
||||
* **Exemple d'utilisation:** `/api/departements/MMI/etudiants/liste`
|
||||
* **Résultat:** liste des étudiants d'un département - semestre actuel par
|
||||
défaut. XXX à préciser
|
||||
* **Résultat:** liste des étudiants d'un département, par défaut, ou d'un semestre si renseigné
|
||||
|
||||
|
||||
* **`liste_semestres_actifs`** XXX à revoir
|
||||
* **`liste_semestres_courant`** XXX à revoir
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `dept`
|
||||
* **Routes:** `/api/departements/<str:dept>/semestres_actifs`
|
||||
* **Exemple d'utilisation:** `/api/departements/MMI/semestres_actifs`
|
||||
* **Routes:** `/departements/<string:dept>/semestres_courants`
|
||||
* **Exemple d'utilisation:** `/api/departements/MMI/semestres_courants`
|
||||
* **Résultat:** Liste des semestres actifs d'un département donné. (_réponse sous format json_)
|
||||
|
||||
|
||||
* **`referentiel_competences`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `id`, id du référentiel
|
||||
* **Routes:** `/api/referentiel_competences/<int:id>`
|
||||
* **Paramètres:** `dept`, `formation_id`
|
||||
* **Routes:** `/departements/<string:dept>/formations/<int:formation_id>/referentiel_competences`
|
||||
* **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
|
||||
|
||||
### Etudiants
|
||||
* **`etud_dept`**
|
||||
* **`semestre_index`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `code_nip`
|
||||
* **Routes:** `/api/etud_dept/<int:code_nip>`
|
||||
* **Exemple d'utilisation:** `/api/etud_dept/123`
|
||||
* **Résultat:** Liste des étudiants avec le code NIP donné tirée par ordre d'inscription décroissant.
|
||||
* **Paramètres:** `dept`, `formsemestre_id`
|
||||
* **Routes:** `/departements/<string:dept>/formsemestre/<string:formsemestre_id>/programme`
|
||||
* **Exemple d'utilisation:** `api/departements/MMI/formsemestre/1/programme`
|
||||
* **Résultat:** Retourne la liste des Ues, ressources et SAE d'un semestre (json).
|
||||
|
||||
|
||||
### Etudiants
|
||||
|
||||
* **`etudiants_courant`**
|
||||
* **Méthode:** GET
|
||||
* **Routes:** `/etudiants/courant`
|
||||
* **Exemple d'utilisation:** `/api/etudiants/courant`
|
||||
* **Résultat:** Retourne la liste des étudiants courant (json).
|
||||
* **Exemple de résultat:**
|
||||
```
|
||||
[
|
||||
{
|
||||
exist: true,
|
||||
dept: "GEII",
|
||||
id: 987,
|
||||
dept_id: 3
|
||||
{
|
||||
"civilite": "X",
|
||||
"code_ine": null,
|
||||
"code_nip": null,
|
||||
"date_naissance": null,
|
||||
"email": null,
|
||||
"emailperso": null,
|
||||
"etudid": 18,
|
||||
"nom": "MOREL",
|
||||
"prenom": "JACQUES"
|
||||
},
|
||||
{
|
||||
"civilite": "X",
|
||||
"code_ine": null,
|
||||
"code_nip": null,
|
||||
"date_naissance": null,
|
||||
"email": null,
|
||||
"emailperso": null,
|
||||
"etudid": 19,
|
||||
"nom": "FOURNIER",
|
||||
"prenom": "ANNE"
|
||||
},
|
||||
...
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
* **`etudiant`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `etudid`
|
||||
* **Routes:** `/api/etudiant/<int:etudid>`
|
||||
* **Exemple d'utilisation:** `/api/etudiant/987`
|
||||
* **Résultat:** Un dictionnaire avec les informations de l'étudiant correspondant à l'id passé en paramètres.
|
||||
* **Paramètres:** `etudid`, `nip`, `ine`
|
||||
* **Routes:** `/etudiant/etudid/<int:etudid>` ou `/etudiant/nip/<int:nip>` ou `/etudiant/ine/<int:ine>`
|
||||
* **Exemple d'utilisation:** `/api/etudiant/nip/1`
|
||||
* **Résultat:** Retourne les informations de l'étudiant correspondant à l'id passé en paramètres. (json)
|
||||
* **Exemple de résultat:**
|
||||
```
|
||||
{
|
||||
"nom": "Mutis",
|
||||
"sexe": "M.",
|
||||
"email": "alvaro.mutis@example.com",
|
||||
"prenom": "ALVARO",
|
||||
"nomprenom": "M. Alvaro MUTIS",
|
||||
"insemestre": [
|
||||
{
|
||||
"etat": "I",
|
||||
"formsemestre_id": "12781",
|
||||
"date_fin": "2010-07-30",
|
||||
"date_debut": "2010-01-25"
|
||||
"parcours_type": XXX type de parcours, en discussion XXX
|
||||
},
|
||||
{
|
||||
"etat": "I",
|
||||
"formsemestre_id": "8396",
|
||||
"date_fin": "2009-01-16",
|
||||
"date_debut": "2008-09-01"
|
||||
}
|
||||
],
|
||||
"etudid": "8768",
|
||||
"domicile": "2 Rue Madame",
|
||||
"villedomicile": "Paris",
|
||||
"telephonemobile": ""
|
||||
"civilite": "X",
|
||||
"code_ine": null,
|
||||
"code_nip": null,
|
||||
"date_naissance": null,
|
||||
"email": null,
|
||||
"emailperso": null,
|
||||
"etudid": 18,
|
||||
"nom": "MOREL",
|
||||
"prenom": "JACQUES"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
* **`etudiant_formsemestres`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `etudid`, `nip`, `ine`
|
||||
* **Routes:** : `/etudiant/etudid/<int:etudid>/formsemestres` ou `/etudiant/nip/<int:nip>/formsemestres` ou `/etudiant/ine/<int:ine>/formsemestres`
|
||||
* **Exemple d'utilisation:** `/etudiant/ine/1/formsemestres`
|
||||
* **Résultat:** Retourne la liste des semestres qu'un étudiant a suivis, triés par ordre chronologique. (json)
|
||||
|
||||
|
||||
|
||||
|
||||
* **`etudiant_bulletin_semestre`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `etudid`, `sem_id`
|
||||
* **Routes:** `/api/etudiant/<int:etudid>/semestre/<int:sem_id>/bulletin`
|
||||
* **Exemple d'utilisation:** `/api/etudiant/987/semestre/12/bulletin`
|
||||
* **Résultat:** Le bulletin d'un étudiant en fonction de son id et d'un semestre donné.
|
||||
* **Exemple de résultat:** voir plus bas sur cette page.
|
||||
|
||||
Voir aussi [Bulletins par défaut](https://scodoc.org/ParametrageBulletins/#exemple-1-bulletins-par-defaut)
|
||||
|
||||
|
||||
* **`etudiant_bulletin`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `formsemestre_id`, `dept`, `etudid`, `format` (`pdf` ou `json` _par défaut json_), `version` (`short`, `selectedevals` ou `long`)
|
||||
* **Routes:** : `/api/formsemestre/<int:formsemestre_id>/departements/<str:dept>/etudiant/nip|id|ine/{NIP}|{etudid}|numScodoc}/releve`
|
||||
* **Exemple d'utilisation:** `/api/formsemestre/123/departements/MMI/etudiant/id/456/releve?format=pdf&version=short`
|
||||
* **Résultat:** Un bulletin de notes.
|
||||
* **Exemple de résultat:** ici au format JSON, pour une version courte (`version=short`)
|
||||
```
|
||||
{
|
||||
"rang": {
|
||||
"ninscrits": 52,
|
||||
"value": "1"
|
||||
},
|
||||
"etape_apo2": "",
|
||||
"etape_apo3": "",
|
||||
"etape_apo4": "",
|
||||
"etudiant": {
|
||||
"nom": "BOLANO",
|
||||
"prenom": "Roberto",
|
||||
"sexe": "M.",
|
||||
"code_ine": "",
|
||||
etudid": "9860",
|
||||
"code_nip": "123456789",
|
||||
"email": "roberto@santateresa.mx",
|
||||
"photo_url": "\/ScoDoc\/static\/photos\/F68\/RT_29960.h90.jpg"
|
||||
},
|
||||
"bonus_sport_culture": {
|
||||
"value": 0
|
||||
},
|
||||
"absences": {
|
||||
"nbabsjust": 0,
|
||||
"nbabs": 1
|
||||
},
|
||||
"decision": {
|
||||
"etat": "I",
|
||||
"code": "ADM",
|
||||
"compenseformsemestre_id" : "SEM12345" /* si ce semestre en compense un autre */
|
||||
},
|
||||
"note": {
|
||||
"max": "15.51",
|
||||
"moy": "10.80",
|
||||
"value": "15.51",
|
||||
"min": "07.29"
|
||||
},
|
||||
etudid": "9860",
|
||||
"decision_ue": [
|
||||
{
|
||||
"acronyme": "UE11",
|
||||
"code": "ADM",
|
||||
"ects": "16.0",
|
||||
"titre": "D\u00e9couverte m\u00e9tiers",
|
||||
"numero": "11",
|
||||
"ue_id": "UE21456"
|
||||
},
|
||||
{
|
||||
"acronyme": "UE12",
|
||||
"code": "ADM",
|
||||
"ects": "14.0",
|
||||
"titre": "Mise \u00e0 niveau des comp\u00e9tences transversales et scientifiques",
|
||||
"numero": "12",
|
||||
"ue_id": "UE21478"
|
||||
}
|
||||
],
|
||||
"ue_capitalisee": [
|
||||
|
||||
],
|
||||
"publie": 1,
|
||||
"autorisation_inscription": [
|
||||
{
|
||||
"semestre_id": 2
|
||||
}
|
||||
],
|
||||
"appreciation": [
|
||||
|
||||
],
|
||||
"note_max": {
|
||||
"value": 20
|
||||
},
|
||||
"date": "2014-07-12T17:38:47.693262",
|
||||
"rang_group": [
|
||||
{
|
||||
"ninscrits": 26,
|
||||
"value": "1",
|
||||
"group_type": "TD",
|
||||
"group_name": "B"
|
||||
},
|
||||
{
|
||||
"ninscrits": 13,
|
||||
"value": "1",
|
||||
"group_type": "TP",
|
||||
"group_name": "B1"
|
||||
},
|
||||
...
|
||||
|
||||
],
|
||||
formsemestre_id": "SEM12345",
|
||||
"etape_apo": "V1RT",
|
||||
"ue": [
|
||||
{
|
||||
"acronyme": "UE11",
|
||||
"rang": "1",
|
||||
"code_apogee": "VRTU11",
|
||||
"ects": "16",
|
||||
"numero": "11",
|
||||
"note": {
|
||||
"max": "16.17",
|
||||
"value": "16.17",
|
||||
"min": "06.56"
|
||||
},
|
||||
"module": [
|
||||
{
|
||||
"coefficient": 3,
|
||||
"rang": {
|
||||
"value": "1"
|
||||
},
|
||||
"code": "M1101",
|
||||
"code_apogee": "VRT1101",
|
||||
"numero": 1101,
|
||||
"note": {
|
||||
"moy": "08.94",
|
||||
"nb_notes": 51,
|
||||
"nb_missing": 0,
|
||||
"max": "19.18",
|
||||
"min": "03.70",
|
||||
"nb_valid_evals": 3,
|
||||
"value": "19.18"
|
||||
},
|
||||
"abbrev": "R\u00e9seaux d'entreprises",
|
||||
"effectif": {
|
||||
"value": 51
|
||||
},
|
||||
"titre": "Initiation aux r\u00e9seaux d'entreprises",
|
||||
"evaluation": [
|
||||
],
|
||||
"id": "27427"
|
||||
},
|
||||
{
|
||||
"coefficient": 2,
|
||||
"rang": {
|
||||
"value": "2"
|
||||
],
|
||||
"effectif": "51",
|
||||
"titre": "Mise \u00e0 niveau des comp\u00e9tences transversales et scientifiques",
|
||||
"id": "UE21478"
|
||||
},
|
||||
...
|
||||
|
||||
{
|
||||
"acronyme": "UE 1S",
|
||||
"rang": "1 ex",
|
||||
"code_apogee": "",
|
||||
"ects": "0",
|
||||
"numero": "13",
|
||||
"note": {
|
||||
"max": "00.00",
|
||||
"value": "00.00",
|
||||
"min": "00.00"
|
||||
},
|
||||
"module": [
|
||||
],
|
||||
"effectif": "51",
|
||||
"titre": "Sport &amp; Culture",
|
||||
"id": "UE23716"
|
||||
}
|
||||
],
|
||||
"situation": "Inscrit le 2015-09-02. D\u00e9cision jury: Valid\u00e9. UE acquises: UE11, UE12. Autoris\u00e9 \u00e0 s'inscrire en S2."
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
* **`etudiant_photo`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `etudid`, `small`
|
||||
* **Routes:** `/api/etudiant/<int:etudid>/photo` **OU** `/api/etudiant/<int:etudid>/photo/small` (_ajout du paramètre **small** pour la version small_)
|
||||
* **Exemple d'utilisation:** `/api/etudiant/123/photo` **OU** `/api/etudiant/123/photo/small` (_pour la version small_)
|
||||
* **Résultat:** Image en JPEG ou PNG.
|
||||
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
|
||||
* **Routes:** `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin` ou `/etudiant/nip/<int:nip>/formsemestre/<int:formsemestre_id>/bulletin` ou `/etudiant/ine/<int:ine>/formsemestre/<int:formsemestre_id>/bulletin`
|
||||
* **Exemple d'utilisation:** `/etudiant/nip/1/formsemestre/1/bulletin`
|
||||
* **Résultat:** Retourne le bulletin d'un étudiant en fonction de son id et d'un semestre donné. (json)
|
||||
|
||||
|
||||
* **`etudiant_groups`**
|
||||
* **Méthode:** GET
|
||||
* **Paramètres:** `etudid`, `formsemestre_id`
|
||||
* **Routes:** `/api/etudiant/<int:etudid>/semestre/<int:formsemestre_id>/groups`
|
||||
* **Exemple d'utilisation:** `/api/etudiants/123/semestre/INFO-DUT-FI-S1-2014/groups`
|
||||
* **Résultat:** Liste des groupes auxquels appartient l'étudiant dans le semestre indiqué.
|
||||
|
||||
```
|
||||
{
|
||||
"etudid" : 1234,
|
||||
"formsemestre_id" : 5678,
|
||||
"groupes" : [
|
||||
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
|
||||
* **Routes:** `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/nip/<int:nip>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/ine/<int:ine>/semestre/<int:formsemestre_id>/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:**
|
||||
```
|
||||
[
|
||||
{
|
||||
"numero": 1, // Ordre d'affichage dans Scodoc
|
||||
"partition_id": 62028,
|
||||
"partition_id": 1,
|
||||
"id": 1,
|
||||
"formsemestre_id": 1,
|
||||
"partition_name": "TD",
|
||||
"group_id" : 1899,
|
||||
"group_name": "TD 1"
|
||||
},{
|
||||
"numero": 2,
|
||||
"partition_id": 62029,
|
||||
"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",
|
||||
"group_id" : 1905,
|
||||
"group_name": "TP 2"
|
||||
}
|
||||
"numero": 1,
|
||||
"bul_show_rank": false,
|
||||
"show_in_lists": true,
|
||||
"group_id": 2,
|
||||
"group_name": "A"
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user