L'API Rest

Accéder à la racine de l'API

l'API permet principalement de récupérer la liste des formations, avec ou sans critère de recherche, le détail d'une formation, la liste des experts, le détail d'un expert.

Les données sont distribuées aux formats json, jsonp ou xml. Dans le navigateur, les données sont visualisées au format json par défaut. Pour accéder aux données au format xml, il faut rajouter ".xml" à l'url. De même pour les formats json et jsonp

Exemple d'url d'accès aux données

  • Liste des experts au format json    http://maimosine-info.imag.fr/api/experts
  • Liste des experts au format xml    http://maimosine-info.imag.fr/api/experts/.xml ou http://maimosine-info.imag.fr/api/experts/?format=xml
  • Liste des 20 dernières formations    http://maimosine-info.imag.fr/api/trainings/?page_size=20
  • Détail de la formation d'identifiant 25    http://maimosine-info.imag.fr/api/trainings/25
  • Les formations futures (date de début >= date du jour)    http://maimosine-info.imag.fr/api/trainings/futur
  • Formations qui ont comme mot clef ou comme domaine 'modélisation' ou 'calcul' ou 'HPC'    http://maimosine-info.imag.fr/api/trainings/select/?keywords=modelisation,calcul,hpc
  • Formations qui ont comme mot clef ou comme domaine 'traitement du signal'    http://maimosine-info.imag.fr/api/trainings/select/?keywords=traitement+du+signal ou http://maimosine-info.imag.fr/api/trainings/select/?keywords=traitement du signal
  • Formations qui ont comme cadre 'Maimosine' ou 'CIMENT' (ou les deux)    http://maimosine-info.imag.fr/api/trainings/select/?frames=maimosine,ciment
  • Formations de type 'Séminaire'    http://maimosine-info.imag.fr/api/trainings/select/?types=seminaire
  • Formations de type 'Cours' + formations de type 'Cours/Tp'    http://maimosine-info.imag.fr/api/trainings/select/?types=cours,Cours/TP
  • Les séminaires Maimosine    http://maimosine-info.imag.fr/api/trainings/select/?types=seminaire&frames=maimosine
  • Les formations Maimosine futures    http://maimosine-info.imag.fr/api/trainings/select/?frames=maimosine&futur
  • Autre possibilité pour les formations Maimosine futures    http://maimosine-info.imag.fr/api/trainings/select/?frames=maimosine&futur=yes
  • Les formations Maimosine futures pour lesquelles on gère l'inscription    http://maimosine-info.imag.fr/api/trainings/select/?frames=maimosine&insc&futur
  • Les formations de l'année scolaire en cours, et au delà    http://maimosine-info.imag.fr/api/trainings/select/?current_syear=yes
  • Les formations antérieures à l'année scolaire en cours    http://maimosine-info.imag.fr/api/trainings/select/?current_syear=no
  • Les formations pour l'année scolaire 2017 (du 01-09-2017 au 31-08-2018)    http://maimosine-info.imag.fr/api/trainings/select/?syear=2017

    • Remarques

    Pour les paramètres de type booléen, les valeurs suivantes sont prises en compte : yes, true, oui, vrai, no, false, non et faux. Un champ vide est assimilé à True. La casse n'a pas d'importance.

    Il y 3 paramètres booléen possibles lorsqu'on utilise l'url '...trainings/select/...' : futur, insc et current_syear. (Pour le nom des paramètres, la casse compte)

    Exemple d'affichage des données sur un site web tierce

    L'utilitaire javascript ccJSON2HTML.js transpose les données du json au html. Cela permet de les afficher sur un autre site web.

    Ci dessous, 2 exemples à partir des données MaiMoSiNE. Pour voir le code source, il faut cliquer sur le lien puis afficher le code source via le navigateur.

    Flux Rss

    Flux existants

    Les flux rss distribués par maimosine-info sont les suivants :

    Dans le cas du dernier flux, on peut remplacer "maimosine" par le nom ou l'id d'un autre cadre, et avoir ainsi la liste des dernières formations pour un cadre donné

    Comment afficher ces flux sur un site

    Pour afficher ces flux sur un site, on peut utiliser un code javascript et une css fournis par maimosine-info. Le tout, ainsi qu'un exemple se trouve là: Affichage des flux Rss

    Pour cela, il faut inclure dans le code html coté client les lignes suivantes:

                    <link href="http://maimosine-info.imag.fr/rssFeed/ccRssFeed.css" type="text/css" rel="stylesheet" />
                <script type="text/javascript" src="https://www.google.com/jsapi"></script>
                <script type="text/javascript" src="http://maimosine-info.imag.fr/rssFeed/ccRssFeed.js"></script>
                <script type="text/javascript">
                   new displayRss("http://maimosine-info.imag.fr/feed/training/frame/maimosine/", 10,"title,category")
                </script>

    On pourra bien sur remplacer la css de maimosine - donnée à titre d'exemple - par une css locale.

    Ce qu'on peut parametrer via la fonction displayRss :