Table of contents
TOC
Réduire la table des matières
Développer la table des matières
Dernière mise à jour: 20/06/2018

Instructions d'authentification

Nous recommandons fortement d'utiliser un flux de code d'autorisation pour l'implémentation Oauth2, afin d'éviter à l'utilisateur de devoir entrer ses informations d'identification chaque fois que son jeton d'accès expire.

Instructions concernant l'API pour l'intégration du complément bloc-notes OneNote pour la classe

S'applique aux : bloc-notes d'entreprise sur Office 365

Ce document présente les appels API qui permettent à OneNote d'énumérer les classes et les devoirs, de définir les devoirs, de télécharger les notes et de les mettre à jour au sein de n'importe quel LMS.

Toutes les demandes doivent être authentifiées. Toutes les demandes doivent être effectuées via HTTPS.

Récupérer une liste de classes

Effectuer une demande GET à <Specify URL for retrieving list of classes>

Le LMS doit renvoyer un tableau JSON des classes pour l'utilisateur actuellement authentifié.

Chaque classe doit alors avoir les propriétés suivantes :

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique de la classe pour l'installation du LMS
namechaîneNom de la classe visuellement contrôlable

Récupérer la liste des étudiants d'une classe

Effectuer une demande GET à <Specify URL for retrieving list of students in a class>

Le LMS doit renvoyer un tableau JSON des étudiants de la classe.

Chaque étudiant doit avoir les propriétés suivantes :

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique de l'étudiant pour l'installation du LMS
namechaîneNom de l'étudiant visuellement contrôlable
emailchaîneAdresse électronique de l'étudiant

Récupérer la liste des devoirs d'une classe

Effectuer une demande GET à <Specify URL for retrieving list of assignments for a class>

Le LMS doit renvoyer un tableau JSON des devoirs de la classe.

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique du devoir pour l'installation du LMS
titlechaîneTitre du devoir
descriptionchaîneDescription du devoir
gradetypeidchaîneIdentifiant unique du type de note pour l'installation du LMS
dueDatedate sous forme de chaîne (format : 2016-12-25T00:00:00)Date d'échéance du devoir. Le LMS ne stockera pas et n'utilisera la partie « heure ».
urlchaîneURL du devoir. Disponible uniquement pour les versions de LMS prises en charge.
Nom de propriété facultatifTypeDescription
gradetypeidchaîneIdentifiant unique du type de note pour l'installation du LMS
minentierscore minimal pouvant être attribué à un étudiant
maxentierscore maximal pouvant être attribué à un étudiant
validgradevalueslistevaleurs valides pour les notes de ce devoir

Définir un devoir pour une classe

Effectuer une demande POST à <Specify URL for setting an assignment to a class>

Les variables de formulaire POST suivantes sont obligatoires :

Nom de la propriétéTypeDescription
titlechaîne (longueur maximale : 280)Titre du devoir
dueDatedate sous forme de chaîne (format : 2016-12-25T00:00:00)Date d'échéance du devoir
descriptionchaîneDescription du devoir
Nom de propriété facultatifTypeDescription
gradetypeidchaîneIdentifiant unique du type de note pour l'installation du LMS
minentierscore minimal pouvant être attribué à un étudiant
maxentierscore maximal pouvant être attribué à un étudiant
validgradevalueslistevaleurs valides pour les notes de ce devoir

Le LMS renvoie un objet JSON avec une seule propriété d'identification. La valeur de cette propriété constituera l'identificateur pour le nouveau devoir.

Récupérer une liste de notes pour un devoir

Effectuer une demande GET à <Specify URL for retrieving grades for a given assignment>

Le LMS doit renvoyer un tableau JSON des étudiants auxquels le devoir a été affecté, ainsi que leurs notes/scores.

Les segments JSON propres à chaque étudiant doivent contenir les propriétés suivantes :

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique de l'étudiant pour l'installation du LMS
emailchaîneAdresse électronique de l'étudiant
gradedbooléenIndique si une note a été fournie par l'enseignant
obtainedMarkentierNote obtenue par l'étudiant (par ex. 85) (facultatif)
maxMarkentierNote maximale possible (par exemple 100) (facultatif)
feedbackchaîneCommentaires fournis à l'étudiant (par ex. "Bon travail") (facultatif)
gradechaîneNote fournie à l'étudiant (par ex. "A") (facultatif)

