iziram/DocAssiduites
1
0
Fork 0
forked from ScoDoc/DocScoDoc
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a12c4fe885
DocAssiduites/docs/ScoDoc9API.md

25 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 APIView
flask edit-role LecteurAPI -a APIView

# 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
...

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

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):

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 nos serveurs.

  • 200 : OK.
  • 400 : Paramètre manquant, ou valeur incorrecte.
  • 401 : Authentification nécessaire. (jeton non précisé ou invalide)
  • 403 : Action non autorisée. (crédits épuisés, URL non autorisée, etc)
  • 404 : Page inaccessible. (URL inconnue / impossible d'accéder à l'adresse)
  • 406 : Le JSON indiqué en données POST n'est pas valide.
  • 408 : Dépassement du temps maximal autorisé pour l’audit.
  • 500 : Erreur inconnue, contactez-nous.
  • 503 : L'API est momentanément indisponible, réessayez dans quelques minutes.

Départements

  • departements

    • Méthode: GET
    • Routes: /departements
    • Exemple d'utilisation: /api/departements
    • Résultat: Liste des id de départements.
    • Exemple de résultat: [1, 2, 3, ...]

  • liste_etudiants

    • Méthode: GET
    • Paramètres: dept, formsemestre_id
    • Routes: /departements/<string:dept>/etudiants/liste ou /api/departements/<string:dept>/etudiants/liste/<int:formsemestre_id>
    • Exemple d'utilisation: /api/departements/MMI/etudiants/liste
    • Résultat: liste des étudiants d'un département, par défaut, ou d'un semestre si renseigné

  • liste_semestres_courant XXX à revoir

    • Méthode: GET
    • Paramètres: dept
    • Routes: /departements/<string:dept>/semestres_courants
    • Exemple d'utilisation: /api/departements/MMI/semestres_courants
    • Résultat: Liste des semestres actifs d'un département donné. (réponse sous format json)

  • referentiel_competences

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

  • XXX obtenir la liste des référentiels

  • semestre_index

    • Méthode: GET
    • Paramètres: dept, formsemestre_id
    • Routes: /departements/<string:dept>/formsemestre/<string:formsemestre_id>/programme
    • Exemple d'utilisation: api/departements/MMI/formsemestre/1/programme
    • Résultat: Retourne la liste des Ues, ressources et SAE d'un semestre (json).

Etudiants

  • etudiants_courant

    • Méthode: GET
    • Routes: /etudiants/courant
    • Exemple d'utilisation: /api/etudiants/courant
    • Résultat: Retourne la liste des étudiants courant (json).
    • Exemple de résultat: 
      {
        {
          "civilite": "X",
          "code_ine": null,
          "code_nip": null,
          "date_naissance": null,
          "email": null,
          "emailperso": null,
          "etudid": 18,
          "nom": "MOREL",
          "prenom": "JACQUES"
        },
        {
          "civilite": "X",
          "code_ine": null,
          "code_nip": null,
          "date_naissance": null,
          "email": null,
          "emailperso": null,
          "etudid": 19,
          "nom": "FOURNIER",
          "prenom": "ANNE"
        },
 ...
}

  • etudiant

    • Méthode: GET
    • Paramètres: etudid, nip, ine
    • Routes: /etudiant/etudid/<int:etudid> ou /etudiant/nip/<int:nip> ou /etudiant/ine/<int:ine>
    • Exemple d'utilisation: /api/etudiant/nip/1
    • Résultat: Retourne les informations de l'étudiant correspondant à l'id passé en paramètres. (json)
    • Exemple de résultat: 
      {
        "civilite": "X",
        "code_ine": null,
        "code_nip": null,
        "date_naissance": null,
        "email": null,
        "emailperso": null,
        "etudid": 18,
        "nom": "MOREL",
        "prenom": "JACQUES"
}

  • etudiant_formsemestres

    • Méthode: GET
    • Paramètres: etudid, nip, ine
    • Routes: : /etudiant/etudid/<int:etudid>/formsemestres ou /etudiant/nip/<int:nip>/formsemestres ou /etudiant/ine/<int: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)

  • etudiant_bulletin_semestre

    • Méthode: GET
    • Paramètres: formsemestre_id, etudid, nip, ine
    • Routes: /etudiant/etudid/<int:etudid>/formsemestre/<int:formsemestre_id>/bulletin ou /etudiant/nip/<int:nip>/formsemestre/<int:formsemestre_id>/bulletin ou /etudiant/ine/<int:ine>/formsemestre/<int:formsemestre_id>/bulletin
    • Exemple d'utilisation: /etudiant/nip/1/formsemestre/1/bulletin
    • Résultat: Retourne le bulletin d'un étudiant en fonction de son id et d'un semestre donné. (json)

  • etudiant_groups

    • Méthode: GET
    • Paramètres: formsemestre_id, etudid, nip, ine
    • Routes: /etudiant/etudid/<int:etudid>/semestre/<int:formsemestre_id>/groups ou /etudiant/nip/<int:nip>/semestre/<int:formsemestre_id>/groups ou /etudiant/ine/<int: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: 
      [
          {
            "partition_id": 1,
            "id": 1,
            "formsemestre_id": 1,
            "partition_name": "TD",
            "numero": 0,
            "bul_show_rank": false,
            "show_in_lists": true,
            "group_id": 1,
            "group_name": B
          },
          {
            "partition_id": 2,
            "id": 2,
            "formsemestre_id": 1,
            "partition_name": "TP",
            "numero": 1,
            "bul_show_rank": false,
            "show_in_lists": true,
            "group_id": 2,
            "group_name": "A"
          },
          ...
]

