forked from ScoDoc/DocScoDoc
Précisions divers. Nouvelle API /api/etudiants/name.
This commit is contained in:
parent
290f967e32
commit
65bc5d304c
@ -192,9 +192,15 @@ Dans chaque module, on peut régler les inscriptions:
|
||||
|
||||
<img src="/screens/but-info-inscr-module.png" width="30%">
|
||||
|
||||
!!! note "Voir aussi"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
- [Guide du responsable de formation](GuideAdminFormation/md)
|
||||
- [Édition des programmes de formation](VersionProgrammes.md)
|
||||
- [Guide utilisateur](GuideUtilisateur.md)
|
||||
- [Tutoriels vidéo](https://www.youtube.com/channel/UCb0JYCBRi0CsE4XFp4ByhXg)
|
||||
- [Gestion des UE Bonus](https://www.youtube.com/watch?v=SVbjuDpq-lI)
|
||||
- [Mise en place des parcours BUT](https://www.youtube.com/watch?v=OnuOXJo-3ro)
|
||||
- [Saisie des codes Apogée](https://www.youtube.com/watch?v=MW0nNhbBjDM)
|
||||
- [Du DUT au BUT: comment transformer un programme](https://www.youtube.com/watch?v=9HizGTvYgck)
|
||||
- [FAQ](FAQ.md)
|
||||
- [Contacts](Contact.md)
|
||||
|
||||
@ -81,6 +81,12 @@ Ou bien au niveau de son inscription dans un semestre, via le menu *Scolarité*:
|
||||
abandonne en tout début d'année (il ne sera alors pas compté dans les
|
||||
inscrits).
|
||||
|
||||
### Les ECTS ne s'affichent pas
|
||||
|
||||
Les ECTS sont attribués (ou pas) au moment de la saisie de la décision de jury
|
||||
sur les UEs. Avant le jury, l'étudiant n'a jamais d'ECTS, quelles que soient ses
|
||||
notes.
|
||||
|
||||
### Mes données sont erronées, que faire ?
|
||||
|
||||
En cas de problème (bug, erreur de manipulation, suspicion de piratage),
|
||||
|
||||
@ -142,6 +142,7 @@ fichiers sur la page
|
||||
|
||||
- [Édition des programmes de formation](VersionProgrammes.md)
|
||||
- [Guide utilisateur](GuideUtilisateur.md)
|
||||
- [Modélisation BUT: exemple complet](BUTExempleInfo.md)
|
||||
- [Tutoriels vidéo](https://www.youtube.com/channel/UCb0JYCBRi0CsE4XFp4ByhXg)
|
||||
- [Gestion des UE Bonus](https://www.youtube.com/watch?v=SVbjuDpq-lI)
|
||||
- [Mise en place des parcours BUT](https://www.youtube.com/watch?v=OnuOXJo-3ro)
|
||||
|
||||
@ -103,6 +103,50 @@ mises à jour de `master` (remote), faire:
|
||||
git pull origin master
|
||||
```
|
||||
|
||||
#### Autre exemple pour les développeurs
|
||||
|
||||
Vous travaillez sur un clone du dépôt principal ("origin"), obtenu par exemple via
|
||||
|
||||
```bash
|
||||
git clone https://scodoc.org/git/ScoDoc/ScoDoc.git
|
||||
```
|
||||
|
||||
remplacer par l'URL de votre dépôt sur gitea au besoin. Si vous avez votre
|
||||
propre dépôt sur gitea, utilisez deux "remote": l'un pour votre dépôt gitea (ici
|
||||
nommé `mon_origin`), l'autre pour le dépôt principal ScoDoc (ici nommé
|
||||
`origin`).
|
||||
|
||||
```bash
|
||||
git remote add origin https://scodoc.org/git/viennet/ScoDoc.git
|
||||
git remote -v
|
||||
mon_origin https://xxx.xxx (fetch)
|
||||
mon_origin https://xxx.xxx (push)
|
||||
origin https://scodoc.org/git/viennet/ScoDoc.git (fetch)
|
||||
origin https://scodoc.org/git/viennet/ScoDoc.git (push)
|
||||
```
|
||||
|
||||
Ensuite, tout est prêt, vous créez votre branche:
|
||||
|
||||
```bash
|
||||
git checkout -b ma_branche
|
||||
```
|
||||
|
||||
et la poussez sur votre dépôt: (remplacer `mon_origin`au besoin)
|
||||
|
||||
```bash
|
||||
git push -u mon_origin ma_branche
|
||||
```
|
||||
|
||||
Ajoutez au fur et à mesure vos commits comme d'habitude. Mais régulièrement
|
||||
(chaque jour), mettez à jour pour éviter de diverger de la branche `master` (ou
|
||||
autre suivant les cas) de ScoDoc:
|
||||
|
||||
```bash
|
||||
git pull origin master
|
||||
```
|
||||
|
||||
Vous pouvez alors à tout moment soumettre une PR propre.
|
||||
|
||||
#### Commandes utiles, en vrac
|
||||
|
||||
* `git log -L:fonction_python:fichier.py`
|
||||
|
||||
@ -277,6 +277,7 @@ Ce tableau est trié selon le type des informations renvoyées:
|
||||
| group:ACTION | | POST | [group-remove_etudiant](#group-remove_etudiant) | ScoEtudChangeGroups |
|
||||
| etudiant**`*`** | recherche par etudid, nip ou ine | GET | [etudiants-clef](#etudiants-clef) | ScoView |
|
||||
| etudiant**`*`** | les étudiants actuels | GET | [etudiants-courant](#etudiants-courant) | ScoView |
|
||||
| etudiant**`*`** | étudiants dont le nom commence par | GET | [etudiants-name](#etudiants-name) | ScoView |
|
||||
| etudiant**`*`** | | GET | [departement-etudiants](#departement-etudiants) | ScoView |
|
||||
| etudiant**`*`** | | GET | [formsemestre-etudiants](#formsemestre-etudiants) | ScoView |
|
||||
| etudiant**`*`** | | GET | [formsemestre-etudiants-query](#formsemestre-etudiants-query) | ScoView |
|
||||
@ -454,14 +455,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
||||
| typeadresse | string | |
|
||||
| villedomicile | string | |
|
||||
|
||||
#### **`etudiants`** (supprimé)
|
||||
|
||||
* **Méthode:** GET
|
||||
* **Routes:** `/etudiants
|
||||
* **Exemple d'utilisation:** `/api/etudiants`
|
||||
* **Résultat:** Liste complète de tous les étudiants (passés ou présents) pour
|
||||
lequel l'utilisateur a la permission ScoView.
|
||||
* **Exemple de résultat:** [etudiants.json] (samples/sample_etudiants.json.md)
|
||||
|
||||
#### **`etudiants-courants`**
|
||||
|
||||
@ -483,7 +477,7 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
||||
* **Paramètres:** `etudid`, `nip`, `ine`
|
||||
* **Routes:** `/etudiants/etudid/<int:etudid>` ou `/etudiants/nip/<string:nip>` ou `/etudiants/ine/<string:ine>`
|
||||
* **Exemple d'utilisation:** `/api/etudiants/nip/1`
|
||||
* **Résultat:** Info sur le ou les étudiants correspondants.
|
||||
* **Résultat:** Infos sur le ou les étudiants correspondants.
|
||||
Comme [`/etudiant`](ScoDoc9API.md#etudiant) mais renvoie toujours une liste.
|
||||
Si non trouvé, liste vide, pas d'erreur.
|
||||
Dans 99% des cas, la liste contient un seul étudiant, mais si l'étudiant a
|
||||
@ -491,6 +485,19 @@ Pour uniformiser les résultats des exemples, ceux sont soumis à quelques post-
|
||||
dept.).
|
||||
* **Exemple de résultat:** [etudiants-clef.json](samples/sample_etudiants-clef.json.md)
|
||||
|
||||
#### **`etudiants-name`**
|
||||
|
||||
* **Méthode:** GET
|
||||
* **Permission: `ScoView`**
|
||||
* **Paramètres:** `name`
|
||||
* **Routes:** `/etudiants/name/<string:name>`
|
||||
* **Exemple d'utilisation:** `/api/etudiants/name/dup`
|
||||
* **Résultat:** Liste ordonnée par nom d'étudiants dont le nom commence par
|
||||
`name`. Si `name`est trop court (2 caractères), liste vide. La casse et les
|
||||
accents ne sont pas pris en compte dans la recherche.
|
||||
* **Note:** Cette fonction est utilisée pour la complétion des champs de formulaire
|
||||
(choix d'un étudiant).
|
||||
|
||||
#### **departement-etudiants**
|
||||
|
||||
* **Méthode:** GET
|
||||
@ -1165,6 +1172,9 @@ d'un autre).
|
||||
|
||||
### ** API Bulletin, Évaluations, Notes**
|
||||
|
||||
Attention, les bulletins ne sont publiés sur l'API que si l'option "*publier le
|
||||
bulletin sur le portail étudiant*" est cochée dans le semestre concerné.
|
||||
|
||||
#### **formsemestre-bulletins**
|
||||
|
||||
* **Méthode:** GET
|
||||
@ -1218,6 +1228,10 @@ mais pas JSON compliant à cause des `NaN`.
|
||||
Les versions PDF sont par défaut identiques à celles servies dans ScoDoc. Avec
|
||||
l'option `/pdf/nosig`, les signatures en fin de bulletin sont omises.
|
||||
|
||||
Attention, les bulletins ne sont publiés sur l'API que si l'option "*publier le
|
||||
bulletin sur le portail étudiant*" est cochée dans le semestre concerné.
|
||||
|
||||
|
||||
* **Exemple de résultat:** [etudiant-formsemestre-bulletin.json](samples/sample_etudiant-formsemestre-bulletin.json.md)
|
||||
|
||||
#### **formsemestre-programme**
|
||||
|
||||
Loading…
Reference in New Issue
Block a user