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

remise a niveau exemples ; ajout user-password

Browse Source
This commit is contained in:
Jean-Marie PLACE 2022-08-21 12:13:57 +02:00
parent 24a8f3e585
commit cd3767271b
64 changed files with 9475 additions and 9377 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
docs/ScoDoc9API.md
View File

@ -205,7 +205,7 @@ Ce tableau est trié selon le type des informations renvoyées:
les données de ScoDoc. les données de ScoDoc.
| Retour | Remarque | Méthode | Navigation | | Retour | Remarque | Méthode | Navigation |
|:------------------------|:----------------------------------|---------|---------------------------------------------------------------------------| |:------------------------|:----------------------------------------|---------|---------------------------------------------------------------------------|
| departement**`*`** | tous les depts | GET | [departements](#departements) | | departement**`*`** | tous les depts | GET | [departements](#departements) |
| departement**`#`** | tous les ids des depts | GET | [departements-ids](#departements-ids) | | departement**`#`** | tous les ids des depts | GET | [departements-ids](#departements-ids) |
| departement | recherche par id | GET | [departement](#departement) | | departement | recherche par id | GET | [departement](#departement) |
@ -257,12 +257,13 @@ Ce tableau est trié selon le type des informations renvoyées:
| note* | | GET | [evaluation-notes](#evaluation-notes) | | note* | | GET | [evaluation-notes](#evaluation-notes) |
| logo**`*`** | | GET | [logos](#logos) | | logo**`*`** | | GET | [logos](#logos) |
| logo**`*`** | | GET | [departement-logos](#departement-logos) | | logo**`*`** | | GET | [departement-logos](#departement-logos) |
| image | | GET | [logo](#logo) | | logo | | GET | [logo](#logo) |
| image | | GET | [departement-logo](#departement-logo) | | logo | | GET | [departement-logo](#departement-logo) |
| user | | GET | [user](#user) | | user | | GET | [user](#user) |
| user**`*`** | | GET | [users-query](#users-query) | | user**`*`** | | GET | [users-query](#users-query) |
| user:CREATE | | POST | [user-create](#user-create) | | user:CREATE | | POST | [user-create](#user-create) |
| user:EDIT | | POST | [user-edit](#user-edit) | | user:EDIT | | POST | [user-edit](#user-edit) |
| user:PASSWORD | change le mot de passe d'un utilisateur | POST | [user-password](#user-password) |
| user:DELETE | | POST | [user-delete](#user-delete) | | user:DELETE | | POST | [user-delete](#user-delete) |
| user:ACTION | | POST | [user-role-add](#user-role-add) | | user:ACTION | | POST | [user-role-add](#user-role-add) |
| user:ACTION | | POST | [user-role-remove](#user-role-remove) | | user:ACTION | | POST | [user-role-remove](#user-role-remove) |
@ -275,6 +276,14 @@ Ce tableau est trié selon le type des informations renvoyées:
| role:EDIT | | POST | [role-edit](#role-edit) | | role:EDIT | | POST | [role-edit](#role-edit) |
| role:DELETE | | POST | [role-delete](#role-delete) | | role:DELETE | | POST | [role-delete](#role-delete) |
#### Note sur les exemples d'utilisation
Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-traitements non réalisés par l'API. Il n'est par exemple pas garanti que les clés des objets json sont triées:
* les clés sont triées
* les listes de plus de 2 éléments sont tronquées à 2 éléments, la fin de la liste étant représentée par la notation nn json '...'
* les dates (au format iso) sont systématiquement remplacées par une date fixe (la date de modification d'un mot de passe peut évidement être différente de sa date de création)
### **API Départements** ### **API Départements**
#### Structure Département #### Structure Département
@ -296,6 +305,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **departements-ids** #### **departements-ids**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** `/departements_ids` * **Routes:** `/departements_ids`
* **Résultat:** Liste des id départements (visibles ou non). * **Résultat:** Liste des id départements (visibles ou non).
* **Exemple de résultat:** * **Exemple de résultat:**
@ -303,6 +313,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **departement** #### **departement**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** * **Routes:**
* `/departement/id/<int:dept_id>` * `/departement/id/<int:dept_id>`
* `/departement/<string:dept>` * `/departement/<string:dept>`
@ -386,6 +397,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`etudiants-courants`** #### **`etudiants-courants`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** * **Routes:**
* `/etudiants/courants` * `/etudiants/courants`
* `/etudiants/courants/long` * `/etudiants/courants/long`
@ -397,6 +409,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`etudiants-clef`** #### **`etudiants-clef`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **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`
@ -410,6 +423,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **departement-etudiants** #### **departement-etudiants**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `dept`, `dept_id` * **Paramètres:** `dept`, `dept_id`
* **Routes:** * **Routes:**
* `/departement/id/<int:dept_id>/etudiants` * `/departement/id/<int:dept_id>/etudiants`
@ -422,6 +436,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`formsemestre-etudiants[-query]`** #### **`formsemestre-etudiants[-query]`**
* **Méthode:** GET * **Méthode:** GET
* **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:**
@ -439,6 +454,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`group-etudiants[-query]`** #### **`group-etudiants[-query]`**
* **Méthode: GET** * **Méthode: GET**
* **Permission: `ScoView`**
* **Paramètres:** `group_id` * **Paramètres:** `group_id`
* **Query string:** `etat` ('I', 'D' ou 'DEF') * **Query string:** `etat` ('I', 'D' ou 'DEF')
* **Routes:** * **Routes:**
@ -456,6 +472,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`etudiant`** #### **`etudiant`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** * **Routes:**
* `/etudiant/etudid/<int:etudid>` ou * `/etudiant/etudid/<int:etudid>` ou
@ -487,6 +504,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`formations`** #### **`formations`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** `/formations` * **Routes:** `/formations`
* **Exemple d'utilisation:** `/ScoDoc/api/formations` * **Exemple d'utilisation:** `/ScoDoc/api/formations`
* **Résultat:** Liste de toutes les formations (tous départements accessibles). * **Résultat:** Liste de toutes les formations (tous départements accessibles).
@ -494,6 +512,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`formations_ids`** #### **`formations_ids`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Routes:** `/formations_ids` * **Routes:** `/formations_ids`
* **Exemple d'utilisation:** `/ScoDoc/api/formations_ids` * **Exemple d'utilisation:** `/ScoDoc/api/formations_ids`
* **Résultat:** Liste des ids de toutes les formations (tous départements * **Résultat:** Liste des ids de toutes les formations (tous départements
@ -502,6 +521,7 @@ Ce tableau est trié selon le type des informations renvoyées:
#### **`formation`** #### **`formation`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formation_id` * **Paramètres:** `formation_id`
* **Routes:** `/formation/<int:formation_id>` * **Routes:** `/formation/<int:formation_id>`
* **Exemple d'utilisation:** `/ScoDoc/api/formation/1` * **Exemple d'utilisation:** `/ScoDoc/api/formation/1`
@ -572,6 +592,7 @@ informatique de 2014 en formation initiale (FI).
#### **departement-formsemestres_ids** #### **departement-formsemestres_ids**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `dept` * **Paramètres:** `dept`
* **Routes:** * **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_ids` * `/departement/id/<int:dept_id>/formsemestres_ids`
@ -583,6 +604,7 @@ informatique de 2014 en formation initiale (FI).
#### **departement-formsemestres-courants** #### **departement-formsemestres-courants**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `dept_id` * **Paramètres:** `dept_id`
* **Routes:** * **Routes:**
* `/departement/id/<int:dept_id>/formsemestres_courants` * `/departement/id/<int:dept_id>/formsemestres_courants`
@ -593,6 +615,7 @@ informatique de 2014 en formation initiale (FI).
#### **formsemestres-query** #### **formsemestres-query**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** aucun * **Paramètres:** aucun
* **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
@ -605,6 +628,7 @@ informatique de 2014 en formation initiale (FI).
#### **etudiant-formsemestres** #### **etudiant-formsemestres**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `etudid`, `nip`, `ine` * **Paramètres:** `etudid`, `nip`, `ine`
* **Routes:** : * **Routes:** :
* `/etudiant/etudid/<int:etudid>/formsemestres` ou * `/etudiant/etudid/<int:etudid>/formsemestres` ou
@ -617,6 +641,7 @@ informatique de 2014 en formation initiale (FI).
#### **formsemestre** #### **formsemestre**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Route:** `/formsemestre/<int:formsemestre_id>` * **Route:** `/formsemestre/<int:formsemestre_id>`
* **Exemple d'utilisation:** `/api/formsemestre/1` * **Exemple d'utilisation:** `/api/formsemestre/1`
@ -627,7 +652,7 @@ informatique de 2014 en formation initiale (FI).
#### **`partition-group-create`** #### **`partition-group-create`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Data:** `{ group_name : <string> }` * **Data:** `{ group_name : <string> }`
* **Routes:** `/partition/<int:partition_id>/create` * **Routes:** `/partition/<int:partition_id>/create`
@ -638,7 +663,7 @@ informatique de 2014 en formation initiale (FI).
#### **`group-edit`** #### **`group-edit`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `group_id` * **Paramètres:** `group_id`
* **Data:** `{ group_name : <string> }` * **Data:** `{ group_name : <string> }`
* **Routes:** `/group/<int:group_id>/edit` * **Routes:** `/group/<int:group_id>/edit`
@ -649,6 +674,7 @@ informatique de 2014 en formation initiale (FI).
#### **`partition-groups-order`** #### **`partition-groups-order`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Data:** `[ <int:group_id1>, <int:group_id2>, ... ]` * **Data:** `[ <int:group_id1>, <int:group_id2>, ... ]`
* **Routes:** `/partition/<int:partition_id>/groups/order` * **Routes:** `/partition/<int:partition_id>/groups/order`
@ -659,7 +685,7 @@ informatique de 2014 en formation initiale (FI).
#### **`group-delete`** #### **`group-delete`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `group_id` * **Paramètres:** `group_id`
* **Routes:** `/group/<int:group_id>/delete` * **Routes:** `/group/<int:group_id>/delete`
* **Exemple d'utilisation:** `/ScoDoc/api/group/4581/delete` * **Exemple d'utilisation:** `/ScoDoc/api/group/4581/delete`
@ -668,6 +694,7 @@ informatique de 2014 en formation initiale (FI).
#### **etudiant-formsemestre-groups** #### **etudiant-formsemestre-groups**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
* **Routes:** * **Routes:**
`/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou `/etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups` ou
@ -679,7 +706,7 @@ informatique de 2014 en formation initiale (FI).
#### **`group-set_etudiant`** #### **`group-set_etudiant`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `group_id`, `etudid` * **Paramètres:** `group_id`, `etudid`
* **Routes:** `/group/<int:group_id>/set_etudiant/<int:etudid>` * **Routes:** `/group/<int:group_id>/set_etudiant/<int:etudid>`
* **Exemple d'utilisation:** `/ScoDoc/api/group/4085/set_etudiant/12108` * **Exemple d'utilisation:** `/ScoDoc/api/group/4085/set_etudiant/12108`
@ -688,7 +715,7 @@ informatique de 2014 en formation initiale (FI).
#### **`group-remove_etudiant`** #### **`group-remove_etudiant`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`**
* **Paramètres:** `group_id`, `etudid` * **Paramètres:** `group_id`, `etudid`
* **Routes:** `/group/<int:group_id>/remove_etudiant/<int:etudid>` * **Routes:** `/group/<int:group_id>/remove_etudiant/<int:etudid>`
* **Exemple d'utilisation:** `/ScoDoc/api/group/4085/remove_etudiant/12108` * **Exemple d'utilisation:** `/ScoDoc/api/group/4085/remove_etudiant/12108`
@ -697,6 +724,7 @@ informatique de 2014 en formation initiale (FI).
### **API Jury** ### **API Jury**
#### **`formsemestre-decisions_jury`** #### **`formsemestre-decisions_jury`**
* **Permission: `ScoView`**
* **Méthode:** GET * **Méthode:** GET
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/decisions_jury` * **Routes:** `/formsemestre/<int:formsemestre_id>/decisions_jury`
@ -725,6 +753,7 @@ responsable et ses enseignants). La liste des moduleimpl d'un formsemestre peut
#### **`moduleimpl`** #### **`moduleimpl`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `moduleimpl_id` * **Paramètres:** `moduleimpl_id`
* **Routes:** `/moduleimpl/<int:moduleimpl_id>` * **Routes:** `/moduleimpl/<int:moduleimpl_id>`
* **Exemple d'utilisation:** `/ScoDoc/api/formation/moduleimpl/1` * **Exemple d'utilisation:** `/ScoDoc/api/formation/moduleimpl/1`
@ -751,6 +780,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`formsemestre-partitions`** #### **`formsemestre-partitions`**
* **Méthode: GET** * **Méthode: GET**
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/partitions` * **Routes:** `/formsemestre/<int:formsemestre_id>/partitions`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/911/partitions` * **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/911/partitions`
@ -759,6 +789,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`partition`** #### **`partition`**
* **Méthode: GET** * **Méthode: GET**
* **Permission: `ScoView`**
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Routes:** `/partition/<int:partition_id>` * **Routes:** `/partition/<int:partition_id>`
* **Exemple d'utilisation:** `/ScoDoc/api/partition/1963` * **Exemple d'utilisation:** `/ScoDoc/api/partition/1963`
@ -767,6 +798,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`formsemestre-partition-create`** #### **`formsemestre-partition-create`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudsChangeGroups`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Data:** `{ "partition_name" : <string> }` * **Data:** `{ "partition_name" : <string> }`
* **Routes:** `/formsemestre/<int:formsemestre_id>/partition/create` * **Routes:** `/formsemestre/<int:formsemestre_id>/partition/create`
@ -777,6 +809,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`partition-edit`** #### **`partition-edit`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudsChangeGroups`**
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Data:** `{ partition_name : <string> }` * **Data:** `{ partition_name : <string> }`
* **Routes:** `/partition/<int:partition_id>/edit` * **Routes:** `/partition/<int:partition_id>/edit`
@ -787,6 +820,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`formsemestre-partitions-order`** #### **`formsemestre-partitions-order`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudsChangeGroups`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Data:** `[ <int:partition_id1>, <int:partition_id2>, ... ]` * **Data:** `[ <int:partition_id1>, <int:partition_id2>, ... ]`
* **Routes:** `/formsemestre/<int:formsemestre_id>/partitions/order` * **Routes:** `/formsemestre/<int:formsemestre_id>/partitions/order`
@ -797,6 +831,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`partition-delete`** #### **`partition-delete`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudsChangeGroups`**
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Routes:** `/partition/<int:partition_id>/delete` * **Routes:** `/partition/<int:partition_id>/delete`
* **Exemple d'utilisation:** `/ScoDoc/api/partition/2047/delete` * **Exemple d'utilisation:** `/ScoDoc/api/partition/2047/delete`
@ -805,6 +840,7 @@ d'un nombre quelconque de groupes d'étudiants.
#### **`partition-remove_etudiant`** #### **`partition-remove_etudiant`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoEtudsChangeGroups`**
* **Permission: `ScoEtudChangeGroups`*** * **Permission: `ScoEtudChangeGroups`***
* **Paramètres:** `partition_id` * **Paramètres:** `partition_id`
* **Routes:** `/partition/<int:partition_id>/remove_etudiant/<int:etudid>` * **Routes:** `/partition/<int:partition_id>/remove_etudiant/<int:etudid>`
@ -821,6 +857,7 @@ d'un autre).
#### **roles** #### **roles**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoUsersView`**
* **Routes:** `/roles` * **Routes:** `/roles`
* **Exemple d'utilisation:** `/roles` * **Exemple d'utilisation:** `/roles`
* **Résultat:** Liste de tous les rôles. * **Résultat:** Liste de tous les rôles.
@ -828,6 +865,7 @@ d'un autre).
#### **role** #### **role**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoUsersView`**
* **Routes:** `/role/<str:role_name>` * **Routes:** `/role/<str:role_name>`
* **Exemple d'utilisation:** `/role/Ens` * **Exemple d'utilisation:** `/role/Ens`
* **Résultat:** Liste le rôle indiqué. 404 si inexistant. * **Résultat:** Liste le rôle indiqué. 404 si inexistant.
@ -882,6 +920,7 @@ d'un autre).
### **API User, Permissions** ### **API User, Permissions**
#### **user** #### **user**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoUsersView`**
* **Paramètres:** `user_id` * **Paramètres:** `user_id`
* **Route:** `/user/<int:user_id>` * **Route:** `/user/<int:user_id>`
* **Exemple d'utilisation:** `/api/user/1` * **Exemple d'utilisation:** `/api/user/1`
@ -892,7 +931,7 @@ d'un autre).
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoUsersAdmin`** * **Permission: `ScoUsersAdmin`**
* **Data:** * **Data:**
``` ```json
{ {
"user_name": str, "user_name": str,
"dept": str or null, "dept": str or null,
@ -909,6 +948,7 @@ d'un autre).
#### **`users-query`** #### **`users-query`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoUsersView`**
* **Routes:** * **Routes:**
* `/users/query?departement=dept_acronym&active=1&starts_with=<str:nom>` * `/users/query?departement=dept_acronym&active=1&starts_with=<str:nom>`
* **Résultat:** Liste d'utilisateurs, filtrés par département, statut, début de * **Résultat:** Liste d'utilisateurs, filtrés par département, statut, début de
@ -916,12 +956,11 @@ d'un autre).
permission de voir sont listés. permission de voir sont listés.
* **Exemple de résultat:** [users-query.json](samples/sample_users-query.json.md) * **Exemple de résultat:** [users-query.json](samples/sample_users-query.json.md)
#### **`user-edit`** #### **`user-edit`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoUsersAdmin`** * **Permission: `ScoUsersAdmin`**
* **Data:** * **Data:**
``` ```json
{ {
"dept": str or null, "dept": str or null,
"nom": str, "nom": str,
@ -933,9 +972,30 @@ d'un autre).
* **Résultat:** Modifie l'utilisateur d'UID indiqué. * **Résultat:** Modifie l'utilisateur d'UID indiqué.
* **Exemple de résultat:** [user-edit.json](samples/sample_user-edit.json.md) * **Exemple de résultat:** [user-edit.json](samples/sample_user-edit.json.md)
#### **`user-role-add`** #### **`user-password`**
* **Méthode: POST** * **Méthode: POST**
* **Permission: `ScoUsersAdmin`** * **Permission: `ScoUsersAdmin`**
* **Data:** `{ "password": str }`
* **Routes:** `/user/<int:uid>/password`
* **Exemple d'utilisation:** `/user/3/password`
>`{ "password": "averycomplicatedpassaword" }
* **Résultat:** Modifie le mot de passe de l'utilisateur désigné par son UID.
L'opération peut être rejetée si le mot de passe ne satisfait pas les conditions requises (trop simple par exemple), avec le retour suivant:
>
> ```json
{
"error": "Bad Request",
"status": 400,
"message": "user_password: invalid password"
}
```
* **Exemple de résultat:** [user-password.json](samples/sample_user-password.json.md)
#### **`user-role-add`**
* **Méthode: POST**
* **Permission: `ScoSuperAdmin`**
* **Routes:** `/user/<int:uid>/role/<str:role_name>/add[/departement/<string:dept_acronym>]` * **Routes:** `/user/<int:uid>/role/<str:role_name>/add[/departement/<string:dept_acronym>]`
* **Résultat:** Attribue le rôle à l'utilisateur, dans le département indiqué * **Résultat:** Attribue le rôle à l'utilisateur, dans le département indiqué
(ou tous si le département n'est pas spécifié).) (ou tous si le département n'est pas spécifié).)
@ -950,6 +1010,7 @@ d'un autre).
#### **`permissions`** #### **`permissions`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoUsersView`**
* **Routes:** `/permissions` * **Routes:** `/permissions`
* **Résultat:** Liste des noms des permissions. Ces permissions ne sont pas * **Résultat:** Liste des noms des permissions. Ces permissions ne sont pas
modifiables, mais de nouvelles peuvent apparaitre lors des mises à jour du modifiables, mais de nouvelles peuvent apparaitre lors des mises à jour du
@ -959,6 +1020,7 @@ d'un autre).
### ** API Bulletin, Evaluations, Notes** ### ** API Bulletin, Evaluations, Notes**
#### **formsemestre-bulletins** #### **formsemestre-bulletins**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Route:** `/formsemestre/<int:formsemestre_id>/bulletins * **Route:** `/formsemestre/<int:formsemestre_id>/bulletins
* **Exemple d'utilisation:** `/api/formsemestre/1/bulletins` * **Exemple d'utilisation:** `/api/formsemestre/1/bulletins`
@ -972,7 +1034,9 @@ Par défaut les valeurs numériques sont formattées en chaînes. Si format=raw,
mais pas JSON compliant à cause des _NaN_. mais pas JSON compliant à cause des _NaN_.
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine` * **Paramètres:** `formsemestre_id`, `etudid`, `nip`, `ine`
* **Query string:** `format`
* **Routes:** * **Routes:**
`/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin[/short][/pdf]` `/etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin[/short][/pdf]`
ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin[/short][/pdf]` ou `/etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin[/short][/pdf]`
@ -986,6 +1050,7 @@ mais pas JSON compliant à cause des _NaN_.
#### **formsemestre-programme** #### **formsemestre-programme**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `dept`, `formsemestre_id` * **Paramètres:** `dept`, `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/programme` * **Routes:** `/formsemestre/<int:formsemestre_id>/programme`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/programme` * **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/programme`
@ -994,6 +1059,7 @@ mais pas JSON compliant à cause des _NaN_.
#### **formsemestre-resultats** #### **formsemestre-resultats**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Query string**: `format` * **Query string**: `format`
* **Route:** `/formsemestres/resultats` * **Route:** `/formsemestres/resultats`
@ -1009,6 +1075,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`moduleimpl-evaluations`** #### **`moduleimpl-evaluations`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `moduleimpl_id` * **Paramètres:** `moduleimpl_id`
* **Routes:** `/moduleimpl/<int:moduleimpl_id>/evaluations` * **Routes:** `/moduleimpl/<int:moduleimpl_id>/evaluations`
* **Exemple d'utilisation:** `/ScoDoc/api/moduleimpl/1/evaluations` * **Exemple d'utilisation:** `/ScoDoc/api/moduleimpl/1/evaluations`
@ -1018,6 +1085,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`evaluations-notes`** #### **`evaluations-notes`**
* **Méthode**: GET * **Méthode**: GET
* **Permission: `ScoView`**
* **Paramètres**: `evaluation_id` * **Paramètres**: `evaluation_id`
* **Routes:** `/evaluation/<int:evaluation_id>/notes` * **Routes:** `/evaluation/<int:evaluation_id>/notes`
* **Exemple d'utilisation:** `/evaluation/1491/notes` * **Exemple d'utilisation:** `/evaluation/1491/notes`
@ -1028,6 +1096,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **formsemestre-etat_evals** #### **formsemestre-etat_evals**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formsemestre_id` * **Paramètres:** `formsemestre_id`
* **Routes:** `/formsemestre/<int:formsemestre_id>/etat_evals` * **Routes:** `/formsemestre/<int:formsemestre_id>/etat_evals`
* **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/etat_evals` * **Exemple d'utilisation:** `/ScoDoc/api/formsemestre/1/etat_evals`
@ -1038,6 +1107,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`formation-export`** #### **`formation-export`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **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:** * **Routes:**
* `/formation/<int:formation_id>/export` * `/formation/<int:formation_id>/export`
@ -1048,6 +1118,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`formation-referentiel_competences`** #### **`formation-referentiel_competences`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoView`**
* **Paramètres:** `formation_id` * **Paramètres:** `formation_id`
* **Routes:** `/formation/<int:formation_id>/referentiel_competences` * **Routes:** `/formation/<int:formation_id>/referentiel_competences`
* **Exemple d'utilisation:** `api/formation/1/referentiel_competences` * **Exemple d'utilisation:** `api/formation/1/referentiel_competences`
@ -1057,6 +1128,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
### **API Logos** ### **API Logos**
#### **`logos`** #### **`logos`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoSuperAdmin`**
* **Paramètres :** Aucun * **Paramètres :** Aucun
* **Route :** `/logos` * **Route :** `/logos`
* **Exemple d'utilisation :** `/ScoDoc/api/logos` * **Exemple d'utilisation :** `/ScoDoc/api/logos`
@ -1065,6 +1137,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`logo`** #### **`logo`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoSuperAdmin`**
* **Paramètres :** Aucun * **Paramètres :** Aucun
* **Route:** `/logo/<string:nom>` * **Route:** `/logo/<string:nom>`
* **Exemple d'utilisation :** `/ScoDoc/api/logo/header` * **Exemple d'utilisation :** `/ScoDoc/api/logo/header`
@ -1073,6 +1146,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`departement-logos`** #### **`departement-logos`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoSuperAdmin`**
* **Paramètres:** Aucun * **Paramètres:** Aucun
* **Route :** * **Route :**
* `/departement/<string:dept>/logos` * `/departement/<string:dept>/logos`
@ -1085,6 +1159,7 @@ valeurs numériques mais pas JSON compliant à cause des _NaN_.
#### **`departement-logo`** #### **`departement-logo`**
* **Méthode:** GET * **Méthode:** GET
* **Permission: `ScoSuperAdmin`**
* **Paramètres :** Aucun * **Paramètres :** Aucun
* **Route :** * **Route :**
* `/departement/<string:dept>/logo/<string:nom>` * `/departement/<string:dept>/logo/<string:nom>`

BIN
docs/img/API_Chart.odg
View File

Binary file not shown.

1650
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: 335 KiB

After

Width:  |  Height:  |  Size: 335 KiB

6
docs/samples/sample_departement-create.json.md
View File

@ -7,11 +7,11 @@
```json ```json
{ {
"id": 6,
"acronym": "NEWONE", "acronym": "NEWONE",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true, "id": 6,
"date_creation": "2022-08-19T11:28:41.805891+02:00" "visible": true
} }
``` ```

6
docs/samples/sample_departement-edit.json.md
View File

@ -7,11 +7,11 @@
```json ```json
{ {
"id": 6,
"acronym": "NEWONE", "acronym": "NEWONE",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": false, "id": 6,
"date_creation": "2022-08-19T11:28:41.805891+02:00" "visible": false
} }
``` ```

72
docs/samples/sample_departement-etudiants.json.md
View File

@ -1,56 +1,56 @@
### departement-etudiants ### departement-etudiants
#### GET /departement/id/1/etudiants
```json
[
{
"id": 1,
"code_nip": "1",
"code_ine": "INE1",
"dept_id": 1,
"nom": "COSTA",
"nom_usuel": null,
"prenom": "SACHA",
"civilite": "X"
},
{
"id": 2,
"code_nip": "NIP2",
"code_ine": "2",
"dept_id": 1,
"nom": "NAUDIN",
"nom_usuel": null,
"prenom": "SIMONE",
"civilite": "F"
},
"... etc."
]
```
#### GET /departement/TAPI/etudiants #### GET /departement/TAPI/etudiants
```json ```json
[ [
{ {
"id": 1, "civilite": "X",
"code_nip": "1",
"code_ine": "INE1", "code_ine": "INE1",
"code_nip": "1",
"dept_id": 1, "dept_id": 1,
"id": 1,
"nom": "COSTA", "nom": "COSTA",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SACHA", "prenom": "SACHA"
"civilite": "X"
}, },
{ {
"id": 2, "civilite": "F",
"code_nip": "NIP2",
"code_ine": "2", "code_ine": "2",
"code_nip": "NIP2",
"dept_id": 1, "dept_id": 1,
"id": 2,
"nom": "NAUDIN", "nom": "NAUDIN",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SIMONE", "prenom": "SIMONE"
"civilite": "F"
}, },
"... etc." "..."
]
```
#### GET /departement/id/1/etudiants
```json
[
{
"civilite": "X",
"code_ine": "INE1",
"code_nip": "1",
"dept_id": 1,
"id": 1,
"nom": "COSTA",
"nom_usuel": null,
"prenom": "SACHA"
},
{
"civilite": "F",
"code_ine": "2",
"code_nip": "NIP2",
"dept_id": 1,
"id": 2,
"nom": "NAUDIN",
"nom_usuel": null,
"prenom": "SIMONE"
},
"..."
] ]
``` ```

172
docs/samples/sample_departement-formsemestres-courants.json.md
View File

@ -4,63 +4,63 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false, "block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white", "bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false, "bul_hide_xml": false,
"elt_sem_apo": null, "date_debut": "01/09/2021",
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"formsemestre_id": 1,
"titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [],
"titre_formation": "BUT R&T",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
"responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"titre": "Semestre test",
"titre_formation": "BUT R&T",
"titre_num": "Semestre test semestre 1"
}, },
"formation_id": 1 "..."
},
"etape_apo": "A1, A2, A3"
},
"... etc."
] ]
``` ```
@ -68,63 +68,63 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false, "block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white", "bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false, "bul_hide_xml": false,
"elt_sem_apo": null, "date_debut": "01/09/2021",
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"formsemestre_id": 1,
"titre_num": "Semestre test semestre 1",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"responsables": [],
"titre_formation": "BUT R&T",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
"responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"titre": "Semestre test",
"titre_formation": "BUT R&T",
"titre_num": "Semestre test semestre 1"
}, },
"formation_id": 1 "..."
},
"etape_apo": "A1, A2, A3"
},
"... etc."
] ]
``` ```

18
docs/samples/sample_departement-formsemestres_ids.json.md
View File

@ -1,18 +1,18 @@
### departement-formsemestres_ids ### departement-formsemestres_ids
#### GET /departement/id/1/formsemestres_ids
```json
[
1,
"... etc."
]
```
#### GET /departement/TAPI/formsemestres_ids #### GET /departement/TAPI/formsemestres_ids
```json ```json
[ [
1, 1,
"... etc." "..."
]
```
#### GET /departement/id/1/formsemestres_ids
```json
[
1,
"..."
] ]
``` ```

20
docs/samples/sample_departement-logo.json.md
View File

@ -1,18 +1,18 @@
### departement-logo ### departement-logo
#### GET /departement/id/1/logo/demo
```json
{
"Content-Type": "image/png",
"Content-Disposition": "inline; filename=logo_demo.png"
}
```
#### GET /departement/TAPI/logo/demo #### GET /departement/TAPI/logo/demo
```json ```json
{ {
"Content-Type": "image/png", "Content-Disposition": "inline; filename=logo_demo.png",
"Content-Disposition": "inline; filename=logo_demo.png" "Content-Type": "image/png"
}
```
#### GET /departement/id/1/logo/demo
```json
{
"Content-Disposition": "inline; filename=logo_demo.png",
"Content-Type": "image/png"
} }
``` ```

18
docs/samples/sample_departement-logos.json.md
View File

@ -1,18 +1,18 @@
### departement-logos ### departement-logos
#### GET /departement/id/1/logos
```json
[
"demo",
"... etc."
]
```
#### GET /departement/TAPI/logos #### GET /departement/TAPI/logos
```json ```json
[ [
"demo", "demo",
"... etc." "..."
]
```
#### GET /departement/id/1/logos
```json
[
"demo",
"..."
] ]
``` ```

28
docs/samples/sample_departement.json.md
View File

@ -1,24 +1,24 @@
### departement ### departement
#### GET /departement/id/1
```json
{
"id": 1,
"acronym": "TAPI",
"description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
}
```
#### GET /departement/TAPI #### GET /departement/TAPI
```json ```json
{ {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true, "id": 1,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "visible": true
}
```
#### GET /departement/id/1
```json
{
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
} }
``` ```

2
docs/samples/sample_departements-ids.json.md
View File

@ -5,7 +5,7 @@
[ [
1, 1,
2, 2,
"... etc." "..."
] ]
``` ```

14
docs/samples/sample_departements.json.md
View File

@ -4,20 +4,20 @@
```json ```json
[ [
{ {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true, "id": 1,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "visible": true
}, },
{ {
"id": 2,
"acronym": "AA", "acronym": "AA",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true, "id": 2,
"date_creation": "2022-08-19T11:28:05.505385+02:00" "visible": true
}, },
"... etc." "..."
] ]
``` ```

4134
docs/samples/sample_etudiant-formsemestre-bulletin.json.md
View File

File diff suppressed because it is too large Load Diff

18
docs/samples/sample_etudiant-formsemestre-groups.json.md
View File

@ -4,18 +4,18 @@
```json ```json
[ [
{ {
"partition_id": 1,
"id": 1,
"formsemestre_id": 1,
"partition_name": null,
"numero": null,
"bul_show_rank": false, "bul_show_rank": false,
"show_in_lists": true, "formsemestre_id": 1,
"groups_editable": true,
"group_id": 1, "group_id": 1,
"group_name": null "group_name": null,
"groups_editable": true,
"id": 1,
"numero": null,
"partition_id": 1,
"partition_name": null,
"show_in_lists": true
}, },
"... etc." "..."
] ]
``` ```

180
docs/samples/sample_etudiant-formsemestres.json.md
View File

@ -4,65 +4,65 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false,
"elt_sem_apo": null,
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"annee_scolaire": 2021, "annee_scolaire": 2021,
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut": "01/09/2021",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"etape_apo": "A1, A2, A3",
"formsemestre_id": 1,
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
},
"formation_id": 1
},
"responsables": [], "responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"session_id": "TAPI-BUT-FI-S1-2021",
"titre": "Semestre test",
"titre_court": "BUT R&T", "titre_court": "BUT R&T",
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1"
"session_id": "TAPI-BUT-FI-S1-2021"
}, },
"... etc." "..."
] ]
``` ```
@ -70,65 +70,65 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false,
"elt_sem_apo": null,
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"annee_scolaire": 2021, "annee_scolaire": 2021,
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut": "01/09/2021",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"etape_apo": "A1, A2, A3",
"formsemestre_id": 1,
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
},
"formation_id": 1
},
"responsables": [], "responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"session_id": "TAPI-BUT-FI-S1-2021",
"titre": "Semestre test",
"titre_court": "BUT R&T", "titre_court": "BUT R&T",
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1"
"session_id": "TAPI-BUT-FI-S1-2021"
}, },
"... etc." "..."
] ]
``` ```

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

