DocScoDocPE/ScoDoc9API.md at d9935fed216691d1d1dd1cb9debaa44cbc08cea7

Jean-Marie PLACE 8de14ea8bf fichiears manquants

2022-08-03 08:40:54 +02:00

38 KiB

Raw Blame History

API pour ScoDoc 9

L'API ScoDoc permet à des applications tierces d'interroger ScoDoc. Elle offre un accès aux informations aux formats XML et JSON.

La version ScoDoc 9 a introduit une nouvelle API avec un nouveau mécanisme d'authentification. Les clients de l'ancienne API ScoDoc 7 doivent être adaptés pour fonctionner avec ScoDoc 9.

Cette API est encore incomplète: n'hésitez pas à demander de nouveaux accès en écrivant à la liste de diffusion.

L'API fournit des données JSON, sauf exception (bulletins).

Les objets ScoDoc manipulables sont identifiés par des id.

etudid: étudiant
formation_id: un programme de formation (page "programmes");
ue_id: une UE dans un programme;
matiere_id: une matière dans un programme;
module_id: un module dans un programme;
moduleimpl_id: un module réalisé dans un semestre;
formsemestre_id: un "semestre" de formation.

(pour plus de précisions, voir la doc interne)

L'URL complète est de la forme: https://scodoc.example.com/ScoDoc/api/fonction.

Configuration de ScoDoc pour utiliser l'API

Il est nécessaire de disposer d'un compte utilisateur avec les droits adéquats.

En général, il est recommandé de créer un rôle, de lui attribuer les permissions que l'on veut utiliser, puis de créer un utilisateur ayant ce rôle.

En ligne de commande, cela peut se faire comme suit (voir détail des commandes sur le guide de configuration).

# se connecter comme utilisateur scodoc
su - scodoc

# Créer un rôle
flask create-role LecteurAPI
# Lui donner les droits nécessaires: ici ScoView
flask edit-role LecteurAPI -a ScoView

# Créer un nouvel utilisateur avec ce rôle:
flask user-create lecteur_api LecteurAPI @all

# Ou bien, si on veut utiliser un compte existant:
#   associer notre rôle à un utilisateur
flask user-role lecteur_api -a LecteurAPI


# Au besoin, changer le mot de passe de l'utilisateur
# (on aura besoin de ce mot de passe dans la configuration du client d'API)
flask user-password lecteur_api
...

Si vous êtes intéressé par le développement, voir la section sur les tests unitaires de l'API.

Essais avec HTTPie

HTTPie est un client universel livre et gratuit très commode, disponible pour Windows, Linux, en ligne de commande ou interface graphique.

Exemple d'utilisation en ligne de commande et interroger votre ScoDoc pour obtenir la liste des départements:

http -a USER:PASSWORD POST  'http://localhost:5000/ScoDoc/api/tokens'

Qui affiche:

HTTP/1.1 200 OK
Content-Length: 50
Content-Type: application/json
Date: Thu, 05 May 2022 04:29:33 GMT

{
    "token": "jS7iVl1234cRDzboAfO5xseE0Ain6Zyz"
}

(remplacer USER:PASSWORD par les identifiants de votre utilisateur et adapter l'URL qui est ici celle d'un client local sur le serveur de test).

Avec ce jeton (token), on peut interroger le serveur:

http GET http://localhost:5000/ScoDoc/api/departements "Authorization:Bearer jS7iVlH1234cRDzboAfO5xseE0Ain6Zyz"

qui affiche par exemple:

HTTP/1.1 200 OK
Content-Length: 151
Content-Type: application/json
Date: Thu, 05 May 2022 05:21:33 GMT

[
    {
        "acronym": "TAPI",
        "date_creation": "Wed, 04 May 2022 21:09:25 GMT",
        "description": null,
        "id": 1,
        "visible": true
    }
]

Fonctions d'API ScoDoc 9 (work in progress)

Basé sur le ticket #149

La documentation ci-dessous concerne la future version de ScoDoc (9.3, avec parties expérimentales progressivement mises en production à partir de 9.2.12).

Accès à l'API REST

Elle sera accessible à l'adresse: https://scodoc.monsite.tld/ScoDoc/api/fonction (et aussi https://scodoc.monsite.tld/ScoDoc/api/<dept_acronyme>/fonction pour un accès avec des droits restreints au département).

Authentification

Lors de votre authentification (connection avec login et mdp) à Scodoc, il vous sera attribué un jeton (token jwt généré automatiquement) vous permettant d'utiliser l'api suivant les droits correspondant à votre session.

