1
0
forked from ScoDoc/ScoDoc
ScoDoc/app/api/departements.py

270 lines
7.4 KiB
Python
Raw Normal View History

##############################################################################
# ScoDoc
2023-12-31 23:04:06 +01:00
# Copyright (c) 1999 - 2024 Emmanuel Viennet. All rights reserved.
# See LICENSE
##############################################################################
"""
ScoDoc 9 API : accès aux départements
Note: les routes /departement[s] sont publiées sur l'API (/ScoDoc/api/),
mais évidemment pas sur l'API web (/ScoDoc/<dept>/api).
2024-07-24 17:34:30 +02:00
CATEGORY
--------
Département
"""
from datetime import datetime
2022-05-03 13:35:17 +02:00
from flask import request
from flask_json import as_json
from flask_login import login_required
2024-07-18 16:54:48 +02:00
from app import db, log
from app.api import api_bp as bp, API_CLIENT_ERROR
from app.api import api_permission_required as permission_required
from app.decorators import scodoc
from app.models import Departement, FormSemestre
from app.models import departements
from app.scodoc.sco_exceptions import ScoValueError
2022-03-04 17:16:08 +01:00
from app.scodoc.sco_permissions import Permission
from app.scodoc.sco_utils import json_error
@bp.route("/departements")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departements_list():
2024-07-24 17:34:30 +02:00
"""Liste tous les départements."""
return [dept.to_dict(with_dept_name=True) for dept in Departement.query]
2022-07-21 09:59:54 +02:00
@bp.route("/departements_ids")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
2022-05-05 18:11:44 +02:00
def departements_ids():
2024-07-24 17:34:30 +02:00
"""Liste des ids de tous les départements."""
return [dept.id for dept in Departement.query]
2022-05-05 18:11:44 +02:00
@bp.route("/departement/<string:acronym>")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_by_acronym(acronym: str):
"""
2022-07-21 09:59:54 +02:00
Info sur un département. Accès par acronyme.
Exemple de résultat :
2024-07-24 17:34:30 +02:00
```json
{
"id": 1,
"acronym": "TAPI",
"dept_name" : "TEST",
"description": null,
"visible": true,
"date_creation": "Fri, 15 Apr 2022 12:19:28 GMT"
2022-05-05 18:11:44 +02:00
}
2024-07-24 17:34:30 +02:00
```
"""
2022-07-21 09:59:54 +02:00
dept = Departement.query.filter_by(acronym=acronym).first_or_404()
return dept.to_dict(with_dept_name=True)
@bp.route("/departement/id/<int:dept_id>")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
2022-07-21 09:59:54 +02:00
def departement_by_id(dept_id: int):
"""
Info sur un département. Accès par id.
"""
dept = Departement.query.get_or_404(dept_id)
return dept.to_dict()
@bp.route("/departement/create", methods=["POST"])
@login_required
@scodoc
@permission_required(Permission.ScoSuperAdmin)
@as_json
def departement_create():
"""
Création d'un département.
2024-07-24 17:34:30 +02:00
Le content type doit être `application/json`.
DATA
----
```json
{
"acronym": str,
2024-07-24 17:34:30 +02:00
"visible": bool,
}
2024-07-24 17:34:30 +02:00
```
"""
data = request.get_json(force=True) # may raise 400 Bad Request
acronym = str(data.get("acronym", ""))
if not acronym:
return json_error(API_CLIENT_ERROR, "missing acronym")
visible = bool(data.get("visible", True))
try:
dept = departements.create_dept(acronym, visible=visible)
except ScoValueError as exc:
return json_error(500, exc.args[0] if exc.args else "")
log(f"departement_create {dept.acronym}")
return dept.to_dict()
@bp.route("/departement/<string:acronym>/edit", methods=["POST"])
@login_required
@scodoc
@permission_required(Permission.ScoSuperAdmin)
@as_json
def departement_edit(acronym):
"""
2024-07-24 17:34:30 +02:00
Édition d'un département: seul le champ `visible` peut être modifié.
DATA
----
{
2024-07-24 17:34:30 +02:00
"visible": bool,
}
"""
dept = Departement.query.filter_by(acronym=acronym).first_or_404()
data = request.get_json(force=True) # may raise 400 Bad Request
visible = bool(data.get("visible", None))
if visible is None:
return json_error(API_CLIENT_ERROR, "missing argument: visible")
visible = bool(visible)
dept.visible = visible
db.session.add(dept)
db.session.commit()
log(f"departement_edit {dept.acronym}")
return dept.to_dict()
@bp.route("/departement/<string:acronym>/delete", methods=["POST"])
@login_required
@scodoc
@permission_required(Permission.ScoSuperAdmin)
def departement_delete(acronym):
"""
2024-07-24 17:34:30 +02:00
Suppression d'un département identifié par son acronyme.
"""
dept = Departement.query.filter_by(acronym=acronym).first_or_404()
acronym = dept.acronym
db.session.delete(dept)
db.session.commit()
log(f"departement_delete {acronym}")
return {"OK": True}
2022-07-21 09:59:54 +02:00
@bp.route("/departement/<string:acronym>/etudiants", methods=["GET"])
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_etudiants(acronym: str):
"""
2024-07-24 17:34:30 +02:00
Retourne la liste des étudiants d'un département.
2024-07-24 17:34:30 +02:00
PARAMS
------
acronym : l'acronyme d'un département
Exemple de résultat :
2024-07-24 17:34:30 +02:00
```json
[
{
2022-05-05 18:11:44 +02:00
"civilite": "M",
"code_ine": "7899X61616",
"code_nip": "F6777H88",
"date_naissance": null,
2022-05-05 18:11:44 +02:00
"email": "toto@toto.fr",
"emailperso": null,
"etudid": 18,
"nom": "MOREL",
"prenom": "JACQUES"
},
...
]
2024-07-24 17:34:30 +02:00
```
"""
2022-07-21 09:59:54 +02:00
dept = Departement.query.filter_by(acronym=acronym).first_or_404()
2024-02-27 21:23:45 +01:00
return [etud.to_dict_short() for etud in dept.etudiants]
2022-07-21 09:59:54 +02:00
@bp.route("/departement/id/<int:dept_id>/etudiants")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_etudiants_by_id(dept_id: int):
2022-07-21 09:59:54 +02:00
"""
Retourne la liste des étudiants d'un département d'id donné.
"""
dept = Departement.query.get_or_404(dept_id)
2024-02-27 21:23:45 +01:00
return [etud.to_dict_short() for etud in dept.etudiants]
@bp.route("/departement/<string:acronym>/formsemestres_ids")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_formsemestres_ids(acronym: str):
2024-07-24 17:34:30 +02:00
"""Liste des ids de tous les formsemestres du département."""
2022-07-21 09:59:54 +02:00
dept = Departement.query.filter_by(acronym=acronym).first_or_404()
return [formsemestre.id for formsemestre in dept.formsemestres]
@bp.route("/departement/id/<int:dept_id>/formsemestres_ids")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_formsemestres_ids_by_id(dept_id: int):
2024-07-24 17:34:30 +02:00
"""Liste des ids de tous les formsemestres du département."""
2022-07-21 09:59:54 +02:00
dept = Departement.query.get_or_404(dept_id)
return [formsemestre.id for formsemestre in dept.formsemestres]
2022-07-21 09:59:54 +02:00
@bp.route("/departement/<string:acronym>/formsemestres_courants")
2024-06-22 17:02:29 +02:00
@bp.route("/departement/id/<int:dept_id>/formsemestres_courants")
@login_required
@scodoc
@permission_required(Permission.ScoView)
@as_json
def departement_formsemestres_courants(acronym: str = "", dept_id: int | None = None):
2022-07-21 09:59:54 +02:00
"""
2024-07-24 17:34:30 +02:00
Liste les formsemestres du département indiqué (par son acronyme ou son id)
2024-06-22 17:02:29 +02:00
contenant la date courante, ou à défaut celle indiquée en argument
(au format ISO).
QUERY
-----
date_courante:<string:date_courante>
"""
2024-06-22 17:02:29 +02:00
dept = (
Departement.query.filter_by(acronym=acronym).first_or_404()
if acronym
else Departement.query.get_or_404(dept_id)
)
date_courante = request.args.get("date_courante")
date_courante = datetime.fromisoformat(date_courante) if date_courante else None
return [
formsemestre.to_dict_api()
for formsemestre in FormSemestre.get_dept_formsemestres_courants(
dept, date_courante
)
]