@ -3,201 +3,201 @@
#### GET /etudiant/etudid/11 #### GET /etudiant/etudid/11
```json ```json
{ {
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "11",
"admission": { "admission": {
"id": 11,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 11,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null, "anglais": null,
"nomlycee": null, "annee": null,
"apb_groupe": null, "annee_bac": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null, "apb_classement_gr": null,
"apb_groupe": null,
"bac": null, "bac": null,
"rang": null, "boursier_prec": null,
"codepostallycee": null, "classement": null,
"specialite": null,
"qualite": null,
"codelycee": null, "codelycee": null,
"rapporteur": null "codepostallycee": null,
"commentaire": null,
"decision": null,
"etudid": 11,
"francais": null,
"id": 11,
"math": null,
"nomlycee": null,
"physique": null,
"qualite": null,
"rang": null,
"rapporteur": null,
"score": null,
"specialite": null,
"type_admission": null,
"villelycee": null
}, },
"adresses": [ "adresses": [
{ {
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null, "codepostaldomicile": null,
"description": null,
"domicile": null,
"email": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null, "paysdomicile": null,
"telephone": null,
"telephonemobile": null, "telephonemobile": null,
"typeadresse": "domicile", "typeadresse": "domicile",
"emailperso": null, "villedomicile": null
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
} }
], ],
"dept_acronym": "TAPI" "boursier": null,
"civilite": "F",
"code_ine": "INE11",
"code_nip": "11",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11,
"lieu_naissance": null,
"nationalite": null,
"nom": "FLEURY",
"nom_usuel": null,
"photo_filename": null,
"prenom": "MADELEINE",
"scodoc7_id": null,
"statut": null
} }
``` ```
#### GET /etudiant/ine/INE11 #### GET /etudiant/ine/INE11
```json ```json
{ {
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "11",
"admission": { "admission": {
"id": 11,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 11,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null, "anglais": null,
"nomlycee": null, "annee": null,
"apb_groupe": null, "annee_bac": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null, "apb_classement_gr": null,
"apb_groupe": null,
"bac": null, "bac": null,
"rang": null, "boursier_prec": null,
"codepostallycee": null, "classement": null,
"specialite": null,
"qualite": null,
"codelycee": null, "codelycee": null,
"rapporteur": null "codepostallycee": null,
"commentaire": null,
"decision": null,
"etudid": 11,
"francais": null,
"id": 11,
"math": null,
"nomlycee": null,
"physique": null,
"qualite": null,
"rang": null,
"rapporteur": null,
"score": null,
"specialite": null,
"type_admission": null,
"villelycee": null
}, },
"adresses": [ "adresses": [
{ {
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null, "codepostaldomicile": null,
"description": null,
"domicile": null,
"email": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null, "paysdomicile": null,
"telephone": null,
"telephonemobile": null, "telephonemobile": null,
"typeadresse": "domicile", "typeadresse": "domicile",
"emailperso": null, "villedomicile": null
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
} }
], ],
"dept_acronym": "TAPI" "boursier": null,
"civilite": "F",
"code_ine": "INE11",
"code_nip": "11",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11,
"lieu_naissance": null,
"nationalite": null,
"nom": "FLEURY",
"nom_usuel": null,
"photo_filename": null,
"prenom": "MADELEINE",
"scodoc7_id": null,
"statut": null
} }
``` ```
#### GET /etudiant/nip/11 #### GET /etudiant/nip/11
```json ```json
{ {
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "11",
"admission": { "admission": {
"id": 11,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 11,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null, "anglais": null,
"nomlycee": null, "annee": null,
"apb_groupe": null, "annee_bac": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null, "apb_classement_gr": null,
"apb_groupe": null,
"bac": null, "bac": null,
"rang": null, "boursier_prec": null,
"codepostallycee": null, "classement": null,
"specialite": null,
"qualite": null,
"codelycee": null, "codelycee": null,
"rapporteur": null "codepostallycee": null,
"commentaire": null,
"decision": null,
"etudid": 11,
"francais": null,
"id": 11,
"math": null,
"nomlycee": null,
"physique": null,
"qualite": null,
"rang": null,
"rapporteur": null,
"score": null,
"specialite": null,
"type_admission": null,
"villelycee": null
}, },
"adresses": [ "adresses": [
{ {
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null, "codepostaldomicile": null,
"description": null,
"domicile": null,
"email": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null, "paysdomicile": null,
"telephone": null,
"telephonemobile": null, "telephonemobile": null,
"typeadresse": "domicile", "typeadresse": "domicile",
"emailperso": null, "villedomicile": null
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
} }
], ],
"dept_acronym": "TAPI" "boursier": null,
"civilite": "F",
"code_ine": "INE11",
"code_nip": "11",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11,
"lieu_naissance": null,
"nationalite": null,
"nom": "FLEURY",
"nom_usuel": null,
"photo_filename": null,
"prenom": "MADELEINE",
"scodoc7_id": null,
"statut": null
} }
``` ```