Pour obtenir le jeton, il faut un compte sur ScoDoc (user_nameet password). Les autorisations et rôles sont gérés exactement comme pour l'application.

Exemple avec curl (un outil en ligne de commande présent sur la plupart des systèmes, voir plus haut pour la ême chose avec la commande http):

curl -u user_name:password --request POST https://SERVEUR/ScoDoc/api/tokens

où SERVEUR est l'adresse (IP ou nom) de votre serveur. La réponse doit ressembler à ceci:

{
  "token": "LuXXxk+i74TXYZZl8MulgbiCGmVHXXX"
}

Vous trouverez dans /opt/scodoc/tests/api/exemple-api-basic.py un exemple complet en python d'interrogation de l'API.

Codes HTTP

Chaque appel à l'API donne lieu à une réponse retournant un code spécifique en fonction du résultat obtenu. L'analyse de ce code vous permet de vous assurer que la requête a été traitée avec succès.

Tous les codes >= 400 indiquent que la requête n'a pas été traitée avec succès par le serveur ScoDoc.

200 : OK.
401 : Authentification nécessaire. (jeton non précisé ou invalide)
403 : Action non autorisée pour l'utilisateur associé au jeton.
404 : Adresse incorrecte, paramètre manquant, ou objet inexistant.
500 : Erreur inconnue côté serveur.

test

Règles générales

une route s'écrit comme une suite de noms et d'identifiants
les noms token, departement, formation, formsemestre, groupe, etudiant, bulletin, absence, logo, programme, évaluation, resultat, decision désigne des types d'objets.
les noms (verbes ou groupes verbaux): set_etudiant, remove_etudiant, query, create, delete, edit, order sont des actions
les noms restants (ids, courant, long, ...) sont des options Les autre noms sont des options ou des actions
le dernier nom apparaissant sur une route donne le type d'objet renvoyé. ce nom peut apparaître au singulier ou au pluriel
- Au singulier un seul objet est renvoyé, si aucun objet n'est trouvé, retourne un 404
- Au pluriel une collection d'objets est renvoyée, si aucun obket n'est trouvé, retourne une collection vide
un type d'objet au singulier est généralement suivi immédiatement de son identifiant (unique). Exception: pour un étudiant, on peut également utiliser le NIP ou l'INE (qui ne sont pas uniques)

Départements

departements_ids

Méthode: GET
Routes: /departements_ids
Résultat: Liste des id départements (visibles ou non).
Exemple de résultat:
```
[ 1888, 999, 165 ]
```

departement

Méthode: GET
Routes:
- /departement/id/<int:dept_id>
- /departement/<string:dept>
Résultat: Un département
Exemple de résultat:

{
        "id": 1,
        "acronym": "TAPI",
        "description": null,
        "visible": true,
        "date_creation": "Fri, 15 Apr 2022 12:19:28 GMT"
}

departements

Méthode: GET
Routes: /departements
Exemple d'utilisation: /api/departements
Résultat: Liste des tous les départements (visibles ou non).
Exemple de résultat:
```
[
  { un département } 
  ...
]
```
chaque département est décrit selon departement

Étudiants d'un département

Méthode: GET
Paramètres: dept, dept_id
Routes:
- /departement/id/<int:dept_id>/etudiants
- /departement/<string:dept>/etudiants
Exemple d'utilisation: /api/departement/MMI/etudiants
Résultat: liste tous les étudiants (passés ou présents) d'un département. On peut spécifier l'acronyme du département ("MMI") ou son id (un entier). Attention, la liste peut être longue: requête coûteuse à éviter.

Exemple de résultat:

[
  {
        "civilite": "M", // M, F ou X
        "ine": "7899X61616",
        "code_nip": "F6777H88",
        "date_naissance": null,
        "email": "toto@toto.fr",
        "emailperso": null,
        "etudid": 18,
        "nom": "MOREL", // en majuscules
        "prenom": "JACQUES"
  },
  ...
]

Formsemestres d'un département

Méthode: GET
Paramètres: dept
Routes:
- /departement/id/<int:dept_id>/formsemestres_ids
- /departement/<string:dept>/formsemestres_ids
Exemple d'utilisation: /api/departement/MMI/formsemestres_ids
Résultat: Liste des id des formsemestres (passés ou présents) d'un département donné.
Exemple de résultat: [ 28, 99, 3 ]

Formsemestres en cours d'un département

Méthode: GET
Paramètres: dept
Routes:
- /departement/id/<int:dept_id>/formsemestres_courants
- /departement/<string:dept>/formsemestres_courants
Exemple d'utilisation: /api/departement/MMI/formsemestres_courants
Résultat: Liste des formsemestres en cours d'un département donné.
Exemple de résultat: departement-formsemestres-courants.json

