jmplace/DocScoDoc
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Projects Releases Wiki Activity

compléments docs (suite)

Browse Source
This commit is contained in:
Jean-Marie PLACE 2022-07-29 09:37:20 +02:00
parent f8a6c7f864
commit 34afa7e9d1
11 changed files with 2088 additions and 1330 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

418
docs/ScoDoc9API.md
View File

@ -160,7 +160,6 @@ par le serveur ScoDoc.
incorrecte, paramètre manquant, ou objet inexistant. incorrecte, paramètre manquant, ou objet inexistant.
* [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur * [500](https://developer.mozilla.org/fr/docs/Web/HTTP/Status/500) : Erreur
inconnue côté serveur. inconnue côté serveur.
## Départements ## Départements
@ -173,7 +172,7 @@ par le serveur ScoDoc.
```json ```json
[ 1888, 999, 165 ] [ 1888, 999, 165 ]
``` ```
#### **departement** #### **departement**
* **Méthode:** GET * **Méthode:** GET
@ -182,15 +181,15 @@ par le serveur ScoDoc.
* `/departement/<string:dept>` * `/departement/<string:dept>`
* **Résultat:** Un département * **Résultat:** Un département
* **Exemple de résultat:** * **Exemple de résultat:**
```json ```json
{ {
"id": 1, "id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"description": null, "description": null,
"visible": true, "visible": true,
"date_creation": "Fri, 15 Apr 2022 12:19:28 GMT" "date_creation": "Fri, 15 Apr 2022 12:19:28 GMT"
}, }
``` ```
#### **departements** #### **departements**
@ -235,7 +234,7 @@ par le serveur ScoDoc.
... ...
] ]
``` ```
#### **Formsemestres d'un département** #### **Formsemestres d'un département**
* **Méthode:** GET * **Méthode:** GET
@ -259,7 +258,6 @@ par le serveur ScoDoc.
* **Résultat:** Liste des formsemestres en cours d'un département donné. * **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) * **Exemple de résultat:** [formsemestre-courants.json](samples/sample_formsemestres-courants.json.md)
### **Semestres** ### **Semestres**
#### **Formsemestre** #### **Formsemestre**
@ -278,7 +276,7 @@ par le serveur ScoDoc.
* ** Query string:** `etape_apo`, `annee_scolaire`, `dept_acronym`, `dept_id` * ** Query string:** `etape_apo`, `annee_scolaire`, `dept_acronym`, `dept_id`
* **Route:** `/formsemestres/query * **Route:** `/formsemestres/query
* **Exemple d'utilisation:** `/api/formsemestres/query?etape_apo=V7HU1&annee_scolaire=2021` * **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) * **Exemple de résultat:** [formsemestres.json](samples/sample_formsemestres.json.md)
#### **Bulletins d'un formsemestre** #### **Bulletins d'un formsemestre**
@ -363,84 +361,30 @@ mais pas JSON compliant à cause des _NaN_.
l'id passé en paramètres. l'id passé en paramètres.
Les codes INE et NIP sont uniques au sein d'un département. 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. Si plusieurs objets étudiant ont le même code, on ramène le plus récemment inscrit.
* **Exemple de résultat:** * **Exemple de résultat:** [etudiant.json](samples/sample_etudiant.json.md)
```
{ #### **`tous les etudiants` (TODO)**
"civilite": "X",
"code_ine": "1", * **Méthode:** GET
"code_nip": "1", * **Routes:** `/etudiants
"date_naissance": "", * **Exemple d'utilisation:** `/api/etudiants`
"dept_id": 1, * **Résultat:** Liste complète de tous les étudiants (passés ou présents) pour lequel l'utilisateur a la permission ScoView.
"dept_acronym": "TAPI", * **Exemple de résultat:** [tous-les-etudiant.json](samples/sample_tous-les-etudiants.json.md)
"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": ""
}
```
#### **`etudiants`** #### **`etudiants`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** `/etudiants/etudid/<int:etudid>` ou `/etudiants/nip/<string:nip>` ou `/etudiants/ine/<string:ine>` * **Routes:** `/etudiants/etudid/<int:etudid>` ou `/etudiants/nip/<string:nip>` ou `/etudiants/ine/<string:ine>`
* **Exemple d'utilisation:** `/api/etudiants/nip/1` * **Exemple d'utilisation:** `/api/etudiants/nip/1`
* **Résultat:** Info sur le ou les étudiants correspondants. * **Résultat:** Info sur le ou les étudiants correspondants.
Comme `/etudiant` mais renvoie toujours une liste. Comme [`/etudiant`](ScoDoc9API.md#etudiant) mais renvoie toujours une liste.
Si non trouvé, liste vide, pas d'erreur. Si non trouvé, liste vide, pas d'erreur.
Dans 99% des cas, la liste contient un seul étudiant, mais si l'étudiant a 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 été inscrit dans plusieurs départements, on a plusieurs objets (1 par
dept.). dept.).
* **Exemple de résultat:** * **Exemple de résultat:** [etudiants.json](samples/sample_etudiants.json.md)
```
[
{
"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": ""
}
]
```
### Cursus ### Cursus
#### **etudiant_formsemestres** #### **etudiant_formsemestres**
@ -456,7 +400,7 @@ mais pas JSON compliant à cause des _NaN_.
### Bulletin ### Bulletin
#### **`etudiant_bulletin_semestre`** #### **Bulletin d'un formsemestre d'un étudiant **
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **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 Deux versions disponibles `long` et `short` (par défaut `long` ajoutez
`/short` pour la version plus courte). `/short` pour la version plus courte).
* **Exemple de résultat:** * **Exemple de résultat:** [bulletin-formsemestre-etudiant.json](samples/sample_bulletin-formsemestre-etudiant.json.md)
```
{
"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&amp;T",
"titre_officiel": "Bachelor technologique réseaux et télécommunications",
"titre": "BUT R&amp;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&apos;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
}
}
}
}
```
#### **`etudiant_groups`** #### **Groupes d'un formsemestre d'un étudiant**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
* **Routes:** `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/nip/<string:nip>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/ine/<string:ine>/semestre/<int:formsemestre_id>/groups` * **Routes:** `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/nip/<string:nip>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/ine/<string:ine>/semestre/<int:formsemestre_id>/groups`
* **Exemple d'utilisation:** `/etudiant/nip/1/semestre/1/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) * **Résultat:** Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json)
* **Exemple de résultat:** * **Exemple de résultat:** [groupes-formsemestre-etudiant.json](samples/sample_groupes-formsemestre-etudiant.json.md)
```
[
{
"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"
},
...
]
```
## Programmes de formations ## Programmes de formations
@ -724,106 +469,21 @@ mais pas JSON compliant à cause des _NaN_.
* **Exemple d'utilisation:** `/ScoDoc/api/formations` * **Exemple d'utilisation:** `/ScoDoc/api/formations`
* **Résultat:** Retourne la liste de toutes les formations (tous * **Résultat:** Retourne la liste de toutes les formations (tous
départements) départements)
### Export programme ### Export programme
#### **`formation_export`** #### **`formation export`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formation_id`, `export_ids` (False par défaut. Ajouter `/with_ids` pour le passer à True) * **Paramètres:** `formation_id`, `export_ids` (False par défaut. Ajouter `/with_ids` pour le passer à True)
* **Routes:** `/formation/formation_export/<int:formation_id>` * **Routes:**
* `/formation/export/<int:formation_id>`
* `/formation/export/<int:formation_id>/with_ids`
* **Exemple d'utilisation:** `/ScoDoc/api/formation/formation_export/1` * **Exemple d'utilisation:** `/ScoDoc/api/formation/formation_export/1`
* **Résultat:** Retourne la formation, avec UE, matières, modules * **Résultat:** Retourne la formation, avec UE, matières, modules
* **Exemple de résultat:** * **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&amp;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&apos;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`** #### **`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_) * **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 ? XXX obtenir la liste des référentiels ?
## Formsemestres ## 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 }, ... ] [ { formsemestre comme ci-dessus }, ... ]
``` ```
### Note sur les identifiants de formsemestre ### Note sur les identifiants de formsemestre
Le `session_id` peut être utilisé pour identifier de façon prévisible et 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 (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) **Exemple:** `INFO-DUT-FI-S1-2014` équivaut à un semestre S1 d'un DUT informatique de 2014 en formation initiale (FI)
### Étudiants inscrits et bulletins ### Étudiants inscrits et bulletins
#### **etudiants** #### **etudiants d'un formsemestre**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id`, `etat` (par défaut égal à "I" pour les étudiants inscrits) * **Paramètres:** `formsemestre_id`, `etat` (par défaut égal à "I" pour les étudiants inscrits)
* **Routes:** `/formsemestre/<int:formsemestre_id>/etudiants` XXX voir si * **Routes:** `/formsemestre/<int:formsemestre_id>/etudiants` XXX voir si
@ -926,7 +584,7 @@ des informations suivantes:
* **Résultat:** les étudiants inscrits à ce semestres XXX préciser état * **Résultat:** les étudiants inscrits à ce semestres XXX préciser état
(DEM, DEF)) (DEM, DEF))
#### * **`bulletins`** #### * **`bulletins d'un formsemestre`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
@ -1107,7 +765,7 @@ des informations suivantes:
] ]
``` ```
#### **etat_evals** #### **etat_evals d'un formsemestre**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`