90
docs/samples/sample_etudiant_formsemestres.json.md
View File

@ -4,65 +4,65 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false,
"elt_sem_apo": null,
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"annee_scolaire": 2021, "annee_scolaire": 2021,
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut": "01/09/2021",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"etape_apo": "A1, A2, A3",
"formsemestre_id": 1,
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
},
"formation_id": 1
},
"responsables": [], "responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"session_id": "TAPI-BUT-FI-S1-2021",
"titre": "Semestre test",
"titre_court": "BUT R&T", "titre_court": "BUT R&T",
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1"
"session_id": "TAPI-BUT-FI-S1-2021"
}, },
"... etc." "..."
] ]
``` ```

324
docs/samples/sample_etudiants-clef.json.md
View File

@ -4,139 +4,69 @@
```json ```json
[ [
{ {
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "11",
"admission": { "admission": {
"id": 11,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 11,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null, "anglais": null,
"nomlycee": null, "annee": null,
"apb_groupe": null, "annee_bac": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null, "apb_classement_gr": null,
"apb_groupe": null,
"bac": null, "bac": null,
"rang": null, "boursier_prec": null,
"codepostallycee": null, "classement": null,
"specialite": null,
"qualite": null,
"codelycee": null, "codelycee": null,
"rapporteur": null "codepostallycee": null,
"commentaire": null,
"decision": null,
"etudid": 11,
"francais": null,
"id": 11,
"math": null,
"nomlycee": null,
"physique": null,
"qualite": null,
"rang": null,
"rapporteur": null,
"score": null,
"specialite": null,
"type_admission": null,
"villelycee": null
}, },
"adresses": [ "adresses": [
{ {
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null, "codepostaldomicile": null,
"description": null,
"domicile": null,
"email": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null, "paysdomicile": null,
"telephone": null,
"telephonemobile": null, "telephonemobile": null,
"typeadresse": "domicile", "typeadresse": "domicile",
"emailperso": null, "villedomicile": null
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
} }
], ],
"dept_acronym": "TAPI"
},
"... etc."
]
```
#### GET /etudiants/nip/11
```json
[
{
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null, "boursier": null,
"civilite": "F", "civilite": "F",
"photo_filename": null, "code_ine": "INE11",
"code_nip": "11", "code_nip": "11",
"admission": { "date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11, "id": 11,
"annee_bac": null, "lieu_naissance": null,
"decision": null, "nationalite": null,
"type_admission": null, "nom": "FLEURY",
"math": null, "nom_usuel": null,
"score": null, "photo_filename": null,
"boursier_prec": null, "prenom": "MADELEINE",
"etudid": 11, "scodoc7_id": null,
"physique": null, "statut": null
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null,
"nomlycee": null,
"apb_groupe": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null,
"bac": null,
"rang": null,
"codepostallycee": null,
"specialite": null,
"qualite": null,
"codelycee": null,
"rapporteur": null
}, },
"adresses": [ "..."
{
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null,
"paysdomicile": null,
"telephonemobile": null,
"typeadresse": "domicile",
"emailperso": null,
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
}
],
"dept_acronym": "TAPI"
},
"... etc."
] ]
``` ```
@ -144,69 +74,139 @@
```json ```json
[ [
{ {
"date_naissance": null,
"code_ine": "INE11",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 11,
"dept_naissance": null,
"nom": "FLEURY",
"nationalite": null,
"prenom": "MADELEINE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "11",
"admission": { "admission": {
"id": 11,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 11,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null, "anglais": null,
"nomlycee": null, "annee": null,
"apb_groupe": null, "annee_bac": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null, "apb_classement_gr": null,
"apb_groupe": null,
"bac": null, "bac": null,
"rang": null, "boursier_prec": null,
"codepostallycee": null, "classement": null,
"specialite": null,
"qualite": null,
"codelycee": null, "codelycee": null,
"rapporteur": null "codepostallycee": null,
"commentaire": null,
"decision": null,
"etudid": 11,
"francais": null,
"id": 11,
"math": null,
"nomlycee": null,
"physique": null,
"qualite": null,
"rang": null,
"rapporteur": null,
"score": null,
"specialite": null,
"type_admission": null,
"villelycee": null
}, },
"adresses": [ "adresses": [
{ {
"etudid": 11,
"email": "MADELEINE.FLEURY@example.com",
"domicile": null,
"codepostaldomicile": null, "codepostaldomicile": null,
"description": null,
"domicile": null,
"email": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null, "paysdomicile": null,
"telephone": null,
"telephonemobile": null, "telephonemobile": null,
"typeadresse": "domicile", "typeadresse": "domicile",
"emailperso": null, "villedomicile": null
"id": 11,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
} }
], ],
"dept_acronym": "TAPI" "boursier": null,
"civilite": "F",
"code_ine": "INE11",
"code_nip": "11",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11,
"lieu_naissance": null,
"nationalite": null,
"nom": "FLEURY",
"nom_usuel": null,
"photo_filename": null,
"prenom": "MADELEINE",
"scodoc7_id": null,
"statut": null
}, },
"... etc." "..."
]
```
#### GET /etudiants/nip/11
```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": 11,
"francais": null,
"id": 11,
"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": "MADELEINE.FLEURY@example.com",
"emailperso": null,
"etudid": 11,
"fax": null,
"id": 11,
"paysdomicile": null,
"telephone": null,
"telephonemobile": null,
"typeadresse": "domicile",
"villedomicile": null
}
],
"boursier": null,
"civilite": "F",
"code_ine": "INE11",
"code_nip": "11",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 11,
"lieu_naissance": null,
"nationalite": null,
"nom": "FLEURY",
"nom_usuel": null,
"photo_filename": null,
"prenom": "MADELEINE",
"scodoc7_id": null,
"statut": null
},
"..."
] ]
``` ```