Semestres

Formsemestre

Méthode: GET
Paramètres: formsemestre_id
Route: /formsemestre/<int:formsemestre_id>
Exemple d'utilisation: /api/formsemestre/1
Résultat: Données d'un formsemestre spécifié par son id.
Exemple de résultat:

Formsemestres

Méthode: GET
Paramètres: aucun
Query string: etape_apo, annee_scolaire, dept_acronym, dept_id
Route: `/formsemestres/query
Exemple d'utilisation: /api/formsemestres/query?etape_apo=V7HU1&annee_scolaire=2021
Résultat: Données d'un formsemestre spécifié par son id. Si plusieurs paramètres sont donnés, c'est la conjonction (ET) des critères qui est recherchée. Si aucun formsemestre ne satisfait la requ^te, une liste vide est retournée
Exemple de résultat: formsemestres.json

Bulletins d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
Route: `/formsemestres/int:formsemestre_id/bulletins
Exemple d'utilisation: /api/formsemestre/1/bulletins
Résultat: Bulletins d'un formsemestre spécifié par son id.
Exemple de résultat: formsemestre-bulletins.json

Programme d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
Route: `/formsemestres/programme
Exemple d'utilisation: /api/formsemestre/1/programme
Résultat: Liste des UEs, ressources et SAE d'un formsemestre spécifié par son id.
Exemple de résultat: formsemestre-programme.json

Etudiants d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
Route:
- /formsemestres/etudiants
- /formsemestres/etudiants/demissionnaires
- /formsemestres/etudiants/defaillants
Exemple d'utilisation: /api/formsemestre/1/etudiants
Résultat: Etudiants d'un formsemestre spécifié par son id. Liste est restreinte aux étudiants démissionnaires/défaillants si l'option correspondante est ajoutée au chemin
Exemple de résultat: formsemestre-etudiants.json

Etat des évaluations d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
Route: /formsemestres/etat_evals
Exemple d'utilisation: /api/formsemestre/1/etat_evals
Résultat: informations sur les évaluations d'un formsemestre spécifié par son id.
Exemple de résultat: formsemestre-etat-eval.json

Résultats d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
**Query string: format
Route: /formsemestres/resultats
Exemple d'utilisation: /api/formsemestre/1/resultats
Résultat: formsemestre-resultats.json

Récapitulatif par étudiant (état, groupe(s), moyennes d'UEs et de modules pour un formsemestre spécifié par son id. Par défaut les valeurs numériques sont formattées en chaînes. Si format=raw, valeurs numériques mais pas JSON compliant à cause des NaN.

Exemple de résultat:

Étudiants

`etudiants_courants`

Méthode: GET
Routes:
- /etudiants/courants
- /etudiants/courants/long
Exemple d'utilisation: /api/etudiants/courants
Résultat: Liste des étudiants inscrits dans un formsemestre actuellement en cours. Avec /long, donne tous les attributs de l'étudiants (plus lent).
Exemple de résultat: etudiants-courants.json

`etudiant`

Méthode: GET
Paramètres: etudid, nip, ine
Routes:
- /etudiant/etudid/<int:etudid> ou
- /etudiant/nip/<string:nip> ou
- /etudiant/ine/<string:ine>
Exemple d'utilisation: /api/etudiant/nip/1
Résultat: Retourne les informations sur l'étudiant correspondant à l'id passé en paramètres. Les codes INE et NIP sont uniques au sein d'un département. Si plusieurs objets étudiant ont le même code, on ramène le plus récemment inscrit.
Exemple de résultat: etudiant.json

`tous les etudiants` (TODO)

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: tous-les-etudiant.json

`etudiants`

Méthode: GET
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. Comme /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 été inscrit dans plusieurs départements, on a plusieurs objets (1 par dept.).
Exemple de résultat: etudiants.json

Cursus

etudiant_formsemestres

Méthode: GET
Paramètres: etudid, nip, ine
Routes: :
- /etudiant/etudid/<int:etudid>/formsemestres ou
- /etudiant/nip/<string:nip>/formsemestres ou
- /etudiant/ine/<string:ine>/formsemestres
Exemple d'utilisation: /etudiant/ine/1/formsemestres
Résultat: Retourne la liste des semestres qu'un étudiant a suivis, triés par ordre chronologique. (json)
Exemple de résultat: etudiant-formsemestres.json

Bulletin

Bulletin d'un formsemestre d'un étudiant

Méthode: GET
Paramètres: formsemestre_id, etudid, nip, ine
Routes: /etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin[/format][/pdf] ou /etudiant/nip/<string:nip>/formsemestre/<int:formsemestre_id>/bulletin[/format][/pdf] ou /etudiant/ine/<string:ine>/formsemestre/<int:formsemestre_id>/bulletin[/format][/pdf]

On peut spécifier le format: longou short, et indiquer si l'on veut le bulletin PDF.

Exemple d'utilisation: /etudiant/nip/1/formsemestre/1/bulletin
Résultat: Bulletin de l'étudiant dans le formsemestre. Deux versions disponibles long et short (par défaut long ajoutez /short pour la version plus courte).
Exemple de résultat: bulletin-formsemestre-etudiant.json

Groupes d'un formsemestre d'un étudiant

Méthode: GET
Paramètres: formsemestre_id, etudid, nip, ine
Routes: /etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups ou /etudiant/nip/<string:nip>/semestre/<int:formsemestre_id>/groups ou /etudiant/ine/<string:ine>/semestre/<int:formsemestre_id>/groups
Exemple d'utilisation: /etudiant/nip/1/semestre/1/groups
Résultat: Retourne la liste des groupes auxquels appartient l'étudiant dans le semestre indiqué. (json)
Exemple de résultat: groupes-formsemestre-etudiant.json

Programmes de formations

`formation`

Méthode: GET
Paramètres: formation_id
Routes: /formation/<int:formation_id>
Exemple d'utilisation: /ScoDoc/api/formation/1
Résultat: Retourne la formation d'id donné

Exemple de résultat:

{
  "id": 1,
  "acronyme": "BUT R&amp;T",
  "titre_officiel": "Bachelor technologique réseaux et télécommunications",
  "formation_code": "V1RET",
  "code_specialite": null,
  "dept_id": 1,
  "titre": "BUT R&amp;T",
  "version": 1,
  "type_parcours": 700,
  "referentiel_competence_id": null,
  "formation_id": 1
}

`formations_ids`

Méthode: GET
Routes: /formations_ids
Exemple d'utilisation: /ScoDoc/api/formations_ids
Résultat: Retourne la liste des ids de toutes les formations (tous départements)
Exemple de résultat: [17, 99, 32]

`formations`

Méthode: GET
Routes: /formations
Exemple d'utilisation: /ScoDoc/api/formations
Résultat: Retourne la liste de toutes les formations (tous départements)
Exemple de résultat: formations.json

Export programme

`formation export`

Méthode: GET
Paramètres: formation_id, export_ids (False par défaut. Ajouter /with_ids pour le passer à True)
Routes:
- /formation/export/<int:formation_id>
- /formation/export/<int:formation_id>/with_ids
Exemple d'utilisation: /ScoDoc/api/formation/formation_export/1
Résultat: Retourne la formation, avec UE, matières, modules
Exemple de résultat: formation-export.json

`referentiel_competences`

Méthode: GET
Paramètres: formation_id
Routes: /formation/<int:formation_id>/referentiel_competences
Exemple d'utilisation: api/formation/1/referentiel_competences
Résultat: Le référentiel de compétences d'une formation donnée (json). (pas toujours présent)
Exemple de résultat: formation-referentiel_competences.json

XXX obtenir la liste des référentiels ?

Formsemestres

Les sessions de formation (qu'elles durent une année ou un mois) sont représentées par les formsemestre.

`formsemestre`

Méthode: GET
Paramètres: formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>
Exemple d'utilisation: /ScoDoc/api/formsemestre/1
Résultat: Retourne l'information sur le formsemestre correspondant au formsemestre_id

Exemple de résultat:

{
  "annee_scolaire" : "2021 - 2022",
  "block_moyennes": false,
  "bul_bgcolor": "white",
  "bul_hide_xml": false,
  "date_debut_iso": "2021-09-01",
  "date_debut": "01/09/2021",
  "date_fin_iso": "2022-08-31",
  "date_fin": "31/08/2022",
  "dept_id": 1,
  "elt_annee_apo": null,
  "elt_sem_apo": null,
  "ens_can_edit_eval": false,
  "etat": true,
  "formation_id": 1,
  "formsemestre_id": 1,
  "gestion_compensation": false,
  "gestion_semestrielle": false,
  "id": 1,
  "modalite": "FI",
  "resp_can_change_ens": true,
  "resp_can_edit": false,
  "responsables": [
    12,
    42
  ],
  "scodoc7_id": null,
  "semestre_id": 1,
  "titre_court": "BUT MMI",
  "titre_num": "Semestre test semestre 1",
  "titre": "Semestre test",
  "session_id": "MMI-BUT-FI-S1-2021",
}

`formsemestre_apo`

Méthode: GET
Paramètres: etape_apo
Routes: /formsemestre/apo/<string:etape_apo>
Exemple d'utilisation: /ScoDoc/api/formsemestre/1
Résultat: Retourne les informations sur les formsemestres

Exemple de résultat:

[ { formsemestre comme ci-dessus }, ... ]

Note sur les identifiants de formsemestre

Le session_id peut être utilisé pour identifier de façon prévisible et (presque) unique un formsemestre) dans un établissement, ce qui est utile notamment pour interfacer ScoDoc à d'autres logiciels (par exemple gestion d'emplois du temps ou de services d'enseignement). Cet identifiant est constitué des informations suivantes:

Département (RT, GEII, INFO...) (acronyme en majuscules)
Nom parcours: BUT, LP, ... (défini au niveau du parcours dans ScoDoc = NAME)
Modalité: FI, FC, FA
"Spécialité": S1 (ou S1D pour les semestres décalés), ou le code_specialite si pas de semestres. Le code spécialité est un champ (libre) dans la "formation" (le programme pédagogique).
- Année: année de début de l'année scolaire correspondante (2014 pour une session appartenant à l'année scolaire 2014-2015, même si elle commence en mars 2015).

Exemple: INFO-DUT-FI-S1-2014 équivaut à un semestre S1 d'un DUT informatique de 2014 en formation initiale (FI)

Étudiants inscrits et bulletins

etudiants d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id, etat (par défaut égal à "I" pour les étudiants inscrits)
Routes: /formsemestre/<int:formsemestre_id>/etudiants XXX voir si filtrage par état (dem, def, ...)
Résultat: les étudiants inscrits à ce semestres XXX préciser état (DEM, DEF))

* `bulletins d'un formsemestre`