Programmes de formations

  • formations

    • Méthode: GET
    • Paramètres: formation_id (optionnel, si absent, liste toutes les formations)
    • Routes: /api/formations ou /api/formations/<int:formation_id>
    • Exemple d'utilisation: /api/formations ou /api/formations/1
    • Résultat: Liste des formations.
    • Exemple de résultat: [formation_1, formation_2, formation_3, ...]
    • TODO: détailler le contenu publié

  • formation_export

    • Méthode: GET
    • Paramètres: formation_id, export_ids (par défaut "faux")
    • Routes: /api/formations/formation_export/<int:formation_id>
    • Exemple d'utilisation: /api/formations/formation_export/596 ou /api/formations/formation_export/596?format=xml&export_ids=1
    • Résultat: La formation, avec UE, matières, modules (un arbre).
    • Exemple de résultat:
  {
    "nom": "formation",
    "UE": "ue",
    "matieres": [
                  "matiere_1": "maths",
                  "matiere_2": "anglais",
                  ...
                  ],
    "modules": ...
  }

UE

  • UEs
    • Méthode: GET
    • Paramètres: dept, ̀semestre
    • Routes: /api/departements/<str:dept>/formations/programme/<str:semestre>
    • Exemple d'utilisation: ̀/api/departements/MMI/formations/programme/INFO-DUT-FI-S1-2014
    • Résultat: Liste des UEs, ressources et SAE d'un semestre

Semestres de formation

Les sessions de formation (dénommées "semestres" même si elles durent une année ou un mois) sont représentées par les formsemestre.

  • formsemestre
    • Méthode: GET
    • Paramètres: formsemestre_id ou etape_apo, format(json ou xml)
    • Routes: /api/formations/formsemestre/<int:formsemestre_id>, /api/formsemestre/apo/<etape_apo>
    • Exemple d'utilisation: /api/formations/formsemestre/12
    • Résultat: Informations sur le(s) formsemestre(s).
    • Exemple de résultat:
[ 
  {
  "annee_scolaire": "2022 - 2023",
  "date_debut": "2022-09-01",
  "date_fin": "2023-02-02",
  "modalite": "FI",
  "periode": 1,
  "semestre_idx_txt": "S3",
  "semestre_idx" : 3,
  "session_id" : "GEII-BUT-FI-S3-2022",
  "titre_annee": "BUT Génie Electrique et Informatique Industrielle semestre 3 FI 2021-2022"
  "titre_num": "BUT Génie Electrique et Informatique Industrielle semestre 3",
  "titre": "BUT Génie Electrique et Informatique Industrielle",
  "parcours_type": XXX type de parcours
  'formation_id": 87,
  }
]

Note sur les identifiants de sessions

Le session_id peut être utilisé pour identifier de façon prévisible et (presque) unique une session 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...) (= paramètre DeptName, 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) nouveau dans la "formation" (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)