284
docs/samples/sample_etudiants-courants.json.md
View File

@ -1,162 +1,162 @@
### etudiants-courants ### etudiants-courants
#### GET /etudiants/courants/long
```json
[
{
"date_naissance": null,
"code_ine": "INE1",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 1,
"dept_naissance": null,
"nom": "COSTA",
"nationalite": null,
"prenom": "SACHA",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "X",
"photo_filename": null,
"code_nip": "1",
"admission": {
"id": 1,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 1,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null,
"nomlycee": null,
"apb_groupe": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null,
"bac": null,
"rang": null,
"codepostallycee": null,
"specialite": null,
"qualite": null,
"codelycee": null,
"rapporteur": null
},
"adresses": [
{
"etudid": 1,
"email": "SACHA.COSTA@example.com",
"domicile": null,
"codepostaldomicile": null,
"paysdomicile": null,
"telephonemobile": null,
"typeadresse": "domicile",
"emailperso": null,
"id": 1,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
}
],
"dept_acronym": "TAPI"
},
{
"date_naissance": null,
"code_ine": "2",
"dept_id": 1,
"lieu_naissance": null,
"scodoc7_id": null,
"id": 2,
"dept_naissance": null,
"nom": "NAUDIN",
"nationalite": null,
"prenom": "SIMONE",
"statut": null,
"nom_usuel": null,
"boursier": null,
"civilite": "F",
"photo_filename": null,
"code_nip": "NIP2",
"admission": {
"id": 2,
"annee_bac": null,
"decision": null,
"type_admission": null,
"math": null,
"score": null,
"boursier_prec": null,
"etudid": 2,
"physique": null,
"commentaire": null,
"classement": null,
"annee": null,
"anglais": null,
"nomlycee": null,
"apb_groupe": null,
"francais": null,
"villelycee": null,
"apb_classement_gr": null,
"bac": null,
"rang": null,
"codepostallycee": null,
"specialite": null,
"qualite": null,
"codelycee": null,
"rapporteur": null
},
"adresses": [
{
"etudid": 2,
"email": "SIMONE.NAUDIN@example.com",
"domicile": null,
"codepostaldomicile": null,
"paysdomicile": null,
"telephonemobile": null,
"typeadresse": "domicile",
"emailperso": null,
"id": 2,
"villedomicile": null,
"telephone": null,
"fax": null,
"description": null
}
],
"dept_acronym": "TAPI"
},
"... etc."
]
```
#### GET /etudiants/courants #### GET /etudiants/courants
```json ```json
[ [
{ {
"id": 1, "civilite": "X",
"code_nip": "1",
"code_ine": "INE1", "code_ine": "INE1",
"code_nip": "1",
"dept_id": 1, "dept_id": 1,
"id": 1,
"nom": "COSTA", "nom": "COSTA",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SACHA", "prenom": "SACHA"
"civilite": "X"
}, },
{ {
"id": 2, "civilite": "F",
"code_nip": "NIP2",
"code_ine": "2", "code_ine": "2",
"code_nip": "NIP2",
"dept_id": 1, "dept_id": 1,
"id": 2,
"nom": "NAUDIN", "nom": "NAUDIN",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SIMONE", "prenom": "SIMONE"
"civilite": "F"
}, },
"... etc." "..."
]
```
#### GET /etudiants/courants/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": 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,
"id": 1,
"lieu_naissance": null,
"nationalite": null,
"nom": "COSTA",
"nom_usuel": null,
"photo_filename": null,
"prenom": "SACHA",
"scodoc7_id": null,
"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": 2,
"francais": null,
"id": 2,
"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": "SIMONE.NAUDIN@example.com",
"emailperso": null,
"etudid": 2,
"fax": null,
"id": 2,
"paysdomicile": null,
"telephone": null,
"telephonemobile": null,
"typeadresse": "domicile",
"villedomicile": null
}
],
"boursier": null,
"civilite": "F",
"code_ine": "2",
"code_nip": "NIP2",
"date_naissance": null,
"dept_acronym": "TAPI",
"dept_id": 1,
"dept_naissance": null,
"id": 2,
"lieu_naissance": null,
"nationalite": null,
"nom": "NAUDIN",
"nom_usuel": null,
"photo_filename": null,
"prenom": "SIMONE",
"scodoc7_id": null,
"statut": null
},
"..."
] ]
``` ```

2110
docs/samples/sample_formation-export.json.md
View File

File diff suppressed because it is too large Load Diff

1554
docs/samples/sample_formation-referentiel_competences.json.md
View File

File diff suppressed because it is too large Load Diff

28
docs/samples/sample_formation.json.md
View File

@ -3,24 +3,24 @@
#### GET /formation/1 #### GET /formation/1
```json ```json
{ {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": {
"id": 1,
"acronym": "TAPI",
"description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"formation_id": 1
} }
``` ```

30
docs/samples/sample_formations.json.md
View File

@ -4,26 +4,26 @@
```json ```json
[ [
{ {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": {
"id": 1,
"acronym": "TAPI",
"description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
}, },
"formation_id": 1 "..."
},
"... etc."
] ]
``` ```

2
docs/samples/sample_formations_ids.json.md
View File

@ -4,7 +4,7 @@
```json ```json
[ [
1, 1,
"... etc." "..."
] ]
``` ```

3122
docs/samples/sample_formsemestre-bulletins.json.md
View File

File diff suppressed because it is too large Load Diff

22
docs/samples/sample_formsemestre-decisions_jury.json.md
View File

@ -4,30 +4,30 @@
```json ```json
[ [
{ {
"etudid": 1, "autorisations": [],
"code_nip": "1",
"code_ine": "INE1", "code_ine": "INE1",
"is_apc": true, "code_nip": "1",
"etat": "I", "etat": "I",
"etudid": 1,
"is_apc": true,
"nb_competences": 3, "nb_competences": 3,
"rcues": [], "rcues": [],
"ues": [],
"semestre": {}, "semestre": {},
"autorisations": [] "ues": []
}, },
{ {
"etudid": 2, "autorisations": [],
"code_nip": "NIP2",
"code_ine": "2", "code_ine": "2",
"is_apc": true, "code_nip": "NIP2",
"etat": "I", "etat": "I",
"etudid": 2,
"is_apc": true,
"nb_competences": 3, "nb_competences": 3,
"rcues": [], "rcues": [],
"ues": [],
"semestre": {}, "semestre": {},
"autorisations": [] "ues": []
}, },
"... etc." "..."
] ]
``` ```

388
docs/samples/sample_formsemestre-etat_evals.json.md
View File

@ -4,242 +4,242 @@
```json ```json
[ [
{ {
"module_id": 1,
"formsemestre_id": 1,
"computation_expr": null, "computation_expr": null,
"id": 1,
"responsable_id": 2,
"moduleimpl_id": 1,
"ens": [], "ens": [],
"module": {
"code": "R101",
"matiere_id": 1,
"heures_cours": 0.0,
"semestre_id": 1,
"heures_td": 0.0,
"numero": 10,
"heures_tp": 0.0,
"code_apogee": "",
"titre": "Initiation aux r\u00e9seaux informatiques",
"coefficient": 1.0,
"module_type": 2,
"id": 1,
"ects": null,
"abbrev": "Init aux r\u00e9seaux informatiques",
"ue_id": 1,
"formation_id": 1,
"parcours": [],
"app_critiques": [],
"ue_coefs": [
{
"coef": 12.0,
"module_id": 1,
"ue_id": 1,
"ue": {
"numero": 1,
"code_apogee": "",
"titre": "Administrer les r\u00e9seaux et l\u2019Internet",
"coefficient": 0.0,
"semestre_idx": 1,
"coef_rcue": 1.0,
"type": 0,
"color": "#B80004",
"ue_code": "UCOD11",
"niveau_competence_id": null,
"formation_id": 1,
"ects": 12.0,
"id": 1,
"is_external": false,
"acronyme": "RT1.1",
"ue_id": 1
}
},
{
"coef": 4.0,
"module_id": 1,
"ue_id": 2,
"ue": {
"numero": 2,
"code_apogee": "",
"titre": "Connecter les entreprises et les usagers",
"coefficient": 0.0,
"semestre_idx": 1,
"coef_rcue": 1.0,
"type": 0,
"color": "#F97B3D",
"ue_code": "UCOD12",
"niveau_competence_id": null,
"formation_id": 1,
"ects": 8.0,
"id": 2,
"is_external": false,
"acronyme": "RT2.1",
"ue_id": 2
}
},
{
"coef": 4.0,
"module_id": 1,
"ue_id": 3,
"ue": {
"numero": 3,
"code_apogee": "",
"titre": "Cre\u0301er des outils et applications informatiques pour les R&amp;T",
"coefficient": 0.0,
"semestre_idx": 1,
"coef_rcue": 1.0,
"type": 0,
"color": "#FEB40B",
"ue_code": "UCOD13",
"niveau_competence_id": null,
"formation_id": 1,
"ects": 10.0,
"id": 3,
"is_external": false,
"acronyme": "RT3.1",
"ue_id": 3
}
}
],
"module_id": 1
},
"evaluations": [ "evaluations": [
{ {
"id": 1, "apresmidi": 0,
"moduleimpl_id": 1,
"heure_debut": "08h00",
"description": null,
"note_max": 20.0,
"visibulletin": true,
"evaluation_type": 0,
"jour": "",
"heure_fin": "09h00",
"coefficient": 1.0, "coefficient": 1.0,
"publish_incomplete": true,
"numero": 0,
"evaluation_id": 1,
"date_debut": null, "date_debut": null,
"date_fin": null, "date_fin": null,
"poids": {},
"jouriso": null,
"duree": "1h",
"descrheure": " de 08h00 \u00e0 09h00", "descrheure": " de 08h00 \u00e0 09h00",
"matin": 0, "description": null,
"apresmidi": 0, "duree": "1h",
"etat": { "etat": {
"evaluation_id": 1, "evaluation_id": 1,
"nb_attente": 0, "is_complete": true,
"is_complete": true "nb_attente": 0
}, },
"evaluation_id": 1,
"evaluation_type": 0,
"heure_debut": "08h00",
"heure_fin": "09h00",
"id": 1,
"jour": "",
"jouriso": null,
"matin": 0,
"moduleimpl_id": 1,
"nb_inscrits": 10, "nb_inscrits": 10,
"nb_notes_manquantes": 10,
"nb_notes_abs": 0, "nb_notes_abs": 0,
"nb_notes_att": 0, "nb_notes_att": 0,
"nb_notes_exc": 0, "nb_notes_exc": 0,
"nb_notes_manquantes": 10,
"note_max": 20.0,
"numero": 0,
"poids": {},
"publish_incomplete": true,
"saisie_notes": { "saisie_notes": {
"datetime_debut": null, "datetime_debut": null,
"datetime_fin": null, "datetime_fin": null,
"datetime_mediane": null "datetime_mediane": null
},
"visibulletin": true
} }
} ],
] "formsemestre_id": 1,
"id": 1,
"module": {
"abbrev": "Init aux r\u00e9seaux informatiques",
"app_critiques": [],
"code": "R101",
"code_apogee": "",
"coefficient": 1.0,
"ects": null,
"formation_id": 1,
"heures_cours": 0.0,
"heures_td": 0.0,
"heures_tp": 0.0,
"id": 1,
"matiere_id": 1,
"module_id": 1,
"module_type": 2,
"numero": 10,
"parcours": [],
"semestre_id": 1,
"titre": "Initiation aux r\u00e9seaux informatiques",
"ue_coefs": [
{
"coef": 12.0,
"module_id": 1,
"ue": {
"acronyme": "RT1.1",
"code_apogee": "",
"coef_rcue": 1.0,
"coefficient": 0.0,
"color": "#B80004",
"ects": 12.0,
"formation_id": 1,
"id": 1,
"is_external": false,
"niveau_competence_id": null,
"numero": 1,
"semestre_idx": 1,
"titre": "Administrer les r\u00e9seaux et l\u2019Internet",
"type": 0,
"ue_code": "UCOD11",
"ue_id": 1
},
"ue_id": 1
}, },
{ {
"module_id": 3, "coef": 4.0,
"formsemestre_id": 1, "module_id": 1,
"computation_expr": null, "ue": {
"id": 3, "acronyme": "RT2.1",
"responsable_id": 2,
"moduleimpl_id": 3,
"ens": [],
"module": {
"code": "R102",
"matiere_id": 1,
"heures_cours": 0.0,
"semestre_id": 1,
"heures_td": 0.0,
"numero": 20,
"heures_tp": 0.0,
"code_apogee": "", "code_apogee": "",
"titre": "Principe et architecture des r\u00e9seaux", "coef_rcue": 1.0,
"coefficient": 1.0, "coefficient": 0.0,
"module_type": 2, "color": "#F97B3D",
"id": 3, "ects": 8.0,
"ects": null,
"abbrev": null,
"ue_id": 1,
"formation_id": 1, "formation_id": 1,
"parcours": [], "id": 2,
"is_external": false,
"niveau_competence_id": null,
"numero": 2,
"semestre_idx": 1,
"titre": "Connecter les entreprises et les usagers",
"type": 0,
"ue_code": "UCOD12",
"ue_id": 2
},
"ue_id": 2
},
{
"coef": 4.0,
"module_id": 1,
"ue": {
"acronyme": "RT3.1",
"code_apogee": "",
"coef_rcue": 1.0,
"coefficient": 0.0,
"color": "#FEB40B",
"ects": 10.0,
"formation_id": 1,
"id": 3,
"is_external": false,
"niveau_competence_id": null,
"numero": 3,
"semestre_idx": 1,
"titre": "Cre\u0301er des outils et applications informatiques pour les R&amp;T",
"type": 0,
"ue_code": "UCOD13",
"ue_id": 3
},
"ue_id": 3
}
],
"ue_id": 1
},
"module_id": 1,
"moduleimpl_id": 1,
"responsable_id": 2
},
{
"computation_expr": null,
"ens": [],
"evaluations": [
{
"apresmidi": 0,
"coefficient": 1.0,
"date_debut": null,
"date_fin": null,
"descrheure": " de 08h00 \u00e0 09h00",
"description": null,
"duree": "1h",
"etat": {
"evaluation_id": 3,
"is_complete": true,
"nb_attente": 0
},
"evaluation_id": 3,
"evaluation_type": 0,
"heure_debut": "08h00",
"heure_fin": "09h00",
"id": 3,
"jour": "",
"jouriso": null,
"matin": 0,
"moduleimpl_id": 3,
"nb_inscrits": 10,
"nb_notes_abs": 0,
"nb_notes_att": 0,
"nb_notes_exc": 0,
"nb_notes_manquantes": 2,
"note_max": 20.0,
"numero": 0,
"poids": {},
"publish_incomplete": true,
"saisie_notes": {
"datetime_debut": "2022-08-20T12:00:00.000000+02:00",
"datetime_fin": "2022-08-20T12:00:00.000000+02:00",
"datetime_mediane": "2022-08-20T12:00:00.000000+02:00"
},
"visibulletin": true
}
],
"formsemestre_id": 1,
"id": 3,
"module": {
"abbrev": null,
"app_critiques": [], "app_critiques": [],
"code": "R102",
"code_apogee": "",
"coefficient": 1.0,
"ects": null,
"formation_id": 1,
"heures_cours": 0.0,
"heures_td": 0.0,
"heures_tp": 0.0,
"id": 3,
"matiere_id": 1,
"module_id": 3,
"module_type": 2,
"numero": 20,
"parcours": [],
"semestre_id": 1,
"titre": "Principe et architecture des r\u00e9seaux",
"ue_coefs": [ "ue_coefs": [
{ {
"coef": 12.0, "coef": 12.0,
"module_id": 3, "module_id": 3,
"ue_id": 1,
"ue": { "ue": {
"numero": 1, "acronyme": "RT1.1",
"code_apogee": "", "code_apogee": "",
"titre": "Administrer les r\u00e9seaux et l\u2019Internet",
"coefficient": 0.0,
"semestre_idx": 1,
"coef_rcue": 1.0, "coef_rcue": 1.0,
"type": 0, "coefficient": 0.0,
"color": "#B80004", "color": "#B80004",
"ue_code": "UCOD11",
"niveau_competence_id": null,
"formation_id": 1,
"ects": 12.0, "ects": 12.0,
"formation_id": 1,
"id": 1, "id": 1,
"is_external": false, "is_external": false,
"acronyme": "RT1.1", "niveau_competence_id": null,
"numero": 1,
"semestre_idx": 1,
"titre": "Administrer les r\u00e9seaux et l\u2019Internet",
"type": 0,
"ue_code": "UCOD11",
"ue_id": 1
},
"ue_id": 1 "ue_id": 1
} }
}
], ],
"module_id": 3 "ue_id": 1
}, },
"evaluations": [ "module_id": 3,
{
"id": 3,
"moduleimpl_id": 3, "moduleimpl_id": 3,
"heure_debut": "08h00", "responsable_id": 2
"description": null,
"note_max": 20.0,
"visibulletin": true,
"evaluation_type": 0,
"jour": "",
"heure_fin": "09h00",
"coefficient": 1.0,
"publish_incomplete": true,
"numero": 0,
"evaluation_id": 3,
"date_debut": null,
"date_fin": null,
"poids": {},
"jouriso": null,
"duree": "1h",
"descrheure": " de 08h00 \u00e0 09h00",
"matin": 0,
"apresmidi": 0,
"etat": {
"evaluation_id": 3,
"nb_attente": 0,
"is_complete": true
}, },
"nb_inscrits": 10, "..."
"nb_notes_manquantes": 2,
"nb_notes_abs": 0,
"nb_notes_att": 0,
"nb_notes_exc": 0,
"saisie_notes": {
"datetime_debut": "2021-09-13T00:00:00+02:00",
"datetime_fin": "2022-07-17T00:00:00+02:00",
"datetime_mediane": "2022-02-12T00:00:00+01:00"
}
}
]
},
"... etc."
] ]
``` ```

22
docs/samples/sample_formsemestre-etudiants-query.json.md
View File

@ -4,28 +4,28 @@
```json ```json
[ [
{ {
"id": 5, "civilite": "F",
"code_nip": "5",
"code_ine": "INE5", "code_ine": "INE5",
"code_nip": "5",
"dept_id": 1, "dept_id": 1,
"groups": [],
"id": 5,
"nom": "VILLENEUVE", "nom": "VILLENEUVE",
"nom_usuel": null, "nom_usuel": null,
"prenom": "FRAN\u00c7OISE", "prenom": "FRAN\u00c7OISE"
"civilite": "F",
"groups": []
}, },
{ {
"id": 10, "civilite": "F",
"code_nip": "NIP10",
"code_ine": "10", "code_ine": "10",
"code_nip": "NIP10",
"dept_id": 1, "dept_id": 1,
"groups": [],
"id": 10,
"nom": "BOUTET", "nom": "BOUTET",
"nom_usuel": null, "nom_usuel": null,
"prenom": "MARGUERITE", "prenom": "MARGUERITE"
"civilite": "F",
"groups": []
}, },
"... etc." "..."
] ]
``` ```

22
docs/samples/sample_formsemestre-etudiants.json.md
View File

@ -4,28 +4,28 @@
```json ```json
[ [
{ {
"id": 1, "civilite": "X",
"code_nip": "1",
"code_ine": "INE1", "code_ine": "INE1",
"code_nip": "1",
"dept_id": 1, "dept_id": 1,
"groups": [],
"id": 1,
"nom": "COSTA", "nom": "COSTA",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SACHA", "prenom": "SACHA"
"civilite": "X",
"groups": []
}, },
{ {
"id": 2, "civilite": "F",
"code_nip": "NIP2",
"code_ine": "2", "code_ine": "2",
"code_nip": "NIP2",
"dept_id": 1, "dept_id": 1,
"groups": [],
"id": 2,
"nom": "NAUDIN", "nom": "NAUDIN",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SIMONE", "prenom": "SIMONE"
"civilite": "F",
"groups": []
}, },
"... etc." "..."
] ]
``` ```

8
docs/samples/sample_formsemestre-partition-create.json.md
View File

@ -7,14 +7,14 @@
```json ```json
{ {
"partition_name": "PART",
"bul_show_rank": false, "bul_show_rank": false,
"formsemestre_id": 1,
"groups": {},
"groups_editable": true, "groups_editable": true,
"id": 2, "id": 2,
"formsemestre_id": 1,
"show_in_lists": false,
"numero": 0, "numero": 0,
"groups": {} "partition_name": "PART",
"show_in_lists": false
} }
``` ```

8
docs/samples/sample_formsemestre-partitions-order.json.md
View File

@ -8,15 +8,15 @@
```json ```json
[ [
{ {
"id": 2,
"partition_name": "PART",
"bul_show_rank": false, "bul_show_rank": false,
"groups_editable": true,
"formsemestre_id": 1, "formsemestre_id": 1,
"groups_editable": true,
"id": 2,
"numero": 0, "numero": 0,
"partition_name": "PART",
"show_in_lists": false "show_in_lists": false
}, },
"... etc." "..."
] ]
``` ```

3300
docs/samples/sample_formsemestre-programme.json.md
View File

File diff suppressed because it is too large Load Diff

150
docs/samples/sample_formsemestre-resultats.json.md
View File

@ -4,116 +4,116 @@
```json ```json
[ [
{ {
"etudid": 11, "bac": "",
"code_nip": "11",
"rang": "1",
"civilite_str": "Mme", "civilite_str": "Mme",
"nom_disp": "FLEURY", "classement": "",
"prenom": "MADELEINE", "code_nip": "11",
"nom_short": "FLEURY Ma.", "etudid": 11,
"moy_gen": "14.36", "moy_gen": "14.36",
"moy_ue_1": "14.94",
"moy_res_1_1": "~",
"moy_res_3_1": "11.97",
"moy_res_4_1": "~",
"moy_res_5_1": "~",
"moy_res_6_1": "~",
"moy_res_18_1": "15.71",
"moy_res_10_1": "~", "moy_res_10_1": "~",
"moy_res_11_1": "~",
"moy_res_20_1": "10.66",
"moy_res_12_1": "12.50",
"moy_res_13_1": "~",
"moy_sae_2_1": "18.72",
"moy_sae_7_1": "14.69",
"moy_ue_2": "11.17",
"moy_res_1_2": "~",
"moy_res_4_2": "~",
"moy_res_5_2": "~",
"moy_res_9_2": "09.33",
"moy_res_10_2": "~", "moy_res_10_2": "~",
"moy_res_10_3": "~",
"moy_res_11_1": "~",
"moy_res_11_2": "~", "moy_res_11_2": "~",
"moy_res_20_2": "10.66", "moy_res_11_3": "~",
"moy_res_12_1": "12.50",
"moy_res_12_2": "12.50", "moy_res_12_2": "12.50",
"moy_res_13_1": "~",
"moy_res_13_2": "~", "moy_res_13_2": "~",
"moy_res_21_2": "~",
"moy_sae_8_2": "~",
"moy_ue_3": "16.22",
"moy_res_1_3": "~",
"moy_res_17_3": "~", "moy_res_17_3": "~",
"moy_res_18_1": "15.71",
"moy_res_18_3": "15.71", "moy_res_18_3": "15.71",
"moy_res_19_3": "~", "moy_res_19_3": "~",
"moy_res_10_3": "~", "moy_res_1_1": "~",
"moy_res_11_3": "~", "moy_res_1_2": "~",
"moy_res_1_3": "~",
"moy_res_20_1": "10.66",
"moy_res_20_2": "10.66",
"moy_res_20_3": "10.66", "moy_res_20_3": "10.66",
"moy_res_21_2": "~",
"moy_res_21_3": "~", "moy_res_21_3": "~",
"moy_res_3_1": "11.97",
"moy_res_4_1": "~",
"moy_res_4_2": "~",
"moy_res_5_1": "~",
"moy_res_5_2": "~",
"moy_res_6_1": "~",
"moy_res_9_2": "09.33",
"moy_sae_14_3": "17.83", "moy_sae_14_3": "17.83",
"moy_sae_15_3": "~", "moy_sae_15_3": "~",
"ues_validables": "3/3", "moy_sae_2_1": "18.72",
"bac": "", "moy_sae_7_1": "14.69",
"specialite": "", "moy_sae_8_2": "~",
"type_admission": "", "moy_ue_1": "14.94",
"classement": "", "moy_ue_2": "11.17",
"moy_ue_3": "16.22",
"nom_disp": "FLEURY",
"nom_short": "FLEURY Ma.",
"partitions": { "partitions": {
"1": 1 "1": 1
} },
"prenom": "MADELEINE",
"rang": "1",
"specialite": "",
"type_admission": "",
"ues_validables": "3/3"
}, },
{ {
"etudid": 8, "bac": "",
"code_nip": "NIP8",
"rang": "2",
"civilite_str": "M.", "civilite_str": "M.",
"nom_disp": "SAUNIER", "classement": "",
"prenom": "JACQUES", "code_nip": "NIP8",
"nom_short": "SAUNIER Ja.", "etudid": 8,
"moy_gen": "12.67", "moy_gen": "12.67",
"moy_ue_1": "13.51",
"moy_res_1_1": "~",
"moy_res_3_1": "03.27",
"moy_res_4_1": "~",
"moy_res_5_1": "~",
"moy_res_6_1": "~",
"moy_res_18_1": "13.05",
"moy_res_10_1": "~", "moy_res_10_1": "~",
"moy_res_11_1": "~",
"moy_res_20_1": "04.35",
"moy_res_12_1": "18.85",
"moy_res_13_1": "~",
"moy_sae_2_1": "~",
"moy_sae_7_1": "17.07",
"moy_ue_2": "14.24",
"moy_res_1_2": "~",
"moy_res_4_2": "~",
"moy_res_5_2": "~",
"moy_res_9_2": "12.79",
"moy_res_10_2": "~", "moy_res_10_2": "~",
"moy_res_10_3": "~",
"moy_res_11_1": "~",
"moy_res_11_2": "~", "moy_res_11_2": "~",
"moy_res_20_2": "04.35", "moy_res_11_3": "~",
"moy_res_12_1": "18.85",
"moy_res_12_2": "18.85", "moy_res_12_2": "18.85",
"moy_res_13_1": "~",
"moy_res_13_2": "~", "moy_res_13_2": "~",
"moy_res_21_2": "~",
"moy_sae_8_2": "~",
"moy_ue_3": "10.39",
"moy_res_1_3": "~",
"moy_res_17_3": "~", "moy_res_17_3": "~",
"moy_res_18_1": "13.05",
"moy_res_18_3": "13.05", "moy_res_18_3": "13.05",
"moy_res_19_3": "~", "moy_res_19_3": "~",
"moy_res_10_3": "~", "moy_res_1_1": "~",
"moy_res_11_3": "~", "moy_res_1_2": "~",
"moy_res_1_3": "~",
"moy_res_20_1": "04.35",
"moy_res_20_2": "04.35",
"moy_res_20_3": "04.35", "moy_res_20_3": "04.35",
"moy_res_21_2": "~",
"moy_res_21_3": "~", "moy_res_21_3": "~",
"moy_res_3_1": "03.27",
"moy_res_4_1": "~",
"moy_res_4_2": "~",
"moy_res_5_1": "~",
"moy_res_5_2": "~",
"moy_res_6_1": "~",
"moy_res_9_2": "12.79",
"moy_sae_14_3": "10.74", "moy_sae_14_3": "10.74",
"moy_sae_15_3": "~", "moy_sae_15_3": "~",
"ues_validables": "3/3", "moy_sae_2_1": "~",
"bac": "", "moy_sae_7_1": "17.07",
"specialite": "", "moy_sae_8_2": "~",
"type_admission": "", "moy_ue_1": "13.51",
"classement": "", "moy_ue_2": "14.24",
"moy_ue_3": "10.39",
"nom_disp": "SAUNIER",
"nom_short": "SAUNIER Ja.",
"partitions": { "partitions": {
"1": 1 "1": 1
}
}, },
"... etc." "prenom": "JACQUES",
"rang": "2",
"specialite": "",
"type_admission": "",
"ues_validables": "3/3"
},
"..."
] ]
``` ```

88
docs/samples/sample_formsemestre.json.md
View File

@ -3,63 +3,63 @@
#### GET /formsemestre/1 #### GET /formsemestre/1
```json ```json
{ {
"titre": "Semestre test",
"block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false,
"elt_sem_apo": null,
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"annee_scolaire": 2021, "annee_scolaire": 2021,
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut": "01/09/2021",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"etape_apo": "A1, A2, A3",
"formsemestre_id": 1,
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
},
"formation_id": 1
},
"responsables": [], "responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"session_id": "TAPI-BUT-FI-S1-2021",
"titre": "Semestre test",
"titre_court": "BUT R&T", "titre_court": "BUT R&T",
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1"
"session_id": "TAPI-BUT-FI-S1-2021"
} }
``` ```

90
docs/samples/sample_formsemestres-query.json.md
View File

@ -4,65 +4,65 @@
```json ```json
[ [
{ {
"titre": "Semestre test",
"block_moyennes": false,
"scodoc7_id": null,
"date_debut": "01/09/2021",
"gestion_semestrielle": false,
"date_fin": "31/08/2022",
"bul_bgcolor": "white",
"etat": true,
"resp_can_edit": false,
"dept_id": 1,
"modalite": "FI",
"resp_can_change_ens": true,
"id": 1,
"gestion_compensation": false,
"ens_can_edit_eval": false,
"formation_id": 1,
"bul_hide_xml": false,
"elt_sem_apo": null,
"semestre_id": 1,
"elt_annee_apo": null,
"parcours": [],
"annee_scolaire": 2021, "annee_scolaire": 2021,
"block_moyennes": false,
"bul_bgcolor": "white",
"bul_hide_xml": false,
"date_debut": "01/09/2021",
"date_debut_iso": "2021-09-01", "date_debut_iso": "2021-09-01",
"date_fin": "31/08/2022",
"date_fin_iso": "2022-08-31", "date_fin_iso": "2022-08-31",
"departement": { "departement": {
"id": 1,
"acronym": "TAPI", "acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null, "description": null,
"visible": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00"
},
"etape_apo": "A1, A2, A3",
"formsemestre_id": 1,
"formation": {
"id": 1, "id": 1,
"visible": true
},
"dept_id": 1,
"elt_annee_apo": null,
"elt_sem_apo": null,
"ens_can_edit_eval": false,
"etape_apo": "A1, A2, A3",
"etat": true,
"formation": {
"acronyme": "BUT R&T",
"code_specialite": null,
"departement": {
"acronym": "TAPI",
"date_creation": "2022-08-20T12:00:00.000000+02:00",
"description": null,
"id": 1,
"visible": true
},
"dept_id": 1,
"formation_code": "V1RET",
"formation_id": 1,
"id": 1,
"referentiel_competence_id": 1,
"titre": "BUT R&T", "titre": "BUT R&T",
"titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications", "titre_officiel": "Bachelor technologique r\u00e9seaux et t\u00e9l\u00e9communications",
"formation_code": "V1RET",
"code_specialite": null,
"dept_id": 1,
"acronyme": "BUT R&T",
"version": 1,
"type_parcours": 700, "type_parcours": 700,
"referentiel_competence_id": 1, "version": 1
"departement": { },
"formation_id": 1,
"formsemestre_id": 1,
"gestion_compensation": false,
"gestion_semestrielle": false,
"id": 1, "id": 1,
"acronym": "TAPI", "modalite": "FI",
"description": null, "parcours": [],
"visible": true, "resp_can_change_ens": true,
"date_creation": "2022-08-19T11:28:05.479405+02:00" "resp_can_edit": false,
},
"formation_id": 1
},
"responsables": [], "responsables": [],
"scodoc7_id": null,
"semestre_id": 1,
"session_id": "TAPI-BUT-FI-S1-2021",
"titre": "Semestre test",
"titre_court": "BUT R&T", "titre_court": "BUT R&T",
"titre_num": "Semestre test semestre 1", "titre_num": "Semestre test semestre 1"
"session_id": "TAPI-BUT-FI-S1-2021"
}, },
"... etc." "..."
] ]
``` ```

12
docs/samples/sample_group-edit.json.md
View File

@ -7,19 +7,19 @@
```json ```json
{ {
"group_name": "NEW_GROUP2",
"id": 2, "id": 2,
"numero": null, "numero": null,
"partition_id": 1,
"group_name": "NEW_GROUP2",
"partition": { "partition": {
"id": 1,
"partition_name": null,
"bul_show_rank": false, "bul_show_rank": false,
"groups_editable": true,
"formsemestre_id": 1, "formsemestre_id": 1,
"groups_editable": true,
"id": 1,
"numero": 0, "numero": 0,
"partition_name": null,
"show_in_lists": true "show_in_lists": true
} },
"partition_id": 1
} }
``` ```

18
docs/samples/sample_group-etudiants-query.json.md
View File

@ -4,26 +4,26 @@
```json ```json
[ [
{ {
"id": 5, "civilite": "F",
"code_nip": "5",
"code_ine": "INE5", "code_ine": "INE5",
"code_nip": "5",
"dept_id": 1, "dept_id": 1,
"id": 5,
"nom": "VILLENEUVE", "nom": "VILLENEUVE",
"nom_usuel": null, "nom_usuel": null,
"prenom": "FRAN\u00c7OISE", "prenom": "FRAN\u00c7OISE"
"civilite": "F"
}, },
{ {
"id": 10, "civilite": "F",
"code_nip": "NIP10",
"code_ine": "10", "code_ine": "10",
"code_nip": "NIP10",
"dept_id": 1, "dept_id": 1,
"id": 10,
"nom": "BOUTET", "nom": "BOUTET",
"nom_usuel": null, "nom_usuel": null,
"prenom": "MARGUERITE", "prenom": "MARGUERITE"
"civilite": "F"
}, },
"... etc." "..."
] ]
``` ```

18
docs/samples/sample_group-etudiants.json.md
View File

@ -4,26 +4,26 @@
```json ```json
[ [
{ {
"id": 1, "civilite": "X",
"code_nip": "1",
"code_ine": "INE1", "code_ine": "INE1",
"code_nip": "1",
"dept_id": 1, "dept_id": 1,
"id": 1,
"nom": "COSTA", "nom": "COSTA",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SACHA", "prenom": "SACHA"
"civilite": "X"
}, },
{ {
"id": 2, "civilite": "F",
"code_nip": "NIP2",
"code_ine": "2", "code_ine": "2",
"code_nip": "NIP2",
"dept_id": 1, "dept_id": 1,
"id": 2,
"nom": "NAUDIN", "nom": "NAUDIN",
"nom_usuel": null, "nom_usuel": null,
"prenom": "SIMONE", "prenom": "SIMONE"
"civilite": "F"
}, },
"... etc." "..."
] ]
``` ```

4
docs/samples/sample_group-remove_etudiant.json.md
View File

@ -3,8 +3,8 @@
#### POST /group/1/remove_etudiant/10 #### POST /group/1/remove_etudiant/10
```json ```json
{ {
"group_id": 1, "etudid": 10,
"etudid": 10 "group_id": 1
} }
``` ```

4
docs/samples/sample_group-set_etudiant.json.md
View File

@ -3,8 +3,8 @@
#### POST /group/1/set_etudiant/10 #### POST /group/1/set_etudiant/10
```json ```json
{ {
"group_id": 1, "etudid": 10,
"etudid": 10 "group_id": 1
} }
``` ```

4
docs/samples/sample_logo.json.md
View File

@ -3,8 +3,8 @@
#### GET /logo/demo #### GET /logo/demo
```json ```json
{ {
"Content-Type": "image/png", "Content-Disposition": "inline; filename=logo_demo.png",
"Content-Disposition": "inline; filename=logo_demo.png" "Content-Type": "image/png"
} }
``` ```

2
docs/samples/sample_logos.json.md
View File

@ -5,7 +5,7 @@
[ [
"header", "header",
"footer", "footer",
"... etc." "..."
] ]
``` ```

34
docs/samples/sample_moduleimpl-evaluations.json.md
View File

@ -4,29 +4,29 @@
```json ```json
[ [
{ {
"id": 1, "apresmidi": 0,
"moduleimpl_id": 1,
"heure_debut": "08h00",
"description": null,
"note_max": 20.0,
"visibulletin": true,
"evaluation_type": 0,
"jour": "",
"heure_fin": "09h00",
"coefficient": 1.0, "coefficient": 1.0,
"publish_incomplete": true,
"numero": 0,
"evaluation_id": 1,
"date_debut": null, "date_debut": null,
"date_fin": null, "date_fin": null,
"poids": {},
"jouriso": null,
"duree": "1h",
"descrheure": " de 08h00 \u00e0 09h00", "descrheure": " de 08h00 \u00e0 09h00",
"description": null,
"duree": "1h",
"evaluation_id": 1,
"evaluation_type": 0,
"heure_debut": "08h00",
"heure_fin": "09h00",
"id": 1,
"jour": "",
"jouriso": null,
"matin": 0, "matin": 0,
"apresmidi": 0 "moduleimpl_id": 1,
"note_max": 20.0,
"numero": 0,
"poids": {},
"publish_incomplete": true,
"visibulletin": true
}, },
"... etc." "..."
] ]
``` ```

46
docs/samples/sample_moduleimpl.json.md
View File

@ -3,34 +3,34 @@
#### GET /moduleimpl/1 #### GET /moduleimpl/1
```json ```json
{ {
"module_id": 1,
"formsemestre_id": 1,
"computation_expr": null, "computation_expr": null,
"id": 1,
"responsable_id": 2,
"moduleimpl_id": 1,
"ens": [], "ens": [],
"module": { "formsemestre_id": 1,
"code": "R101",
"matiere_id": 1,
"heures_cours": 0.0,
"semestre_id": 1,
"heures_td": 0.0,
"numero": 10,
"heures_tp": 0.0,
"code_apogee": "",
"titre": "Initiation aux r\u00e9seaux informatiques",
"coefficient": 1.0,
"module_type": 2,
"id": 1, "id": 1,
"ects": null, "module": {
"abbrev": "Init aux r\u00e9seaux informatiques", "abbrev": "Init aux r\u00e9seaux informatiques",
"ue_id": 1,
"formation_id": 1,
"parcours": [],
"app_critiques": [], "app_critiques": [],
"module_id": 1 "code": "R101",
} "code_apogee": "",
"coefficient": 1.0,
"ects": null,
"formation_id": 1,
"heures_cours": 0.0,
"heures_td": 0.0,
"heures_tp": 0.0,
"id": 1,
"matiere_id": 1,
"module_id": 1,
"module_type": 2,
"numero": 10,
"parcours": [],
"semestre_id": 1,
"titre": "Initiation aux r\u00e9seaux informatiques",
"ue_id": 1
},
"module_id": 1,
"moduleimpl_id": 1,
"responsable_id": 2
} }
``` ```

14
docs/samples/sample_partition-edit.json.md
View File

@ -7,21 +7,21 @@
```json ```json
{ {
"partition_name": "P2BIS",
"bul_show_rank": true, "bul_show_rank": true,
"groups_editable": true,
"id": 1,
"formsemestre_id": 1, "formsemestre_id": 1,
"show_in_lists": false,
"numero": 3,
"groups": { "groups": {
"1": { "1": {
"group_name": null,
"id": 1, "id": 1,
"numero": null, "numero": null,
"group_name": null,
"partition_id": 1 "partition_id": 1
} }
} },
"groups_editable": true,
"id": 1,
"numero": 3,
"partition_name": "P2BIS",
"show_in_lists": false
} }
``` ```

14
docs/samples/sample_partition-group-create.json.md
View File

@ -7,19 +7,19 @@
```json ```json
{ {
"group_name": "NEW_GROUP",
"id": 2, "id": 2,
"numero": null, "numero": null,
"partition_id": 1,
"group_name": "NEW_GROUP",
"partition": { "partition": {
"partition_name": null,
"bul_show_rank": false, "bul_show_rank": false,
"formsemestre_id": 1,
"groups_editable": true, "groups_editable": true,
"id": 1, "id": 1,
"formsemestre_id": 1, "numero": 0,
"show_in_lists": true, "partition_name": null,
"numero": 0 "show_in_lists": true
} },
"partition_id": 1
} }
``` ```

14
docs/samples/sample_partition-groups-order.json.md
View File

@ -7,21 +7,21 @@
```json ```json
{ {
"partition_name": "P2BIS",
"bul_show_rank": true, "bul_show_rank": true,
"groups_editable": true,
"id": 1,
"formsemestre_id": 1, "formsemestre_id": 1,
"show_in_lists": false,
"numero": 3,
"groups": { "groups": {
"1": { "1": {
"group_name": null,
"id": 1, "id": 1,
"numero": 0, "numero": 0,
"group_name": null,
"partition_id": 1 "partition_id": 1
} }
} },
"groups_editable": true,
"id": 1,
"numero": 3,
"partition_name": "P2BIS",
"show_in_lists": false
} }
``` ```

4
docs/samples/sample_partition-remove_etudiant.json.md
View File

@ -3,8 +3,8 @@
#### POST /partition/2/remove_etudiant/10 #### POST /partition/2/remove_etudiant/10
```json ```json
{ {
"partition_id": 2, "etudid": 10,
"etudid": 10 "partition_id": 2
} }
``` ```

14
docs/samples/sample_partition.json.md
View File

@ -3,21 +3,21 @@
#### GET /partition/1 #### GET /partition/1
```json ```json
{ {
"id": 1,
"partition_name": null,
"bul_show_rank": false, "bul_show_rank": false,
"groups_editable": true,
"formsemestre_id": 1, "formsemestre_id": 1,
"numero": 0,
"show_in_lists": true,
"groups": { "groups": {
"1": { "1": {
"group_name": null,
"id": 1, "id": 1,
"numero": null, "numero": null,
"group_name": null,
"partition_id": 1 "partition_id": 1
} }
} },
"groups_editable": true,
"id": 1,
"numero": 0,
"partition_name": null,
"show_in_lists": true
} }
``` ```

2
docs/samples/sample_permissions.json.md
View File

@ -5,7 +5,7 @@
[ [
"ScoSuperAdmin", "ScoSuperAdmin",
"APIView", "APIView",
"... etc." "..."
] ]
``` ```

4
docs/samples/sample_role-add_permission.json.md
View File

@ -4,11 +4,11 @@
```json ```json
{ {
"id": 13, "id": 13,
"role_name": "customRole",
"permissions": [ "permissions": [
"ScoUsersView", "ScoUsersView",
"ScoView" "ScoView"
] ],
"role_name": "customRole"
} }
``` ```

4
docs/samples/sample_role-create.json.md
View File

@ -8,11 +8,11 @@
```json ```json
{ {
"id": 13, "id": 13,
"role_name": "customRole",
"permissions": [ "permissions": [
"ScoUsersView", "ScoUsersView",
"ScoView" "ScoView"
] ],
"role_name": "customRole"
} }
``` ```

4
docs/samples/sample_role-edit.json.md
View File

@ -8,10 +8,10 @@
```json ```json
{ {
"id": 13, "id": 13,
"role_name": "customRole",
"permissions": [ "permissions": [
"ScoView" "ScoView"
] ],
"role_name": "customRole"
} }
``` ```

4
docs/samples/sample_role-remove_permission.json.md
View File

@ -4,10 +4,10 @@
```json ```json
{ {
"id": 13, "id": 13,
"role_name": "customRole",
"permissions": [ "permissions": [
"ScoView" "ScoView"
] ],
"role_name": "customRole"
} }
``` ```

4
docs/samples/sample_role.json.md
View File

@ -4,10 +4,10 @@
```json ```json
{ {
"id": 1, "id": 1,
"role_name": "Observateur",
"permissions": [ "permissions": [
"ScoObservateur" "ScoObservateur"
] ],
"role_name": "Observateur"
} }
``` ```

10
docs/samples/sample_roles.json.md
View File

@ -5,14 +5,13 @@
[ [
{ {
"id": 1, "id": 1,
"role_name": "Observateur",
"permissions": [ "permissions": [
"ScoObservateur" "ScoObservateur"
] ],
"role_name": "Observateur"
}, },
{ {
"id": 2, "id": 2,
"role_name": "Ens",
"permissions": [ "permissions": [
"ScoEntrepriseView", "ScoEntrepriseView",
"ScoEtudAddAnnotations", "ScoEtudAddAnnotations",
@ -22,9 +21,10 @@
"ScoObservateur", "ScoObservateur",
"ScoEnsView", "ScoEnsView",
"ScoView" "ScoView"
] ],
"role_name": "Ens"
}, },
"... etc." "..."
] ]
``` ```

30
docs/samples/sample_user-create.json.md
View File

@ -7,25 +7,25 @@
```json ```json
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:29:19.775361Z",
"date_created": "2022-08-19T09:29:19.775364Z",
"dept": null,
"id": 10,
"active": true, "active": true,
"status_txt": "actif", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:29:19.775354Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": null,
"email": "",
"id": 10,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "alain", "nom": "alain",
"prenom": "bruno",
"roles_string": "",
"user_name": "alain",
"nom_fmt": "Alain", "nom_fmt": "Alain",
"prenom_fmt": "Bruno",
"nomprenom": "Alain B.",
"prenomnom": "B. Alain",
"nomplogin": "ALAIN Bruno (alain)",
"nomcomplet": "Bruno Alain", "nomcomplet": "Bruno Alain",
"email": "" "nomplogin": "ALAIN Bruno (alain)",
"nomprenom": "Alain B.",
"prenom": "bruno",
"prenom_fmt": "Bruno",
"prenomnom": "B. Alain",
"roles_string": "",
"status_txt": "actif",
"user_name": "alain"
} }
``` ```

30
docs/samples/sample_user-edit.json.md
View File

@ -7,25 +7,25 @@
```json ```json
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:29:19.775361Z",
"date_created": "2022-08-19T09:29:19.775364Z",
"dept": "TAPI",
"id": 10,
"active": false, "active": false,
"status_txt": "ferm\u00e9", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:29:19.775354Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "TAPI",
"email": "",
"id": 10,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "alain2", "nom": "alain2",
"prenom": "bruno2",
"roles_string": "",
"user_name": "alain",
"nom_fmt": "Alain2", "nom_fmt": "Alain2",
"prenom_fmt": "Bruno2",
"nomprenom": "Alain2 B.",
"prenomnom": "B. Alain2",
"nomplogin": "ALAIN2 Bruno2 (alain)",
"nomcomplet": "Bruno2 Alain2", "nomcomplet": "Bruno2 Alain2",
"email": "" "nomplogin": "ALAIN2 Bruno2 (alain)",
"nomprenom": "Alain2 B.",
"prenom": "bruno2",
"prenom_fmt": "Bruno2",
"prenomnom": "B. Alain2",
"roles_string": "",
"status_txt": "ferm\u00e9",
"user_name": "alain"
} }
``` ```

31
docs/samples/sample_user-password.json.md Normal file
View File

@ -0,0 +1,31 @@
### user-password
#### POST /user/3/password
> `Content-Type: application/json`
>
> `{ "password": "rePlaCemeNT456averylongandcomplicated" }`
```json
{
"active": true,
"date_created": "2022-08-20T12:00:00.000000+02:00",
"date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "TAPI",
"email": "",
"id": 3,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "Sans",
"nom_fmt": "Sans",
"nomcomplet": "Permission Sans",
"nomplogin": "SANS Permission (other)",
"nomprenom": "Sans P.",
"prenom": "Permission",
"prenom_fmt": "Permission",
"prenomnom": "P. Sans",
"roles_string": "",
"status_txt": "actif",
"user_name": "other"
}
```

30
docs/samples/sample_user-role-add.json.md
View File

@ -3,25 +3,25 @@
#### POST /user/10/role/Observateur/add #### POST /user/10/role/Observateur/add
```json ```json
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:29:19.775361Z",
"date_created": "2022-08-19T09:29:19.775364Z",
"dept": "TAPI",
"id": 10,
"active": false, "active": false,
"status_txt": "ferm\u00e9", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:29:19.775354Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "TAPI",
"email": "",
"id": 10,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "alain2", "nom": "alain2",
"prenom": "bruno2",
"roles_string": "Observateur_",
"user_name": "alain",
"nom_fmt": "Alain2", "nom_fmt": "Alain2",
"prenom_fmt": "Bruno2",
"nomprenom": "Alain2 B.",
"prenomnom": "B. Alain2",
"nomplogin": "ALAIN2 Bruno2 (alain)",
"nomcomplet": "Bruno2 Alain2", "nomcomplet": "Bruno2 Alain2",
"email": "" "nomplogin": "ALAIN2 Bruno2 (alain)",
"nomprenom": "Alain2 B.",
"prenom": "bruno2",
"prenom_fmt": "Bruno2",
"prenomnom": "B. Alain2",
"roles_string": "Observateur_",
"status_txt": "ferm\u00e9",
"user_name": "alain"
} }
``` ```

30
docs/samples/sample_user-role-remove.json.md
View File

@ -3,25 +3,25 @@
#### POST /user/10/role/Observateur/remove #### POST /user/10/role/Observateur/remove
```json ```json
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:29:19.775361Z",
"date_created": "2022-08-19T09:29:19.775364Z",
"dept": "TAPI",
"id": 10,
"active": false, "active": false,
"status_txt": "ferm\u00e9", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:29:19.775354Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "TAPI",
"email": "",
"id": 10,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "alain2", "nom": "alain2",
"prenom": "bruno2",
"roles_string": "",
"user_name": "alain",
"nom_fmt": "Alain2", "nom_fmt": "Alain2",
"prenom_fmt": "Bruno2",
"nomprenom": "Alain2 B.",
"prenomnom": "B. Alain2",
"nomplogin": "ALAIN2 Bruno2 (alain)",
"nomcomplet": "Bruno2 Alain2", "nomcomplet": "Bruno2 Alain2",
"email": "" "nomplogin": "ALAIN2 Bruno2 (alain)",
"nomprenom": "Alain2 B.",
"prenom": "bruno2",
"prenom_fmt": "Bruno2",
"prenomnom": "B. Alain2",
"roles_string": "",
"status_txt": "ferm\u00e9",
"user_name": "alain"
} }
``` ```

30
docs/samples/sample_user.json.md
View File

@ -3,25 +3,25 @@
#### GET /user/1 #### GET /user/1
```json ```json
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:27:59.660680Z",
"date_created": "2022-08-19T09:27:59.660683Z",
"dept": null,
"id": 1,
"active": true, "active": true,
"status_txt": "actif", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:27:59.660673Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": null,
"email": "iuta-scodoc@univ-lille.fr",
"id": 1,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "", "nom": "",
"prenom": "",
"roles_string": "SuperAdmin_",
"user_name": "admin",
"nom_fmt": "admin", "nom_fmt": "admin",
"prenom_fmt": "",
"nomprenom": "admin",
"prenomnom": "admin",
"nomplogin": "ADMIN (admin)",
"nomcomplet": " admin", "nomcomplet": " admin",
"email": "iuta-scodoc@univ-lille.fr" "nomplogin": "ADMIN (admin)",
"nomprenom": "admin",
"prenom": "",
"prenom_fmt": "",
"prenomnom": "admin",
"roles_string": "SuperAdmin_",
"status_txt": "actif",
"user_name": "admin"
} }
``` ```

62
docs/samples/sample_users-query.json.md
View File

@ -4,48 +4,48 @@
```json ```json
[ [
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:28:07.700732Z",
"date_created": "2022-08-19T09:28:07.700735Z",
"dept": "AA",
"id": 6,
"active": true, "active": true,
"status_txt": "actif", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:28:07.700726Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "AA",
"email": "",
"id": 6,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "U AA", "nom": "U AA",
"prenom": "lambda",
"roles_string": "UsersViewer_TAPI,Viewer_,UsersViewer_AA,Viewer_",
"user_name": "u_AA",
"nom_fmt": "U Aa", "nom_fmt": "U Aa",
"prenom_fmt": "Lambda",
"nomprenom": "U Aa L.",
"prenomnom": "L. U Aa",
"nomplogin": "U AA Lambda (u_AA)",
"nomcomplet": "Lambda U Aa", "nomcomplet": "Lambda U Aa",
"email": "" "nomplogin": "U AA Lambda (u_AA)",
"nomprenom": "U Aa L.",
"prenom": "lambda",
"prenom_fmt": "Lambda",
"prenomnom": "L. U Aa",
"roles_string": "UsersViewer_TAPI,Viewer_,UsersViewer_AA,Viewer_",
"status_txt": "actif",
"user_name": "u_AA"
}, },
{ {
"date_expiration": null,
"date_modif_passwd": "2022-08-19T09:28:08.125041Z",
"date_created": "2022-08-19T09:28:08.125043Z",
"dept": "BB",
"id": 7,
"active": true, "active": true,
"status_txt": "actif", "date_created": "2022-08-20T12:00:00.000000+02:00",
"last_seen": "2022-08-19T09:28:08.125034Z", "date_expiration": null,
"date_modif_passwd": "2022-08-20T12:00:00.000000+02:00",
"dept": "BB",
"email": "",
"id": 7,
"last_seen": "2022-08-20T12:00:00.000000+02:00",
"nom": "U BB", "nom": "U BB",
"prenom": "lambda",
"roles_string": "UsersViewer_TAPI,Viewer_,UsersViewer_AA,Viewer_,UsersViewer_BB,Viewer_",
"user_name": "u_BB",
"nom_fmt": "U Bb", "nom_fmt": "U Bb",
"prenom_fmt": "Lambda",
"nomprenom": "U Bb L.",
"prenomnom": "L. U Bb",
"nomplogin": "U BB Lambda (u_BB)",
"nomcomplet": "Lambda U Bb", "nomcomplet": "Lambda U Bb",
"email": "" "nomplogin": "U BB Lambda (u_BB)",
"nomprenom": "U Bb L.",
"prenom": "lambda",
"prenom_fmt": "Lambda",
"prenomnom": "L. U Bb",
"roles_string": "UsersViewer_TAPI,Viewer_,UsersViewer_AA,Viewer_,UsersViewer_BB,Viewer_",
"status_txt": "actif",
"user_name": "u_BB"
}, },
"... etc." "..."
] ]
``` ```