Méthode: GET
Paramètres: formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>/bulletins
Exemple d'utilisation: /ScoDoc/api/formsemestre/1/bulletins
Résultat: tous les bulletins d'un formsemestre.
Exemple de résultat

etat_evals d'un formsemestre

Méthode: GET
Paramètres: formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>/etat_evals
Exemple d'utilisation: /ScoDoc/api/formsemestre/1/etat_evals
Résultat: Retourne les informations sur l'état des évaluations d'un semestre donné
Exemple de résultat: formsemestre-etat_evals.json

`jury` (non implémentée)

Méthode: GET
Paramètres: formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>/jury
Exemple d'utilisation: /ScoDoc/api/formsemestre/1/jury
Résultat: Retourne le récapitulatif des décisions jury
Exemple de résultat:
```
XXX A COMPLETER
```

Programme d'un formsemestre

UE et modules

Méthode: GET
Paramètres: dept, formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>/programme
Exemple d'utilisation: /ScoDoc/api/formsemestre/1/programme
Résultat: Retourne la liste des UEs, modules, ressources et SAE d'un semestre.
Exemple de résultat: formsemestre-programme.json

Module d'un formsemestre

Le moduleimpl est la mise en place d'un module dans un formsemestre (avec son responsable et ses enseignants).

`moduleimpl`

