Enterprise Help Site - French

Page tree

Grâce à la fonction Calendrier externe - Point de terminaison API, les utilisateurs de CAE LearningSpace pourront traiter les événements (y compris la date, le nom de l'événement et le nom de la salle) à l'aide de leurs composants d'intégration logicielle et utiliser les informations relatives à l'événement de la manière qu'ils souhaitent, par exemple :

  • les transmettre à des applications de calendrier externes,
  • ou les présenter comme une page web statique.

IMPORTANT

Ce processus n'est pas un flux d'informations à double sens : les données modifiées ou créées dans un calendrier externe ne peuvent pas être renvoyées à LearningSpace.


CAE LearningSpace ne génère pas d'application de calendrier externe : les données brutes peuvent être utilisées pour générer des entrées dans un calendrier externe (tiers).

Ce point de terminaison API peut être interrogé et peut fournir des données du calendrier CAE LearningSpace à afficher en dehors du système sur un calendrier public. Il fait référence aux événements d'aujourd'hui et aux événements futurs pour les 7 prochains jours.

IMPORTANT : Le système CAE LearningSpace doit être public (accessible via l'internet public) et les règles du pare-feu doivent autoriser le trafic correspondant pour que cette fonction soit opérationnelle.


Lorsque la fonction est activée, lors du lancement d'une requête, les événements qui 

  • sont approuvés
  • commencent au cours de ce jour de calendrier (à partir de 00:00 du jour de la requête)
  • se terminent le septième jour de la requête (à 23h59 au plus tard).


L'accès à l'API de calendrier public doit être limité par le service informatique du client pour n'être disponible que pour les automatismes qui y sont intégrés, car il n'y a pas d'application d'autorisation.

Comment utiliser l'API

Le Calendrier externe - Point de terminaison API peut être activé à l'aide d'une bascule dans le gestionnaire du système, onglet Général.


Demande de données au format ICS


En copiant le fichier ICS, il peut être inséré dans des calendriers externes  (Google, Outlook).

Le fichier ICS peut être actualisé à l'aide du bouton Actualiser.


Étant donné que des modifications peuvent être apportées fréquemment au calendrier de CAE LearningSpace (par exemple, l'ajout de nouveaux événements), veillez à toujours utiliser l'option Actualiser avant de passer à votre calendrier externe, afin d'obtenir le contenu le plus récent de votre calendrier LS.
Le système met automatiquement à jour le lien ICS toutes les heures.


 
Exemple pour le point de terminaison ics :

BEGIN:VCALENDAR
VERSION:2.0
PRODID:Data::ICal 0.22
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 1 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 1 (Sim Room)
USERS:
END:VEVENT
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 2 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 2 (Sim Room)
USERS:
END:VEVENT
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 3 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 3 (Sim Room)
USERS:
END:VEVENT
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 4 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 4 (Sim Room)
USERS:
END:VEVENT
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 5 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 5 (Sim Room)
USERS:
END:VEVENT
BEGIN:VEVENT
COLOR:turquoise
DESCRIPTION:Weekly Assessment
DTEND:20230626T101500
DTSTAMP:20230622T060102Z
DTSTART:20230626T090000
LOCATION:Sim 6 (Sim Room)
SUMMARY:ACLS Megacode Testing
UID:2023-06-26T09:00:00_ACLS Megacode Testing_Sim 6 (Sim Room)
USERS:
END:VEVENT
END:VCALENDAR }

Pour un guide étape par étape, voir Comment utiliser le point de terminaison de l'API Calendrier externe.

Demande de données au format JSON

En copiant le fichier JSON, il peut être inséré dans des calendriers externes (Google, Outlook).

Informations destinées aux développeurs de logiciels de nos clients :

  • utiliser une requête HTTP GET pour récupérer le contenu du calendrier externe en tant que document JSON
  • le point de terminaison de l'API est https://<your.learning.space.edu>/w/api/v2/public-calendar.json
  • la définition de l'API est disponible sous la forme d'une spécification OpenAPI à l'adresse suivante : https://<your.learning.space.edu>/w/api/v2/openapi.yml
  • écrire du code pour analyser la liste des événements afin de la présenter ou de la traiter en fonction de vos besoins



Exemple pour le point de terminaison json :

{
  "events": [
    {
      "isRecurringSeries": false,
      "isPartOfRecurringSeries": true,
      "activity": {
        "color": "neonCarrot",
        "title": "ACLS Testing "
      },
      "eventStart": "2022-06-13T07:00:00Z",
      "note": "Weekly Assessment",
      "rooms": [
        {
          "location": null,
          "name": "Sim 1 (Sim Room)"
        },
        {
          "location": null,
          "name": "Sim 2 (Sim Room)"
        },
        {
          "location": null,
          "name": "Sim 3 (Sim Room)"
        },
        {
          "location": null,
          "name": "Sim 4 (Sim Room)"
        },
        {
          "location": null,
          "name": "Sim 5 (Sim Room)"
        },
        {
          "location": null,
          "name": "Sim 6 (Sim Room)"
        }
      ],
      "durationMinutes": 180,
      "title": "ACLS Megacode Testing",
      "eventEnd": "2022-06-13T10:00:00Z"
    },
    {
      "isRecurringSeries": false,
      "isPartOfRecurringSeries": false,
      "activity": {
        "color": "neonCarrot",
        "title": "SON C/O 2019 Assessment"
      },
      "eventStart": "2022-06-09T07:00:00Z",
      "note": null,
      "rooms": [
        {
          "location": null,
          "name": "Exam 1 (Exam Room)"
        }
      ],
      "durationMinutes": 135,
      "title": "Effective Assessment and Communication Skills Event",
      "eventEnd": "2022-06-09T09:15:00Z"
    }
  ],
  "eventsTo": "2022-06-16T21:59:59Z",
  "generatedAt": "2022-06-09T05:57:10Z",
  "eventsFrom": "2022-06-08T22:00:00Z"
}

Pour un guide étape par étape, voir Comment utiliser le point de terminaison de l'API Calendrier externe.


Voir aussi Notes sur les fonctionnalités du point de terminaison de l'API Calendrier externe dans le Gestionnaire de système.

Pour d'autres améliorations du calendrier, voir Notes de mise à jour concernant le module Inventaire - Printemps 2022


Pour plus d'informations, consultez nos pages Gestionnaire de système et Système - Comment faire .