Spécifications REST entrantes
Grades Journey v2 peut fournir les données du carnet de notes à l'aide d'interfaces de programmation d'application REST. Bien que ces interfaces de programmation d'application soient différentes des interfaces de programmation d'application Learn principales, l'authentification de l'interface de programmation d'application Grades Journey v2 suit le même processus d'authentification OAuth2 que l'interface de programmation d'application REST Learn principale. Cela nécessite la configuration d'une application interface de programmation d'application REST sur le Anthology Developer Portal.
Créer un schéma de notation
Point de terminaison du service Web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeSchemasAPI
Exemple de corps JSON
[
{
"title": "Pass-Fail-Custom-Schema",
"symbols": "P=80:F=0",
"optionalData": "sisSchemaID=PF"
}
]Définitions des éléments du schéma de notation
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
titre | Titre du schéma de notation. | oui | String (333 caractères) |
symboles | Symboles figurant dans une liste avec une limite inférieure facultative. | oui | Chaîne (2000 caractères) |
Données facultatives | Paires clé/valeur, chaque ensemble de paires étant séparé par deux points et clé/valeurs séparées par un signe égal. Par exemple : key1=value1:key2=value2 | non | Chaîne (2000 caractères) |
Exemple de réponse
[
{
"courseId": "",
"name": "Pass-Fail-Custom-Schema",
"status": "OK",
"message": "Grade schema successfully created"
}
]Création d'éléments évaluables et de colonnes de notation
Point de terminaison du service Web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradableItemsAPI
Exemple de corps JSON
[
{
"courseId": "course1",
"name": "Final Grade",
"itemType": "MANUAL_COLUMN",
"instructions": ""
"anonymous": false,
"group": false,
"contentAreaName": "Assignments",
"available": true,
"attempts": 1,
"tracked": false,
"startDate":
"endDate":
"dueDate": "",
"points": 100,
"gradeSchema": "Pass-Fail-Custom-Schema",
"sequenceNum": 1,
"extract": true,
"mapping": "",
"optionalData": "SIS_ID=FG123456",
}
]Définitions des éléments évaluables et des éléments des colonnes de notation
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
Identifiant du cours | Identifiant batch identifiant le cours auquel s'applique cet élément évaluable ou cette colonne de notes. | oui | Chaîne (256 caractères) |
Nom | Titre de l'élément évaluable. | oui | String (333 caractères) |
Type d'article | Type d'élément évaluable à créer. Valeurs possibles : *devoir, *test, enquête, plate-forme de discussion, WIKI, blog, JOURNAL, SELF_AND_PEER_TEST, *MANUAL_COLUMN, *WEIGHTED_COLUMN, TOTAL_COLUMN *Cours Ultra et Original. Tous les autres cours originaux uniquement. | oui | String (333 caractères) |
instructions | Instructions relatives à l'élément évaluable. | non | Chaîne (2000 caractères) |
anonymes | Si cela est vrai, le devoir ou le test sera créé avec la notation anonyme activée. Pour les cours Ultra, la notation anonyme nécessite de définir une date d'échéance sur l'élément. | non | Boolean (False par défaut) |
groupe | Si cela est vrai, le devoir sera créé en tant que soumission de groupe de types de devoirs. | non | Boolean (False par défaut) |
Nom de la zone de contenu | Emplacement où l'élément évaluable sera créé. Peut être utilisé dans les cours Ultra pour provisionner un sous-dossier et y placer du contenu. La valeur est au format « parent@>@child » où « parent » est le nom du dossier de niveau supérieur (parent) et « child » est le nom du sous-dossier. Si le sous-dossier existe déjà, le devoir sera ajouté au sous-dossier existant. Si le sous-dossier n'existe pas, il sera créé dans le dossier parent. | non | Chaîne (255 caractères) |
disponible | Détermine si l'élément est visible pour les étudiants. | non | Boolean (False par défaut) |
couleur | Couleur du lien vers un élément évaluable dans un cours d'origine. Nom de la couleur ou valeur hexadécimale. Cours originaux uniquement. | non | Chaîne (10 caractères) |
essais | Nombre de tentatives autorisées pour le test ou le devoir. | non | Int (par défaut —1 pour un nombre illimité) |
suivi | Détermine si le suivi des statistiques est activé pour l'élément évaluable. Ne s'applique pas aux colonnes de notes. Cours originaux uniquement. | non | Boolean (False par défaut) |
Date de début | Afficher à partir de la date. | non | Date |
Date de fin | Afficher jusqu'à la date. | non | Date |
Date d'échéance | Date d'échéance de l'élément évaluable. | non | Date |
points | Points possibles. | non | Float (100,0 par défaut) |
schéma de notes | Nom du schéma de notation tel qu'il existe dans Learn. Notez que ce schéma a peut-être été créé à l'aide du service Web disponible dans Grade Export ou dans Blackboard Learn. | non | String (333 caractères) |
Séquence Num | Numéro d'ordre d'affichage de la séquence de la zone de contenu. Cours originaux uniquement. | non | Int |
extraire | Vrai/faux — Si c'est vrai, cette colonne sera extraite de l'outil d'extraction. S'applique uniquement lorsque Grades Journey a activé la mise à disposition sur la page des paramètres sortants. | non | String (333 caractères) |
cartographie | Pour une colonne pondérée, spécifiez les mappages. La valeur par défaut n'est pas de mappage, ce qui nécessite que le mappage soit effectué manuellement directement dans Learn. Il s'agira des paires nom/pourcentage de l'élément évaluable, séparées par une virgule, où les pourcentages totalisent 100. Exemple : Devoir 1 = 30, Test 1 = 30, Test 2 = 40. Pour une colonne Total, spécifiez uniquement les colonnes qui doivent être incluses dans le total. Par exemple, Devoir 1, Test 1, Devoir 2, Note finale | non | String (333 caractères) |
Données facultatives | Paires clé/valeur, chaque ensemble de paires étant séparé par deux points et clé/valeurs séparées par un signe égal. Par exemple : key1=value1:key2=value2 | non | Chaîne (2000 caractères) |
Exemple de réponse
[
{
"status": "OK",
"message": "Gradecolumn successfully created",
"courseId": "course1",
"name": "Final Grade"
}
]Supprimer les colonnes de notes
Point de terminaison du service Web
https://{{hostname}}//learn/api/v2/cc/gradejourney/gradeColumnDeleteAPI
Exemple de corps JSON
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Colonne de note Supprimer les définitions d'éléments
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
Identifiant du cours | Le cours identifiant batch. | oui | String (333 caractères) |
Nom | Le nom de la colonne à supprimer. | oui | String (333 caractères) |
Exemple de réponse
[
{
"status": "OK",
"message": "Grade column successfully deleted",
"courseId": "TG-TEST-ORIG",
"name": "Delete Column"
}
]Définissez la note externe
(disponible uniquement pour les cours originaux)
Point de terminaison du service Web
https://{{hostname}}/learn/api/v2/cc/gradejourney/externalGradeColumnAPI
Exemple de corps JSON
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Définitions des éléments de colonne de notation externe
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
Identifiant du cours | Le cours identifiant batch. | oui | String (333 caractères) |
Nom | Nom de la colonne à définir comme note externe. | oui | String (333 caractères) |
Exemple de réponse
[
{
"status": "OK",
"message": "External grade column successfully updated",
"courseId": "course1",
"name": "Final Grade"
}
]Création de métadonnées d'inscription
Point de terminaison du service Web
https://{{hostname}}/learn/api/v2/cc/gradejourney/userMetadataAPI
Exemple de corps JSON
[
{
"courseId": "course1",
"userId": "student1",
"optionalData": "EnrollType=LetterGrade"
},
{
"courseId": "course1",
"userId": "student2",
"optionalData": "EnrollType=Audit"
}
]Définitions des éléments de métadonnées d'inscription
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
Identifiant du cours | Le cours identifiant batch. | oui | String (333 caractères) |
ID utilisateur | L'utilisateur identifiant batch. | oui | String (333 caractères) |
Données facultatives | Paires clé/valeur, chaque ensemble de paires étant séparé par deux points et clé/valeurs séparées par un signe égal. Par exemple : key1=value1:key2=value2 | non | Chaîne (2000 caractères) |
Exemple de réponse
[
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course01",
"name": "student01"
},
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course02",
"name": "student02"
}
]Mettre à jour la valeur de note
Point de terminaison du service Web
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeValueAPI
Exemple de corps JSON
[
{
"courseId": "course001",
"userId": "user1",
"name": "FINAL GRADE",
"value": "B"
}
] Définitions des éléments de mise à jour de la valeur de note
Nom de l'élément | Description | Obligatoire | Type et taille maximale |
|---|---|---|---|
Identifiant du cours | Le cours identifiant batch. | oui | String (333 caractères) |
ID utilisateur | L'utilisateur identifiant batch. | oui | String (333 caractères) |
Nom | Colonne dont la valeur doit être mise à jour. | oui | String (333 caractères) |
valeur | La valeur de note vers laquelle effectuer la mise à jour. | oui | String (333 caractères) |
Exemple de réponse
[
{
"status": "OK",
"message": "Grade value successfully added",
"courseId": "course1",
"name": "Final Grade"
}
]