Modules de formation

Les moduleimpl sont les modules d'un semestre, ou les ressources, ou les SAÉs. On peut récupérer soit un module par son id, soit la listes des modules d'un semestre.

  • moduleimpl
    • Méthode: GET
    • Paramètres: formsemestre_id ou moduleimpl_id
    • Routes: /api/formations/moduleimpl/<int:moduleimpl_id> ou /api/formations/moduleimpl/<int:moduleimpl_id>/formsemestre/<int:formsemestre_id>
    • Résultat: liste de moduleimpl
    • Exemple de résultat: TODO

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.

  • partition
    • Méthode: GET
    • Paramètres: formsemestre_id
    • Routes: /api/partitions/<int:formsemestre_id>
    • Exemple d'utilisation: /api/partition/48
    • Résultat: La liste de toutes les partitions d'un formsemestre.
    • Exemple de résultat:
[
   {
      "formsemestre_id":"12781",
      "partition_id":"23840",
      "partition_name":"TD""group":[
         {
            "formsemestre_id":"12781",
            "partition_id":"23840",
            "group_name":"A",
            "group_id":"23841",
            "partition_name":"TD"
         },
         {
            "formsemestre_id":"12781",
            "partition_id":"23840",
            "group_name":"B",
            "group_id":"23843",
            "partition_name":"TD"
         }
      ]
   },
   {
      "formsemestre_id":"12781",
      "partition_id":"23941",
      "partition_name":"TP""group":[
         {
            "..."
         },
         "..."
      ]
   },
   {
      "formsemestre_id":"12781",
      "partition_id":"22833",
      "partition_name":null"group":[
         {
            "formsemestre_id":"12781",
            "partition_id":"22833",
            "group_name":null,
            "group_id":"G22834",
            "partition_name":null
         }
      ]
   }
]
  • groups
    • Méthode: GET
    • Paramètres: formsemestre_id ou group_ids (peut être répété), with_codes=0|1, all_groups=0|1, etat=None|I
    • Routes: api/partitions/formsemestre/<int:formsemestre_id>/groups/group_ids?with_codes=0|1&all_groups=0|1&etat=None|I
    • Exemple d'utilisation: api/partitions/formsemestre/213/groups/123?with_codes=1
    • Résultat: Liste des étudiants dans un groupe.
    • Exemple de résultat au format XML: (avec with_codes=1)
<group_list origin="" caption="soit 21 étudiants inscrits et 2 démissionaires." id="gt_711068">

    <etud>
        <nom value="TOTO"/>
        <prenom value="Marc"/>
        <etat value="I"/>
        <email value="toto@example.com"/>
        <etudid value="9876"/>
        <code_nip value="987654"/>
        <code_ine value=""/>
    </etud>

    <etud>
        <nom value="ALVIS SAMOS"/>
        <prenom value="NATHALIE"/>
        <etat value="I"/>
        <email value="xxx@example.com"/>
        <etudid value="12345"/>
        <code_nip value="12345678"/>
        <code_ine value=""/>
    </etud>
</group_list>
  • Exemple de résultat au format JSON:
[
  {
    "etat":"I",
    "emailperso":null,
    "prenom":"Dalil",
    "nom_disp":"CLINTO",
    "email":"xxx@example.com",
    "62029":"A",
    "62032":null,
    "62031":"G1",
    "62030":"A1"
  },
  {  
    "etat":"I",
    "emailperso":null,
    "prenom":"Georges",
    "nom_disp":"BUSH",
    "email":"bush@example.com",
    "62029":"A",
    "62032":null,
    "62031":"G1",
    "62030":"A1"
  },
  ...
]

  • set_groups

    • Méthode: POST
    • Paramètres: partition_id, groups, groups_to_delete, groups_to_create
    • Routes: /api/partitions/set_groups?partition_id=<int:partition_id>&groups=<int:groups>&groups_to_delete=<int:groups_to_delete>&groups_to_create=<int:groups_to_create>
    • Exemple d'utilisation: /api/partitions/set_groups?partition_id=65&groups=77&groups_to_delete=8&groups_to_create=4
    • Résultat: Set les groups.

    TODO: à changer, passer les paramètres dans le corps de la requête