Méthode: GET
Paramètres: moduleimpl_id
Routes: /moduleimpl/<int:moduleimpl_id>
Exemple d'utilisation: /ScoDoc/api/formation/moduleimpl/1
Résultat: Retourne la liste des moduleimpl
Exemple de résultat: moduleimpl.json

Groupes et partitions

L'ensemble des étudiants d'un semestre peut être réparti selon une ou plusieurs partitions (types de groupes). Chaque partition est constituée d'un nombre quelconque de groupes d'étudiants.

`partitions`

Méthode: GET
Paramètres: formsemestre_id
Routes: /formsemestre/<int:formsemestre_id>/partitions
Exemple d'utilisation: /ScoDoc/api/formsemestre/911/partitions
Résultat: La liste de toutes les partitions d'un formsemestre.
Exemple de résultat: formsemestre-partitions.json

`partition`

Méthode: GET
Paramètres: partition_id
Routes: /partition/<int:partition_id>
Exemple d'utilisation: /ScoDoc/api/partition/1963
Résultat: La description d'une partition (y compris la liste de ses groupes).
Exemple de résultat: partition.json

`partition-edit`

Méthode: POST
Paramètres: partition_id
Data: { partition_name : <string> }
Routes: /partition/<int:partition_id>/edit
Exemple d'utilisation: /ScoDoc/api/partition/2047/edit

{ "partition_name" : "PART4" }

Résultat: Renomme une partition
Exemple de résultat

`partition-delete`

