forked from ScoDoc/DocScoDoc
Merge pull request 'description modif formsemestre-etudiant' (#46) from jmplace/DocScoDoc:fix_2022-08-30 into master
Reviewed-on: https://scodoc.org/git/viennet/DocScoDoc/pulls/46
This commit is contained in:
commit
58e422fc49
@ -364,30 +364,31 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
|||||||
### **API Etudiant**
|
### **API Etudiant**
|
||||||
#### Structure Etudiant
|
#### Structure Etudiant
|
||||||
|
|
||||||
| attribut | type | commentaire |
|
| attribut | type | commentaire |
|
||||||
|:-----------------|:----------|:---------------------------------|
|
|:-----------------|:--------------------|:---------------------------------|
|
||||||
| _id_ | int | id unique |
|
| _id_ | int | id unique |
|
||||||
| _code_nip_ | string | non unique! |
|
| _code_nip_ | string | non unique! |
|
||||||
| _code_ine_ | string | non unique! |
|
| _code_ine_ | string | non unique! |
|
||||||
| _dept_id_ | | |
|
| _dept_id_ | | |
|
||||||
| _civilite_ | string | "M", "F" ou "X" |
|
| _civilite_ | string | "M", "F" ou "X" |
|
||||||
| _nom_ | string | en majuscule |
|
| _nom_ | string | en majuscule |
|
||||||
| _nom_usuel_ | string | null si absent |
|
| _nom_usuel_ | string | null si absent |
|
||||||
| _prenom_ | string | |
|
| _prenom_ | string | |
|
||||||
| | | **Format long** |
|
| _sort_key_ | [ string, string ] | nom-prenom pour trier |
|
||||||
| _date_naissance_ | string | date ISO |
|
| | | **Format long** |
|
||||||
| _email_ | string | |
|
| _date_naissance_ | string | date ISO |
|
||||||
| _emailperso_ | string | |
|
| _email_ | string | |
|
||||||
| _admission_ | admission | |
|
| _emailperso_ | string | |
|
||||||
| _adresses_ | adresse* | |
|
| _admission_ | admission | |
|
||||||
| _boursier_ | | |
|
| _adresses_ | adresse* | |
|
||||||
| _dept_acronym_ | string | |
|
| _boursier_ | | |
|
||||||
| _dept_id_ | string | département du lieu de naissance |
|
| _dept_acronym_ | string | |
|
||||||
| _lieu_naissance_ | string | lieu de naissance (ville) |
|
| _dept_id_ | string | département du lieu de naissance |
|
||||||
| _nationalite_ | string | |
|
| _lieu_naissance_ | string | lieu de naissance (ville) |
|
||||||
| _photo_filename_ | string | |
|
| _nationalite_ | string | |
|
||||||
| _scodoc7_id_ | string | de la forme 'EID9999' |
|
| _photo_filename_ | string | |
|
||||||
| _statut_ | string | 'I', 'D' ou 'X' |
|
| _scodoc7_id_ | string | de la forme 'EID9999' |
|
||||||
|
| _statut_ | string | 'I', 'D' ou 'X' |
|
||||||
|
|
||||||
#### **`etudiants`** (supprimé)
|
#### **`etudiants`** (supprimé)
|
||||||
* **Méthode:** GET
|
* **Méthode:** GET
|
||||||
@ -436,20 +437,23 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
|||||||
Attention, la liste peut être longue: requête coûteuse à éviter.
|
Attention, la liste peut être longue: requête coûteuse à éviter.
|
||||||
* **Exemple de résultat:** [departement-etudiants.json](samples/sample_departement-etudiants.json.md)
|
* **Exemple de résultat:** [departement-etudiants.json](samples/sample_departement-etudiants.json.md)
|
||||||
|
|
||||||
#### **`formsemestre-etudiants[-query]`**
|
#### **`formsemestre-etudiants[-long][-query]`**
|
||||||
* **Méthode:** GET
|
* **Méthode:** GET
|
||||||
* **Permission: `ScoView`**
|
* **Permission: `ScoView`**
|
||||||
* **Paramètres:** `formsemestre_id`
|
* **Paramètres:** `formsemestre_id`
|
||||||
* **Query string:** `etat` ('I', 'D' ou 'DEF')
|
* **Query string:** `etat` ('I', 'D' ou 'DEF')
|
||||||
* **Routes:**
|
* **Routes:**
|
||||||
* `/formsemestre/<int:formsemestre_id>/etudiants`
|
* `/formsemestre/<int:formsemestre_id>/etudiants`
|
||||||
* `/formsemestre/<int:formsemestre_id>/etudiants/query?etat=I,D,DEF`
|
* `/formsemestre/<int:formsemestre_id>/etudiants/query?etat=I,D,DEF`
|
||||||
|
* `/formsemestre/<int:formsemestre_id>/etudiants/long`
|
||||||
|
* `/formsemestre/<int:formsemestre_id>/etudiants/long/query?etat=I,D,DEF`
|
||||||
* **Exemple d'utilisation:**
|
* **Exemple d'utilisation:**
|
||||||
* `/api/formsemestre/1/etudiants`
|
* `/api/formsemestre/1/etudiants/long`
|
||||||
* `/api/formsemestre/1/etudiants/query?etat=D`
|
* `/api/formsemestre/1/etudiants/query?etat=D`
|
||||||
* **Résultat:** Etudiants d'un formsemestre spécifié par son id. La liste est
|
* **Résultat:** Etudiants d'un formsemestre spécifié par son id.
|
||||||
restreinte aux étudiants inscrits (`I`), démissionnaires (`D`) ou défaillants
|
Une clé (`sort_key`) reproduit [ nom, prenom ] sous forme ASCII, permettant le tri des étudiants.
|
||||||
(`DEF`) si l'état est indiqué.
|
Avec `query`, La liste est restreinte aux étudiants inscrits (`I`), démissionnaires (`D`) ou défaillants (`DEF`) si l'état est indiqué.
|
||||||
|
Avec `long`, ajoute la date de naissance entre autre
|
||||||
* **Exemple de résultat:**
|
* **Exemple de résultat:**
|
||||||
* [formsemestre-etudiants.json](samples/sample_formsemestre-etudiants.json.md)
|
* [formsemestre-etudiants.json](samples/sample_formsemestre-etudiants.json.md)
|
||||||
* [formsemestre-etudiants-query.json](samples/sample_formsemestre-etudiants-query.json.md)
|
* [formsemestre-etudiants-query.json](samples/sample_formsemestre-etudiants-query.json.md)
|
||||||
|
Binary file not shown.
File diff suppressed because it is too large
Load Diff
Before Width: | Height: | Size: 335 KiB After Width: | Height: | Size: 336 KiB |
@ -3,6 +3,21 @@
|
|||||||
#### GET /formsemestre/1/etudiants
|
#### GET /formsemestre/1/etudiants
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
|
{
|
||||||
|
"civilite": "F",
|
||||||
|
"code_ine": "10",
|
||||||
|
"code_nip": "NIP10",
|
||||||
|
"dept_id": 1,
|
||||||
|
"groups": [],
|
||||||
|
"id": 10,
|
||||||
|
"nom": "BOUTET",
|
||||||
|
"nom_usuel": null,
|
||||||
|
"prenom": "MARGUERITE",
|
||||||
|
"sort_key": [
|
||||||
|
"boutet",
|
||||||
|
"marguerite"
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"civilite": "X",
|
"civilite": "X",
|
||||||
"code_ine": "INE1",
|
"code_ine": "INE1",
|
||||||
@ -12,18 +27,154 @@
|
|||||||
"id": 1,
|
"id": 1,
|
||||||
"nom": "COSTA",
|
"nom": "COSTA",
|
||||||
"nom_usuel": null,
|
"nom_usuel": null,
|
||||||
"prenom": "SACHA"
|
"prenom": "SACHA",
|
||||||
},
|
"sort_key": [
|
||||||
{
|
"costa",
|
||||||
"civilite": "F",
|
"sacha"
|
||||||
"code_ine": "2",
|
]
|
||||||
"code_nip": "NIP2",
|
},
|
||||||
"dept_id": 1,
|
"..."
|
||||||
"groups": [],
|
]
|
||||||
"id": 2,
|
```
|
||||||
"nom": "NAUDIN",
|
|
||||||
"nom_usuel": null,
|
#### GET /formsemestre/1/etudiants/long
|
||||||
"prenom": "SIMONE"
|
```json
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"admission": {
|
||||||
|
"anglais": null,
|
||||||
|
"annee": null,
|
||||||
|
"annee_bac": null,
|
||||||
|
"apb_classement_gr": null,
|
||||||
|
"apb_groupe": null,
|
||||||
|
"bac": null,
|
||||||
|
"boursier_prec": null,
|
||||||
|
"classement": null,
|
||||||
|
"codelycee": null,
|
||||||
|
"codepostallycee": null,
|
||||||
|
"commentaire": null,
|
||||||
|
"decision": null,
|
||||||
|
"etudid": 10,
|
||||||
|
"francais": null,
|
||||||
|
"id": 10,
|
||||||
|
"math": null,
|
||||||
|
"nomlycee": null,
|
||||||
|
"physique": null,
|
||||||
|
"qualite": null,
|
||||||
|
"rang": null,
|
||||||
|
"rapporteur": null,
|
||||||
|
"score": null,
|
||||||
|
"specialite": null,
|
||||||
|
"type_admission": null,
|
||||||
|
"villelycee": null
|
||||||
|
},
|
||||||
|
"adresses": [
|
||||||
|
{
|
||||||
|
"codepostaldomicile": null,
|
||||||
|
"description": null,
|
||||||
|
"domicile": null,
|
||||||
|
"email": "MARGUERITE.BOUTET@example.com",
|
||||||
|
"emailperso": null,
|
||||||
|
"etudid": 10,
|
||||||
|
"fax": null,
|
||||||
|
"id": 10,
|
||||||
|
"paysdomicile": null,
|
||||||
|
"telephone": null,
|
||||||
|
"telephonemobile": null,
|
||||||
|
"typeadresse": "domicile",
|
||||||
|
"villedomicile": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"boursier": null,
|
||||||
|
"civilite": "F",
|
||||||
|
"code_ine": "10",
|
||||||
|
"code_nip": "NIP10",
|
||||||
|
"date_naissance": null,
|
||||||
|
"dept_acronym": "TAPI",
|
||||||
|
"dept_id": 1,
|
||||||
|
"dept_naissance": null,
|
||||||
|
"groups": [],
|
||||||
|
"id": 10,
|
||||||
|
"lieu_naissance": null,
|
||||||
|
"nationalite": null,
|
||||||
|
"nom": "BOUTET",
|
||||||
|
"nom_usuel": null,
|
||||||
|
"photo_filename": null,
|
||||||
|
"prenom": "MARGUERITE",
|
||||||
|
"scodoc7_id": null,
|
||||||
|
"sort_key": [
|
||||||
|
"boutet",
|
||||||
|
"marguerite"
|
||||||
|
],
|
||||||
|
"statut": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"admission": {
|
||||||
|
"anglais": null,
|
||||||
|
"annee": null,
|
||||||
|
"annee_bac": null,
|
||||||
|
"apb_classement_gr": null,
|
||||||
|
"apb_groupe": null,
|
||||||
|
"bac": null,
|
||||||
|
"boursier_prec": null,
|
||||||
|
"classement": null,
|
||||||
|
"codelycee": null,
|
||||||
|
"codepostallycee": null,
|
||||||
|
"commentaire": null,
|
||||||
|
"decision": null,
|
||||||
|
"etudid": 1,
|
||||||
|
"francais": null,
|
||||||
|
"id": 1,
|
||||||
|
"math": null,
|
||||||
|
"nomlycee": null,
|
||||||
|
"physique": null,
|
||||||
|
"qualite": null,
|
||||||
|
"rang": null,
|
||||||
|
"rapporteur": null,
|
||||||
|
"score": null,
|
||||||
|
"specialite": null,
|
||||||
|
"type_admission": null,
|
||||||
|
"villelycee": null
|
||||||
|
},
|
||||||
|
"adresses": [
|
||||||
|
{
|
||||||
|
"codepostaldomicile": null,
|
||||||
|
"description": null,
|
||||||
|
"domicile": null,
|
||||||
|
"email": "SACHA.COSTA@example.com",
|
||||||
|
"emailperso": null,
|
||||||
|
"etudid": 1,
|
||||||
|
"fax": null,
|
||||||
|
"id": 1,
|
||||||
|
"paysdomicile": null,
|
||||||
|
"telephone": null,
|
||||||
|
"telephonemobile": null,
|
||||||
|
"typeadresse": "domicile",
|
||||||
|
"villedomicile": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"boursier": null,
|
||||||
|
"civilite": "X",
|
||||||
|
"code_ine": "INE1",
|
||||||
|
"code_nip": "1",
|
||||||
|
"date_naissance": null,
|
||||||
|
"dept_acronym": "TAPI",
|
||||||
|
"dept_id": 1,
|
||||||
|
"dept_naissance": null,
|
||||||
|
"groups": [],
|
||||||
|
"id": 1,
|
||||||
|
"lieu_naissance": null,
|
||||||
|
"nationalite": null,
|
||||||
|
"nom": "COSTA",
|
||||||
|
"nom_usuel": null,
|
||||||
|
"photo_filename": null,
|
||||||
|
"prenom": "SACHA",
|
||||||
|
"scodoc7_id": null,
|
||||||
|
"sort_key": [
|
||||||
|
"costa",
|
||||||
|
"sacha"
|
||||||
|
],
|
||||||
|
"statut": null
|
||||||
},
|
},
|
||||||
"..."
|
"..."
|
||||||
]
|
]
|
||||||
|
Loading…
Reference in New Issue
Block a user