BIN
docs/img/API_Chart.odg
View File

Binary file not shown.

2465
docs/img/API_Chart.svg
View File

File diff suppressed because it is too large Load Diff
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 245 KiB

After

Width:  |  Height:  |  Size: 360 KiB

173
docs/samples/sample_bulletin-formsemestre-etudiant.json.md Normal file
View File

@ -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&amp;T",
"titre_officiel": "Bachelor technologique réseaux et télécommunications",
"titre": "BUT R&amp;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&apos;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
}
}
}
}
```

35
docs/samples/sample_etudiant.json.md
View File

@ -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)"
}
```

2
docs/samples/sample_etudiants-courant.json.md
View File

@ -27,7 +27,7 @@
ou ou
`/api/etudiants/courant` `/api/etudiants/courant/long`
```json ```json
[ [
{ {

37
docs/samples/sample_etudiants.json.md Normal file
View File

@ -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)"
}
]
```

80
docs/samples/sample_formation-export.json.md Normal file
View File

@ -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&apos;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&apos;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"
},
...
]
},
...
]
},
...
]
},
...
]
}
```

139
docs/samples/sample_formsemestres.json.md
View File

@ -1,39 +1,110 @@
### formsemestres ### 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 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). `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"
}
]
```

31
docs/samples/sample_groupes-formsemestre-etudiant.json.md Normal file
View File

@ -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"
},
...
]
```

38
docs/samples/sample_tous-les-etudiants.json.md Normal file
View File

@ -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": ""
},
...
]
```