Notez que le LMS peut prendre en charge la notation par des chiffres autres que 100. Dans ce cas (si la note maximale n'est pas égale à 100), il est possible que OneNote doive convertir la note obtenue si celle-ci ne peut être affichée dans l'interface utilisateur de OneNote.

Définir une note pour un étudiant

Effectuer une demande POST à <Specify URL for setting grade for a given student>

Les variables de formulaire POST suivantes peuvent être incluses :

Nom de la propriétéTypeDescription
idchaîneIdentifiant de l'étudiant, un GUID
sourcechaîneDéfinissez toujours cette valeur sur " onenote"
obtainedMarkentierNote obtenue par l'étudiant
maxMarkentierNote maximale pouvant être obtenue
obtainedGradechaîneNote ou niveau obtenu par l'étudiant (ex. : "A")
commentschaîneCommentaire textuel libre fourni à l'étudiant

Obtenir les types de notes

Effectuer une demande GET à <Specify URL for getting grade types>

Le LMS doit renvoyer un tableau JSON des types de notes. Chaque type de note doit avoir les propriétés suivantes :

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique du type de note pour l'installation du LMS
gradeTypeCategoryGradeTypeCategoryCatégorie unique du type de note pour l'installation du LMS
maxentierscore maximal possible
descriptionchaînechaîne affichée pour le type de note

Obtenir un type de note spécifique

Effectuer une demande GET à <Specify URL for getting grade type by id>

Le LMS doit renvoyer un JSON pour un seul type de note, doté des propriétés suivantes :

Nom de la propriétéTypeDescription
idchaîneIdentifiant unique du type de note pour l'installation du LMS
gradeTypeCategoryGradeTypeCategoryCatégorie unique du type de note pour l'installation du LMS
maxentierscore maximal possible
descriptionchaînechaîne affichée pour le type de note

API permettant de créer/supprimer les classes et de supprimer des devoirs.

Ces possibilités sont facultatives, mais elles sont fortement recommandées pour permettre les tests d'intégration. L'équipe Bloc-notes Microsoft pour la classe utilise ces points de terminaison à des fins de nettoyage.

enum GradeTypeCategory
{
        /// <summary>
        /// no grade type category.
        /// </summary>
        None,

        /// <summary>
        /// Numeric grade type category.
        /// </summary>
        Numeric,

        /// <summary>
        /// Percent grade type category.
        /// </summary>
        Percentage,

        /// <summary>
        /// Letter grade type category.
        /// </summary>
        Letters,
}

Pré-requis de l'environnement de test

Votre environnement de test est composé de deux systèmes.

Client test Office 365

Il peut s'agir de n'importe quel client Office 365 auquel vous avez accès et pour lequel il existe un certain nombre de comptes enseignant et étudiant disposant de licences Office valides. Il existe un Client Office 365 de démonstration, disponible pour les partenaires. Lors de l'installation de ce client de démonstration, vous pouvez choisir une instance EDU K-12 personnalisée. Elle sera pré-remplie avec des enseignants, des étudiants et des UGS éducatifs.

Environnement et comptes de test du LMS

Vous devez fournir les informations suivantes à l'équipe Bloc-notes pour la classe :

  • URL de base du LMS/SIS qui héberge les points de terminaison de l'API.
  • Identifiant de l'application* – identifiant d'application unique affecté au complément bloc-notes pour la classe, vous permettant de le détecter en tant qu'application valide.
  • Clé d'application* – clé secrète attribuée à l'identifiant d'application donné

*si Oauth2 n'est pas pris en charge

Pré-requis en termes d'infos marketing

Image logo

La résolution n'a pas besoin d'être très élevée. Nos logos actuels font en effet moins de 100 Ko, avec une taille maximale de 300 x 300 pixels.

Description

La description doit être courte : un message d'environ 75 mots (et même 50 mots si possible) portant sur votre offre

Permet d'en savoir plus sur votre offre

Ce logo doit avoir une taille de 64 x 64 pixels

Ressources supplémentaires

© 2018 Microsoft