Méthode: POST
Paramètres: partition_id
Routes: /partition/<int:partition_id>/delete
Exemple d'utilisation: /ScoDoc/api/partition/2047/delete
Résultat: Supprime une partition.
**Exemple de résultat

`formsemestre-partition-create`

Méthode: POST
Paramètres: formsemestre_id
Data: { "partition_name" : <string> }
Routes: /formsemestre/<int:formsemestre_id>/partition/create

{ "partition_name" : "PART" }

Exemple d'utilisation: /ScoDoc/api/formsemestre/944/partition/create
Résultat: Crée une nouvelle partition dans un formsemestre.
Exemple de résultat:

`formsemestre-partition-order`

Méthode: POST
Paramètres: formsemestre_id
Data: [ <int:partition_id1>, <int:partition_id2>, ... ]
Routes: /formsemestre/<int:formsemestre_id>/partition/order
Exemple d'utilisation: /ScoDoc/api/formsemestre/944/partition/order

[ 2048, 2054 ]

Résultat: Spécifie l'ordre des partitions d'un formsemestre.
Exemple de résultat:

`partition-groups-order`

Méthode: POST
Paramètres: partition_id
Data: [ <int:group_id1>, <int:group_id2>, ... ]
Routes: /partition/<int:partition_id>/groups/order
Exemple d'utilisation: /ScoDoc/api/partition/1962/groups/order

[ 4383, 4379, 4380, 4381, 4382, 4384 ]

Résultat: Spécifie l'ordre des groupes d'une partition.
Exemple de résultat:

`group-etudiants`

Méthode: GET
Paramètres: group_id
Routes: /group/<int:group_id>/etudiants
Exemple d'utilisation: /ScoDoc/api/group/1/etudiants
Résultat: Retourne la liste des étudiants dans un groupe.
Exemple de résultat: group-etudiants.json

`groups-etudiants-query`

Méthode: GET
Paramètres: group_id
Query string: etat ('I', 'D' ou 'DEF')
Routes: /group/<int:group_id>/etudiants/query
Exemple d'utilisation: /ScoDoc/api/group/1/etudiants/query?etat=I
Résultat: Retourne la liste des étudiants dans un groupe.
Exemple de résultat: group-etudiants-query.json

`groups-set_etudiant`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: group_id, etudid
Routes: /group/<int:group_id>/set_etudiant/<int:etudid>
Exemple d'utilisation: /ScoDoc/api/group/4085/set_etudiant/12108
Résultat: Affecte un étudiant dans un groupe.
Exemple de résultat

`groups-remove_etudiant`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: group_id, etudid
Routes: /group/<int:group_id>/remove_etudiant/<int:etudid>
Exemple d'utilisation: /ScoDoc/api/group/4085/remove_etudiant/12108
Résultat: Retire un étudiant d'un groupe.
Exemple de résultat

`partition-group-create`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: partition_id
Data: { group_name : <string> }
Routes: /partition/<int:partition_id>/create
Exemple d'utilisation: /ScoDoc/api/partition/1962/create

{ "group_name" : "A" }

Résultat: Crée un groupe dans une partition.
Exemple de résultat

`partition-group-delete`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: group_id
Routes: /group/<int:group_id>/delete
Exemple d'utilisation: /ScoDoc/api/group/4581/delete
Résultat: Supprime un groupe.
Exemple de résultat

`partition-remove_etudiant`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: partition_id
Routes: /partition/<int:partition_id>/remove_etudiant/<int:etudid>
Exemple d'utilisation: /ScoDoc/api/partition/1962/remove_etudiant/12107
Résultat: Reture un étudiant des groupes de la partition.
Exemple de résultat

`group-edit`

Méthode: POST
Permission: ScoEtudChangeGroups*
Paramètres: group_id
Data: { group_name : <string> }
Routes: /group/<int:group_id>/edit
Exemple d'utilisation: /ScoDoc/api/group/4581/edit

{ "group_name" : "nouveau" }

Résultat: Renomme un groupe.
Exemple de résultat

Évaluations

`evaluations`

Méthode: GET
Paramètres: moduleimpl_id
Routes: /evaluations/<int:moduleimpl_id>
Exemple d'utilisation: /ScoDoc/api/evaluations/1
Résultat: Retourne la liste des évaluations à partir de l'id d'un moduleimpl (quel que soit leur statut).

Exemple de résultat:

[
  {
    "apresmidi": 0
    "coefficient": 1,
    "description": "Compte-rendu de TP 2",
    'date_debut': '2022-05-13T11:30:00',
    'date_fin': '2022-05-13T12:30:00',
    "evaluation_id": 1,
    "evaluation_type": 0,
    "id": 1,
    "jour": "13/05/2022",
    "matin": 1,
    "moduleimpl_id": 1,
    "note_max": 20,
    "numero": 0,
    "publish_incomplete": false,
    "poids" : {1896: 0.0, 1897: 2.3, 1898: 4.2},
    "visibulletin": true,
  }
]

