Binnenkomende REST-specificaties
Grades Journey v2 kan cijferlijstgegevens beschikbaar stellen met behulp van REST API's. Hoewel deze API's verschillen van de kern Learn API's, volgt de Grades Journey v2 API-authenticatie hetzelfde OAuth2-authenticatieproces als de kern Learn REST API. Dit vereist een REST API-applicatie die wordt opgesteld op het Anthology Developer Portal.
Maak een gradingschema
Webservice-eindpunt
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeSchemasAPI
Voorbeeld JSON-lichaam
[
{
"title": "Pass-Fail-Custom-Schema",
"symbols": "P=80:F=0",
"optionalData": "sisSchemaID=PF"
}
]Definities van Grading Schema-elementen
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
titel | Titel van het beoordelingsschema. | ja | Snaar (333 karakters) |
symbolen | Symbolen in een lijst met een optionele ondergrens. | ja | String (2000 karakters) |
optionalData | Sleutel/waarde-paren waarbij elke set paren gescheiden wordt door een dubbele punt, en sleutel/waarden gescheiden worden door een gelijkteken. Bijvoorbeeld: sleutel1=waarde1:sleutel2=waarde2 | nee | String (2000 karakters) |
Voorbeeldantwoord
[
{
"courseId": "",
"name": "Pass-Fail-Custom-Schema",
"status": "OK",
"message": "Grade schema successfully created"
}
]Maak gradeerbare items aan en beoordelingskolommen
Webservice-eindpunt
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradableItemsAPI
Voorbeeld JSON-lichaam
[
{
"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",
}
]Gradeerbare items en beoordelingskolommen Elementdefinities
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
courseId | Batch_uid het aangeven van het vak waarop deze kolom met een beoordelingspunt of cijfer van toepassing is. | ja | String (256 karakters) |
name | Titel van het nadelbare item. | ja | Snaar (333 karakters) |
itemType | Type gradeerbaar item om te maken. Mogelijke waarden: *OPDRACHT, *TEST, ENQUÊTE, discussieruimte, WIKI, blog, JOURNAL, SELF_AND_PEER_TEST, *MANUAL_COLUMN, *WEIGHTED_COLUMN, TOTAL_COLUMN *Ultra en Original cursussen. Alle andere zijn alleen originele banen. | ja | Snaar (333 karakters) |
instructies | Instructies voor het beoordelingsobject. | nee | String (2000 karakters) |
anoniem | Als dat waar is, wordt de opdracht of toets aangemaakt met Anonieme Beoordeling ingeschakeld. Voor Ultra Courses Anonymous Grading vereist dat er een deadline op het item wordt vastgesteld. | nee | Booleaan (Standaard onwaar) |
groep | Als dat waar is, wordt de opdracht aangemaakt als Opdrachttype Groepsindiening. | nee | Booleaan (Standaard onwaar) |
contentAreaName | Locatie waar het becijferbare item wordt aangemaakt. Kan in Ultra-cursussen worden gebruikt om een submap te provisionen en content in die submap te plaatsen. De waarde heeft het formaat "parent@>@child" waarbij "ouder" de naam is van de bovenste (ouder) map en "child" de naam van de submap. Als de submap al bestaat, wordt de opdracht toegevoegd aan de bestaande submap. Als de submap niet bestaat, wordt deze aangemaakt in de hoofdmap. | nee | String (255 karakters) |
beschikbaar | Bepaalt of het voorwerp zichtbaar is voor studenten. | nee | Booleaan (Standaard onwaar) |
kleur | Kleur van de beoordelingsbare item in een Original cursus. Kleurnaam of hex-waarde. Alleen originele cursussen. | nee | String (10 karakters) |
pogingen | Aantal pogingen toegestaan voor de Test of Opdracht. | nee | Int (Standaard –1 voor onbeperkt) |
bijgehouden | Bepaalt of statistiektracking is ingeschakeld voor het gradeerbare item. Dat geldt niet voor cijferkolommen. Alleen originele cursussen. | nee | Booleaan (Standaard onwaar) |
startDatum | Toon vanaf datum. | nee | Datum |
einddatum | Toon tot de datum. | nee | Datum |
einddatum | Vervaldatum van het Gradable item. | nee | Datum |
punten | Mogelijk aantal punten. | nee | Float (Standaard 100.0) |
gradeschema | Grade-schemanaam zoals die bestaat in Learn. Let op: dit schema kan zijn gemaakt met de webservice zoals beschikbaar via Grade Export of in Blackboard Learn | nee | Snaar (333 karakters) |
sequenceNum | Volgordenummer van de inhoudsgebiedsequentie weergegeven. Alleen originele cursussen. | nee | Int |
extract | Waar/onwaar – Als waar, wordt deze kolom geëxtraheerd uit het extractie-instrument. Alleen geldt wanneer Grades Journey Provision-activiteit heeft op de pagina Uitgaande Instellingen. | nee | Snaar (333 karakters) |
kartering | Voor een gewogen kolom specificeer je de mappings. De standaard is geen mapping, wat vereist dat de mapping handmatig direct in Learn wordt uitgevoerd. Dit zal de gradeerbare itemnaam/procent-paren zijn, gescheiden door een komma, waarbij de percentages in totaal 100 zijn. Voorbeeld: Opdracht 1=30, Test 1=30, Test 2=40. Voor een Total-kolom specificeer je alleen de kolommen die in de totaal moeten worden opgenomen. Bijvoorbeeld, Opdracht 1, Test 1, Opdracht 2, Eindcijfer | nee | Snaar (333 karakters) |
optionalData | Sleutel/waarde-paren waarbij elke set paren gescheiden wordt door een dubbele punt, en sleutel/waarden gescheiden worden door een gelijkteken. Bijvoorbeeld: sleutel1=waarde1:sleutel2=waarde2 | nee | String (2000 karakters) |
Voorbeeldantwoord
[
{
"status": "OK",
"message": "Gradecolumn successfully created",
"courseId": "course1",
"name": "Final Grade"
}
]Verwijder Cijferkolommen
Webservice-eindpunt
https://{{hostname}}//learn/api/v2/cc/gradejourney/gradeColumnDeleteAPI
Voorbeeld JSON-lichaam
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Definities van Grade Column Delete Element Definities
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
courseId | De cursus Batch-UID. | ja | Snaar (333 karakters) |
name | De naam van de kolom die verwijderd moet worden. | ja | Snaar (333 karakters) |
Voorbeeldantwoord
[
{
"status": "OK",
"message": "Grade column successfully deleted",
"courseId": "TG-TEST-ORIG",
"name": "Delete Column"
}
]Stel de externe cijfer in
(alleen beschikbaar voor originele cursussen)
Webservice-eindpunt
https://{{hostname}}/learn/api/v2/cc/gradejourney/externalGradeColumnAPI
Voorbeeld JSON-lichaam
[
{
"courseId": "course1",
"name": "Final Grade"
}
]Definities van kolomelementen van externe cijfer
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
courseId | De cursus Batch-UID. | ja | Snaar (333 karakters) |
name | De naam van de kolom die als Externe Cijfer wordt ingesteld. | ja | Snaar (333 karakters) |
Voorbeeldantwoord
[
{
"status": "OK",
"message": "External grade column successfully updated",
"courseId": "course1",
"name": "Final Grade"
}
]Maak Inschrijvingsmetadata
Webservice-eindpunt
https://{{hostname}}/learn/api/v2/cc/gradejourney/userMetadataAPI
Voorbeeld JSON-lichaam
[
{
"courseId": "course1",
"userId": "student1",
"optionalData": "EnrollType=LetterGrade"
},
{
"courseId": "course1",
"userId": "student2",
"optionalData": "EnrollType=Audit"
}
]Definities van Inschrijvingsmetadata-elementen
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
courseId | De cursus Batch-UID. | ja | Snaar (333 karakters) |
userId | De gebruiker Batch-UID. | ja | Snaar (333 karakters) |
optionalData | Sleutel/waarde-paren waarbij elke set paren gescheiden wordt door een dubbele punt, en sleutel/waarden gescheiden worden door een gelijkteken. Bijvoorbeeld: sleutel1=waarde1:sleutel2=waarde2 | nee | String (2000 karakters) |
Voorbeeldantwoord
[
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course01",
"name": "student01"
},
{
"status": "OK",
"message": "User metadata successfully created",
"courseId": "course02",
"name": "student02"
}
]Werk de cijferwaarde bij
Webservice-eindpunt
https://{{hostname}}/learn/api/v2/cc/gradejourney/gradeValueAPI
Voorbeeld JSON-lichaam
[
{
"courseId": "course001",
"userId": "user1",
"name": "FINAL GRADE",
"value": "B"
}
] Definities van Grade Value Update Elementdefinities
Element naam | Beschrijving | Vereist | Type en maximale grootte |
|---|---|---|---|
courseId | De cursus Batch-UID. | ja | Snaar (333 karakters) |
userId | De gebruiker Batch-UID. | ja | Snaar (333 karakters) |
name | De kolom waarvan de waarde bijgewerkt moet worden. | ja | Snaar (333 karakters) |
waarde | De cijferwaarde om te updaten. | ja | Snaar (333 karakters) |
Voorbeeldantwoord
[
{
"status": "OK",
"message": "Grade value successfully added",
"courseId": "course1",
"name": "Final Grade"
}
]