diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index d3d2d17d..94990ee1 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -364,30 +364,31 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post- ### **API Etudiant** #### Structure Etudiant -| attribut | type | commentaire | -|:-----------------|:----------|:---------------------------------| -| _id_ | int | id unique | -| _code_nip_ | string | non unique! | -| _code_ine_ | string | non unique! | -| _dept_id_ | | | -| _civilite_ | string | "M", "F" ou "X" | -| _nom_ | string | en majuscule | -| _nom_usuel_ | string | null si absent | -| _prenom_ | string | | -| | | **Format long** | -| _date_naissance_ | string | date ISO | -| _email_ | string | | -| _emailperso_ | string | | -| _admission_ | admission | | -| _adresses_ | adresse* | | -| _boursier_ | | | -| _dept_acronym_ | string | | -| _dept_id_ | string | département du lieu de naissance | -| _lieu_naissance_ | string | lieu de naissance (ville) | -| _nationalite_ | string | | -| _photo_filename_ | string | | -| _scodoc7_id_ | string | de la forme 'EID9999' | -| _statut_ | string | 'I', 'D' ou 'X' | +| attribut | type | commentaire | +|:-----------------|:--------------------|:---------------------------------| +| _id_ | int | id unique | +| _code_nip_ | string | non unique! | +| _code_ine_ | string | non unique! | +| _dept_id_ | | | +| _civilite_ | string | "M", "F" ou "X" | +| _nom_ | string | en majuscule | +| _nom_usuel_ | string | null si absent | +| _prenom_ | string | | +| _sort_key_ | [ string, string ] | nom-prenom pour trier | +| | | **Format long** | +| _date_naissance_ | string | date ISO | +| _email_ | string | | +| _emailperso_ | string | | +| _admission_ | admission | | +| _adresses_ | adresse* | | +| _boursier_ | | | +| _dept_acronym_ | string | | +| _dept_id_ | string | département du lieu de naissance | +| _lieu_naissance_ | string | lieu de naissance (ville) | +| _nationalite_ | string | | +| _photo_filename_ | string | | +| _scodoc7_id_ | string | de la forme 'EID9999' | +| _statut_ | string | 'I', 'D' ou 'X' | #### **`etudiants`** (supprimé) * **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. * **Exemple de résultat:** [departement-etudiants.json](samples/sample_departement-etudiants.json.md) -#### **`formsemestre-etudiants[-query]`** +#### **`formsemestre-etudiants[-long][-query]`** * **Méthode:** GET * **Permission: `ScoView`** * **Paramètres:** `formsemestre_id` * **Query string:** `etat` ('I', 'D' ou 'DEF') * **Routes:** - * `/formsemestre//etudiants` - * `/formsemestre//etudiants/query?etat=I,D,DEF` + * `/formsemestre//etudiants` + * `/formsemestre//etudiants/query?etat=I,D,DEF` + * `/formsemestre//etudiants/long` + * `/formsemestre//etudiants/long/query?etat=I,D,DEF` * **Exemple d'utilisation:** - * `/api/formsemestre/1/etudiants` + * `/api/formsemestre/1/etudiants/long` * `/api/formsemestre/1/etudiants/query?etat=D` -* **Résultat:** Etudiants d'un formsemestre spécifié par son id. La liste est - restreinte aux étudiants inscrits (`I`), démissionnaires (`D`) ou défaillants - (`DEF`) si l'état est indiqué. +* **Résultat:** Etudiants d'un formsemestre spécifié par son id. + Une clé (`sort_key`) reproduit [ nom, prenom ] sous forme ASCII, permettant le tri des étudiants. + 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:** * [formsemestre-etudiants.json](samples/sample_formsemestre-etudiants.json.md) * [formsemestre-etudiants-query.json](samples/sample_formsemestre-etudiants-query.json.md) diff --git a/docs/img/API_Chart.odg b/docs/img/API_Chart.odg index 4c84438d..790be0cf 100644 Binary files a/docs/img/API_Chart.odg and b/docs/img/API_Chart.odg differ diff --git a/docs/img/API_Chart.svg b/docs/img/API_Chart.svg index ec964bf4..5abe25ce 100644 --- a/docs/img/API_Chart.svg +++ b/docs/img/API_Chart.svg @@ -110,6 +110,14 @@ + + + + / + + + + @@ -117,7 +125,7 @@ - + @@ -125,7 +133,7 @@ - + @@ -133,7 +141,7 @@ - + @@ -141,7 +149,7 @@ - + @@ -149,7 +157,7 @@ - + @@ -157,7 +165,7 @@ - + @@ -165,7 +173,7 @@ - + @@ -173,7 +181,7 @@ - + @@ -181,7 +189,7 @@ - + @@ -189,7 +197,7 @@ - + @@ -197,7 +205,7 @@ - + @@ -205,7 +213,7 @@ - + @@ -213,49 +221,49 @@ - + - + - + - + - + - + - + @@ -263,7 +271,7 @@ - + @@ -271,7 +279,7 @@ - + @@ -279,7 +287,7 @@ - + @@ -287,7 +295,7 @@ - + @@ -295,7 +303,7 @@ - + @@ -303,7 +311,7 @@ - + @@ -311,7 +319,7 @@ - + @@ -319,7 +327,7 @@ - + @@ -327,35 +335,35 @@ - + - + - + - + - + @@ -363,7 +371,7 @@ - + @@ -371,7 +379,7 @@ - + @@ -379,7 +387,7 @@ - + @@ -387,7 +395,7 @@ - + @@ -395,7 +403,7 @@ - + @@ -403,7 +411,7 @@ - + @@ -411,7 +419,7 @@ - + @@ -419,7 +427,7 @@ - + @@ -427,7 +435,7 @@ - + @@ -435,7 +443,7 @@ - + @@ -443,7 +451,7 @@ - + @@ -451,7 +459,7 @@ - + @@ -459,7 +467,7 @@ - + @@ -467,7 +475,7 @@ - + @@ -475,7 +483,7 @@ - + @@ -483,7 +491,7 @@ - + @@ -491,7 +499,7 @@ - + @@ -499,7 +507,7 @@ - + @@ -507,7 +515,7 @@ - + @@ -515,7 +523,7 @@ - + @@ -523,7 +531,7 @@ - + @@ -531,7 +539,7 @@ - + @@ -539,42 +547,42 @@ - + - + - + - + - + - + @@ -582,7 +590,7 @@ - + @@ -590,7 +598,7 @@ - + @@ -598,7 +606,7 @@ - + @@ -606,21 +614,21 @@ - + - + - + @@ -628,7 +636,7 @@ - + @@ -636,7 +644,7 @@ - + @@ -644,7 +652,7 @@ - + @@ -652,7 +660,7 @@ - + @@ -660,7 +668,7 @@ - + @@ -668,30 +676,30 @@ - + - - - - - - / - - - / + / + + + + / + + + + @@ -699,25 +707,25 @@ - + - ? - id360 - - - - - - - - ? - id361 + ? + id363 + + + + ? + id364 + + + + @@ -725,7 +733,7 @@ - + @@ -733,7 +741,7 @@ - + @@ -741,7 +749,7 @@ - + @@ -749,7 +757,7 @@ - + @@ -757,7 +765,7 @@ - + @@ -765,7 +773,7 @@ - + @@ -773,7 +781,7 @@ - + @@ -781,7 +789,7 @@ - + @@ -789,7 +797,7 @@ - + @@ -797,7 +805,7 @@ - + @@ -805,7 +813,7 @@ - + @@ -813,7 +821,7 @@ - + @@ -821,7 +829,7 @@ - + @@ -829,7 +837,7 @@ - + @@ -837,7 +845,7 @@ - + @@ -845,7 +853,7 @@ - + @@ -853,70 +861,70 @@ - + - + - + - + - + - + - + - + - + - + @@ -924,7 +932,7 @@ - + @@ -932,7 +940,7 @@ - + @@ -940,7 +948,7 @@ - + @@ -948,42 +956,42 @@ - + - - - - + + + + - + - - - - + + + + - + - + @@ -991,14 +999,14 @@ - + - + @@ -1006,61 +1014,39 @@ - + evaluations - - - - - - etudiants - - - - - - / + + + + etudiants - - - - demissionnaires + + + + / - - - - defaillants - - - - - - - - - - - - - - + + + + long - + @@ -1068,7 +1054,7 @@ - + @@ -1076,7 +1062,7 @@ - + @@ -1084,7 +1070,7 @@ - + @@ -1092,7 +1078,7 @@ - + @@ -1100,7 +1086,7 @@ - + @@ -1108,7 +1094,7 @@ - + @@ -1116,14 +1102,14 @@ - + - + @@ -1131,7 +1117,7 @@ - + @@ -1139,7 +1125,7 @@ - + @@ -1147,7 +1133,7 @@ - + @@ -1155,7 +1141,7 @@ - + @@ -1163,7 +1149,7 @@ - + @@ -1171,7 +1157,7 @@ - + @@ -1179,7 +1165,7 @@ - + @@ -1187,7 +1173,7 @@ - + @@ -1195,21 +1181,21 @@ - + - + - + @@ -1217,7 +1203,7 @@ - + @@ -1225,7 +1211,7 @@ - + @@ -1233,7 +1219,7 @@ - + @@ -1241,7 +1227,7 @@ - + @@ -1249,7 +1235,7 @@ - + @@ -1257,7 +1243,7 @@ - + @@ -1265,7 +1251,7 @@ - + @@ -1273,7 +1259,7 @@ - + @@ -1281,7 +1267,7 @@ - + @@ -1289,7 +1275,7 @@ - + @@ -1297,7 +1283,7 @@ - + @@ -1305,7 +1291,7 @@ - + @@ -1313,7 +1299,7 @@ - + @@ -1321,7 +1307,7 @@ - + @@ -1329,56 +1315,56 @@ - + - + - + - + - + - + - + - + @@ -1386,7 +1372,7 @@ - + @@ -1394,7 +1380,7 @@ - + @@ -1402,7 +1388,7 @@ - + @@ -1410,28 +1396,28 @@ - + - + - + - + @@ -1439,7 +1425,7 @@ - + @@ -1447,7 +1433,7 @@ - + @@ -1455,7 +1441,7 @@ - + @@ -1463,7 +1449,7 @@ - + @@ -1471,7 +1457,7 @@ - + @@ -1479,7 +1465,7 @@ - + @@ -1487,7 +1473,7 @@ - + @@ -1495,14 +1481,14 @@ - + - + @@ -1510,7 +1496,7 @@ - + @@ -1518,7 +1504,7 @@ - + @@ -1526,7 +1512,7 @@ - + @@ -1534,15 +1520,15 @@ - - - - - decisions_jury + + + + + decisions_jury - + @@ -1550,7 +1536,7 @@ - + @@ -1558,7 +1544,7 @@ - + @@ -1566,7 +1552,7 @@ - + @@ -1574,14 +1560,14 @@ - + - + @@ -1589,61 +1575,61 @@ - + - ? - id362 - - - - - - - - ? - id363 - - - - - - - - ? - id364 - - - - - - - - ? + ? id365 - - - - - ? + + + + + ? id366 - - - - - ? + + + + + ? id367 - + + + + + ? + id368 + + + + + + + + ? + id369 + + + + + + + + ? + id370 + + + + @@ -1651,7 +1637,7 @@ - + @@ -1659,7 +1645,7 @@ - + @@ -1667,7 +1653,7 @@ - + @@ -1675,7 +1661,7 @@ - + @@ -1683,7 +1669,7 @@ - + @@ -1691,7 +1677,7 @@ - + @@ -1699,7 +1685,7 @@ - + @@ -1707,7 +1693,7 @@ - + @@ -1715,70 +1701,70 @@ - + - + - + - + - + - + - + - + - + - + @@ -1786,77 +1772,77 @@ - + - + - ? - id368 - - - - - - - - ? - id369 - - - - - - - - ? - id370 - - - - - - - - ? + ? id371 - - - - - ? + + + + + ? id372 - - - - - ? + + + + + ? id373 - - - - - ? + + + + + ? id374 - + + + + + ? + id375 + + + + + + + + ? + id376 + + + + + + + + ? + id377 + + + + @@ -1864,7 +1850,7 @@ - + @@ -1872,7 +1858,7 @@ - + @@ -1880,7 +1866,7 @@ - + @@ -1888,115 +1874,115 @@ - + - ? - id375 - - - - - - - - ? - id376 - - - - - - - - ? - id377 - - - - - - - - ? + ? id378 - - - - - ? + + + + + ? id379 - - - - - ? + + + + + ? id380 - - - - - ? + + + + + ? id381 - - - - - ? + + + + + ? id382 - - - - - ? + + + + + ? id383 - - - - - ? + + + + + ? id384 - - - - - ? + + + + + ? id385 - - - - - ? + + + + + ? id386 - + + + + + ? + id387 + + + + + + + + ? + id388 + + + + + + + + ? + id389 + + + + @@ -2004,7 +1990,7 @@ - + @@ -2012,7 +1998,7 @@ - + @@ -2020,163 +2006,154 @@ - + - + - + - ? - id387 + ? + id390 - + - ? - id388 + ? + id391 - + - + - ? - id389 - - - - - - - - ? - id390 - - - - - - - - ? - id391 - - - - - - - - ? + ? id392 - - - - - ? + + + + + ? id393 - - - - - ? + + + + + ? id394 - - - - - ? + + + + + ? id395 - - - - - ? + + + + + ? id396 - - - - - ? + + + + + ? id397 - - - - - ? + + + + + ? id398 - - - - - ? + + + + + ? id399 - - - - - ? + + + + + ? id400 - - - - - ? + + + + + ? id401 - + + + + + ? + id402 + + + + + + + + ? + id403 + + + + @@ -2184,32 +2161,32 @@ - + - + - ? - id402 + ? + id404 - + - ? - id403 + ? + id405 - + @@ -2217,14 +2194,14 @@ - + - + @@ -2232,7 +2209,7 @@ - + @@ -2240,21 +2217,21 @@ - + - + - + @@ -2262,21 +2239,21 @@ - + - + - + @@ -2284,7 +2261,7 @@ - + @@ -2292,21 +2269,21 @@ - + - + - + @@ -2314,7 +2291,7 @@ - + @@ -2322,7 +2299,7 @@ - + @@ -2330,14 +2307,14 @@ - + - + @@ -2345,7 +2322,7 @@ - + @@ -2353,7 +2330,7 @@ - + @@ -2361,7 +2338,7 @@ - + @@ -2369,21 +2346,21 @@ - + - + - + @@ -2391,7 +2368,7 @@ - + @@ -2399,7 +2376,7 @@ - + @@ -2407,7 +2384,7 @@ - + @@ -2415,7 +2392,7 @@ - + @@ -2423,7 +2400,7 @@ - + @@ -2431,7 +2408,7 @@ - + @@ -2439,7 +2416,7 @@ - + @@ -2447,7 +2424,7 @@ - + @@ -2455,7 +2432,7 @@ - + @@ -2463,7 +2440,7 @@ - + @@ -2471,7 +2448,7 @@ - + @@ -2479,7 +2456,7 @@ - + @@ -2487,7 +2464,7 @@ - + @@ -2495,7 +2472,7 @@ - + @@ -2503,7 +2480,7 @@ - + @@ -2511,7 +2488,7 @@ - + @@ -2519,21 +2496,21 @@ - + - + - + @@ -2541,14 +2518,14 @@ - + - + @@ -2556,7 +2533,7 @@ - + @@ -2564,187 +2541,187 @@ - + - ? - id404 - - - - - - - - ? - id405 - - - - - - - - ? + ? id406 - - - - - ? + + + + + ? id407 - - - - - ? + + + + + ? id408 - - - - - ? + + + + + ? id409 - - - - - ? + + + + + ? id410 - - - - - ? + + + + + ? id411 - - - - - ? + + + + + ? id412 - - - - - ? + + + + + ? id413 - - - - - ? + + + + + ? id414 - - - - - ? + + + + + ? id415 - - - - - ? + + + + + ? id416 - - - - - ? + + + + + ? id417 - - - - - ? + + + + + ? id418 - - - - - ? + + + + + ? id419 - - - - - ? + + + + + ? id420 - - - - - ? + + + + + ? id421 - - - - - ? + + + + + ? id422 - - - - - ? + + + + + ? id423 - + + + + + ? + id424 + + + + + + + + ? + id425 + + + + @@ -2752,79 +2729,79 @@ - + - ? - id424 - - - - - - - - ? - id425 - - - - - - - - ? + ? id426 - - - - - ? + + + + + ? id427 - - - - - ? + + + + + ? id428 - - - - - ? + + + + + ? id429 - - - - - ? + + + + + ? id430 - - - - - ? + + + + + ? id431 - + + + + + ? + id432 + + + + + + + + ? + id433 + + + + @@ -2832,16 +2809,16 @@ - + - ? - id432 + ? + id434 - + @@ -2849,100 +2826,100 @@ - + - ? - id433 + ? + id435 - + - + - + - + - ? - id434 - - - - - - - - ? - id435 - - - - - - - - ? + ? id436 - - - - - ? + + + + + ? id437 - - - - - ? + + + + + ? id438 - - - - - ? + + + + + ? id439 - - - - - ? + + + + + ? id440 - + + + + + ? + id441 + + + + + + + + ? + id442 + + + + @@ -2950,20 +2927,64 @@ - + - ? - id441 + ? + id443 - + + + + + + + query + + + + + + + + ? + id444 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/samples/sample_formsemestre-etudiants.json.md b/docs/samples/sample_formsemestre-etudiants.json.md index eb1da096..c65a15b5 100644 --- a/docs/samples/sample_formsemestre-etudiants.json.md +++ b/docs/samples/sample_formsemestre-etudiants.json.md @@ -3,6 +3,21 @@ #### GET /formsemestre/1/etudiants ```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", "code_ine": "INE1", @@ -12,18 +27,154 @@ "id": 1, "nom": "COSTA", "nom_usuel": null, - "prenom": "SACHA" - }, - { - "civilite": "F", - "code_ine": "2", - "code_nip": "NIP2", - "dept_id": 1, - "groups": [], - "id": 2, - "nom": "NAUDIN", - "nom_usuel": null, - "prenom": "SIMONE" + "prenom": "SACHA", + "sort_key": [ + "costa", + "sacha" + ] + }, + "..." +] +``` + +#### GET /formsemestre/1/etudiants/long +```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 }, "..." ]