`evaluations/notes`

Méthode: GET
Paramètres: evaluation_id
Routes: /evaluations/eval_notes/<int:evaluation_id>
Exemple d'utilisation: /ScoDoc/api/evaluations/notes/1
Résultat: Retourne la liste des notes d'une évaluation
Exemple de résultat: XXX à revoir (à spécifier/reprendre implémentation XXX was eval_notes)

Absences

Remarques, les dates sont au format iso yyyy-mm-dd. Les dates de fin ne sont pas incluses. Et demi_journee= 2 si journée complète, =1 si uniquement le matin, =0 si uniquement l'après-midi.

`absences`

Méthode: GET
Paramètres: etudid, nip, ine
Routes: /absences/etudid/<int:etudid>
Exemple d'utilisation: /ScoDoc/api/absences/etudid/123456
Résultat: Retourne la liste des absences d'un étudiant donné

Exemple de résultat:

[
  {
    "jour": "2022-04-15",
    "matin": true,
    "estabs": true,
    "estjust": true,
    "description": "Retard bus",
    "begin": "2022-04-15 08:00:00",
    "end": "2022-04-15 11:59:59"
  },
  {
    ...
  }
]

`absences/just`

Méthode: GET
Paramètres: etudid
Routes: /absences/etudid/<int:etudid>/just
Exemple d'utilisation: /ScoDoc/api/absences/etudid/1/just
Résultat: Retourne la liste des absences justifiées d'un étudiant donné

Exemple de résultat:

[
  {
    "jour": "2022-04-15",
    "matin": true,
    "estabs": true,
    "estjust": true,
    "description": "Retard bus",
    "begin": "2022-04-15 08:00:00",
    "end": "2022-04-15 11:59:59"
  },
  {
    ...
  }
]

`abs_groupe_etat`

Méthode: GET
Paramètres: group_ids, date_debut, date_fin,
Routes: /absences/abs_group_etat/<int:group_id> ou /absences/abs_group_etat/group_id/<in:group_id>/date_debut/<date:date_debut>/date_fin/<date:date_fin>
Exemple d'utilisation: /ScoDoc/api/absences/abs_group_etat/1
Résultat: Liste des absences d'un groupe entre deux dates.
Exemple de résultat:
```
XXX A COMPLETER XXX with_boursier ??
```
XXX ajouter méthode(s) de set abs ```

Jury

`jury_preparation`

Méthode: GET
Paramètres: formsemestre_id
Routes: /jury/formsemestre/<int:formsemestre_id>/preparation_jury
Exemple d'utilisation: /ScoDoc/api/jury/formsemestre/1/preparation_jury
Résultat: Retourne la feuille de préparation du jury
Exemple de résultat:
```
XXX A COMPLETER
```

`jury_decisions`

Méthode: GET
Paramètres: formsemestre_id
Routes: /jury/formsemestre/<int:formsemestre_id>/decisions_jury
Exemple d'utilisation: /ScoDoc/api/jury/formsemestre/1/decisions_jury
Résultat: Retourne les décisions du jury suivant un formsemestre donné
Exemple de résultat:
```
XXX A COMPLETER
```

Logos

`liste des logos globaux`

Méthode: GET
Paramètres: format (json, xml), json par défaut
Route : /ScoDoc/api/logos
Exemple d'utilisation : /ScoDoc/api/logos?format=xml
Résultat : Liste des noms des logos définis pour le site scodoc.
Exemple de résultat: ['header', 'footer', 'custom']

XXX vérifier si on supporte XML et pour qui ?

`récupération d'un logo global`

Méthode: GET
Paramètres : Aucun
Route: /logos/<string:nom>
Exemple d'utilisation : /ScoDoc/api/logos/header
Résultat : l'image (format png ou jpg)

`logo d'un département`

Méthode: GET
Paramètres: format (json, xml)
Route : /departements/<string:dept>/logos
Exemple d'utilisation : /ScoDoc/api/departements/MMI/logos
Résultat : Liste des noms des logos définis pour le département visé.
Exemple de résultat: ['footer', 'signature', 'universite']

`récupération d'un logo global`

Méthode: GET
Paramètres : Aucun
Route: /departements/<string:dept>/logos/<string:nom>
Exemple d'utilisation: /ScoDoc/api/departements/MMI/logos/header
Résultat : l'image (format png ou jpg)