Bulletins de notes

  • evaluations

    • Méthode: GET
    • Paramètres: moduleimpl_id
    • Routes: /api/evaluations/<int:moduleimpl_id>
    • Exemple d'utilisation: /api/evaluations/54
    • Résultat: Liste des évaluations à partir de l'id d'un moduleimpl.
    • Exemple de résultat: [eval_1, eval_2, eval_3, ...]

  • evaluation_notes

    • Méthode: GET
    • Paramètres: evaluation_id
    • Routes: /api/evaluations/eval_notes/<int:evaluation_id>
    • Exemple d'utilisation: /api/evaluations/eval_notes/24
    • Résultat: Liste des notes à partir de l'id d'une évaluation donnée.
    • Exemple de résultat:
[
  {
    "84": "13",
    "85": "15",
    "86": "9",
    ...
  }
]
  • evaluation_set_notes
    • Méthode: POST
    • Paramètres: eval_id, etudid, note
    • Routes: /api/evaluations/eval_set_notes?eval_id=<int:eval_id> etudid=<int etudid>&note=<int:note>
    • Exemple d'utilisation: /api/evaluations/eval_set_notes?eval_id=6 etudid=456&note=15
    • Résultat: Set les notes d'une évaluation pour un étudiant donné. TODO vérifier et passer les valeurs dans le corps.

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, abs_just_only, format, abs_just_only (spécifie si on veut les absences justifiées ou non).
    • Routes: /api/absences/<int:etudid>
    • Exemple d'utilisation: /api/absences/54
    • Résultat: Liste des absences d'un étudiant donné.
    • Exemple de résultat: {jour: "2021-02-10", ampm: "0", description: "M2202", } (ampm vaut 1 le matin et 0 l'après-midi).

  • abs_signale

    • Méthode: POST
    • Paramètres: date_debut, date_fin, module_impl_id=None, demi_journee=2, estjust=False, description, etudid
    • Body de la requête: date_debut=date_debut&date_fin=date_fin&demi_journee=demi_journee&description=description&etudid=<int:etudid>
    • Exemple d'utilisation: date_debut=2015-02-01&date_fin=2015-02-03&demi_journee=4&description=""&etudid=874
    • Résultat: html

  • abs_annule

    • Méthode: POST
    • Paramètres: date_debut, date_fin, demi_journee, etudid
    • Body de la requête: date_debut=date_debut&date_fin=date_fin&demi_journee=demi_journee&etudid=<int:etudid>
    • Exemple d'utilisation: date_debut=2004-05-03&date_fin=2004-06-07&demi_journee=2&etudid=451
    • Résultat: html

  • abs_annule_justif

    • Méthode: POST
    • Paramètres: context, date_debut, date_fin, demi_journee
    • Body de la requête: context=context&date_debut=date_debut&date_fin=date_fin&demi_journee=demi_journee
    • Exemple d'utilisation: context=malade&date_debut=2020-01-05&date_fin=2020-01-06&demi_journee=1
    • Résultat: html

  • abs_groupe_etat

    • Méthode: GET
    • Paramètres: group_ids, date_debut, date_fin, with_boursier=True, format=html
    • Routes: /api/absences/abs_group_etat/?group_ids=group_ids&date_debut=date_debut&date_fin=date_fin
    • Exemple d'utilisation: /api/absences/abs_group_etat/?group_ids=45&date_debut=2019-01-30&date_fin=2019-02-30
    • Résultat: Liste des absences d'un ou plusieurs groupes entre deux dates.
    • Exemple de résultat: si format="json" cela donne: 
       [ 
   {
     "boursier": "N",
     "nbabs": "9",
     "nbabsjust": "2",
     "nbabsnonjust": "7",
     "nbjustifs_noabs": "0",
     "nomprenom": "Mme Poisson Dodouce", 
     "etudid": "12345"
   }, 
   ... 
 ]

Logos

  • liste des logos globaux

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

  • récupération d'un logo global

    • Méthode: GET
    • Paramètres : Aucun
    • Route: /api/logos/<str:nom>
    • Exemple d'utilisation : /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 : /api/departements/<str:dept>/logos
    • Exemple d'utilisation : /api/MMI/logos
    • Résultat : Liste 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: /api/departements/<str:dept>/logos/<str:nom>
    • Exemple d'utilisation: /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.