En savoir plus

Voir exemples d'utilisation de l'API en Python, dans tests/api/.

Fonctions de l'API ScoDoc 7 portées en ScoDoc 9

L'ancienne API ScoDoc 7 est décrite ici: ScoDocAPI

Afin de garantir l'interopérabilité avec les clients ScoDoc 7 (ENT, etc), les fonctions suivantes sont disponibles avec le mécanisme d'authentification basique de ScoDoc 7. Elles sont considérées comme obsolètes ("deprecated") et disparaitront en juillet 2022.

Certaines ont plusieurs "routes" (URl), car ScoDoc 7 tolérait divers accès.

Absences/XMLgetBilletsEtud (deviendra api/absences/billets/etud/ etudid>)
Absences/AddBilletAbsence (deviendra api/absences/billet/add)
Absences/XMLgetAbsEtud (deviendra api/absences/ etudid>, en json)
Notes/evaluation_listenotes (non existante en ScoDoc9, trop complexe)
Notes/formsemestre_id (deviendra api/formsemestre)
Notes/formsemestre_bulletinetud (deviendra api/etud/<etudid>/bul/<formsemestre_id>)
Notes/XMLgetFormsemestres (non existante en ScoDoc9, redondant avec api/formsemestre ?)
etud_info ou XMLgetEtudInfos ou Absences/XMLgetEtudInfos ou Notes/XMLgetEtudInfos (deviendra /api/etud/<etudid>)
groups_view (deviendra groups)

Les routes ci-dessus s'entendent à partir de l'URL de base de votre ScoDoc, c'est à dire https://votre.site.fr/ScoDoc/<dept>/Scolarite/, et répondent en GET et en POST.

Note:

Absences/listeBillets est un formulaire et ne fait pas partie de l'API.

38 KiB Raw Blame History

API pour ScoDoc 9

Configuration de ScoDoc pour utiliser l'API

Essais avec HTTPie

Fonctions d'API ScoDoc 9 (work in progress)

Accès à l'API REST

Authentification

Codes HTTP

Règles générales

Départements

departements_ids

departement

departements

Étudiants d'un département

Formsemestres d'un département

Formsemestres en cours d'un département

Semestres

Formsemestre

Formsemestres

Bulletins d'un formsemestre

Programme d'un formsemestre

Etudiants d'un formsemestre

Etat des évaluations d'un formsemestre

Résultats d'un formsemestre

Étudiants

etudiants_courants

etudiant

tous les etudiants (TODO)

etudiants

Cursus

etudiant_formsemestres

Bulletin

**Bulletin d'un formsemestre d'un étudiant **

Groupes d'un formsemestre d'un étudiant

Programmes de formations

formation

formations_ids

formations

Export programme

formation export

referentiel_competences

Formsemestres

formsemestre

formsemestre_apo

Note sur les identifiants de formsemestre

Étudiants inscrits et bulletins

etudiants d'un formsemestre

* bulletins d'un formsemestre

etat_evals d'un formsemestre

jury (non implémentée)

Programme d'un formsemestre

UE et modules

Module d'un formsemestre

moduleimpl

Groupes et partitions

partitions

partition

partition-edit

partition-delete

formsemestre-partition-create

formsemestre-partition-order

partition-groups-order

group-etudiants

groups-etudiants-query

groups-set_etudiant

groups-remove_etudiant

partition-group-create

partition-group-delete

partition-remove_etudiant

group-edit

Évaluations

evaluations

evaluations/notes

Absences

absences

absences/just

abs_groupe_etat

Jury

jury_preparation

jury_decisions

38 KiB

Raw Blame History

`etudiants_courants`

`etudiant`

`tous les etudiants` (TODO)

`etudiants`

Bulletin d'un formsemestre d'un étudiant

`formation`

`formations_ids`

`formations`

`formation export`

`referentiel_competences`

`formsemestre`

`formsemestre_apo`

* `bulletins d'un formsemestre`

`jury` (non implémentée)

`moduleimpl`

`partitions`

`partition`

`partition-edit`

`partition-delete`

`formsemestre-partition-create`

`formsemestre-partition-order`

`partition-groups-order`

`group-etudiants`

`groups-etudiants-query`

`groups-set_etudiant`

`groups-remove_etudiant`

`partition-group-create`

`partition-group-delete`

`partition-remove_etudiant`

`group-edit`

`evaluations`

`evaluations/notes`

`absences`

`absences/just`

`abs_groupe_etat`

`jury_preparation`

`jury_decisions`

`liste des logos globaux`

`récupération d'un logo global`

`logo d'un département`

`récupération d'un logo global`