Brightspace-API's maken functionaliteit beschikbaar om gebruikers in staat te stellen inhoud toe te voegen aan en te verwijderen uit cursussen. In de volgende voorbeelden ziet u hoe deze API's kunnen worden gebruikt om een standaardoverzicht voor een cursus te maken.
Stel dat alle cursussen de volgende modules moeten hebben:
- Introductie
- Markering schema
- Tussentijdse evaluatie
- Examen Beoordeling
Als we een lijst hebben met cursussen die worden geïdentificeerd door hun organisatie-eenheids-ID, kunnen we controleren of er inhoud is toegewezen en deze indien nodig wijzigen.
We kunnen de Valence-documentatie raadplegen voor routes waarmee we de koers kunnen manipuleren tevreden.
Eerst halen we de huidige inhoud op voor een cursus met een organisatie-eenheids-ID van 121535.
GET /d2l/api/le/1.0/121535/content/root/200 OK[{"Structuur": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97657,"Title": "Customs","ShortTitle": "","Type": 0}]
Er blijkt al een module gemaakt te zijn voor deze cursus. Laten we het verwijderen voordat we onze eigen modules toevoegen.
DELETE /d2l/api/le/1.0/121535/content/modules/97657200 OK
Als we de hoofdmap van de cursusinhoud opnieuw controleren, zouden we een lege array moeten ontvangen.
GET /d2l/api/le/1.0/121535/content/root/200 OK[]
Nu zijn we klaar om onze eigen modules toe te voegen.
POST /d2l/api/le/1.0/121535/content/root/{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Marking Scheme","ShortTitle": "","Type": 0}200 OKPOST /d2l/api/le/le/1.0/121535/content/root/{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Inleiding","ShortTitle": "","Type": 0}200 OKPOST /d2l/api/le/1.0/121535/content/root/{"Structuur": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Midterm Review","ShortTitle": "","Type": 0}200 OKPOST /d2l/api/le/1.0/121535/content/root/{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Examenbeoordeling","ShortTitle": "","Type": 0}200 OK
Nu kunnen we de hoofdmap van de cursusinhoud opnieuw controleren en de module-ID's ophalen. (Als u aanroepen doet tegen een leeromgeving van versie 10.2.0 of hoger, moeten de aanroepen voor het maken van onderwerpen en modules informatie over elke structuur naar u terugsturen terwijl u ze maakt, zodat u op dat moment de waarde van de module of onderwerp-id hebt.)
KRIJG /d2l/api/le/1.0/121535/content/root/200 OK[{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97657,"Title": "Inleiding","ShortTitle": "","Type": 0},{"Structuur": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97658,"Title": "Marking Scheme","ShortTitle": "","Type": 0},{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false," Id": 97659,"Title": "Midterm Review","ShortTitle": "","Type": 0},{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97660,"Title": "Examenbeoordeling","ShortTitle": "","Type": 0}]
Nu heeft de cursus een standaard set modules gemaakt. Laten we de start- en einddatum voor de introductiemodule instellen.
PUT /d2l/api/le/1.0/121535/content/modules/97657{"Structure": [],"ModuleStartDate": "2013-05-20T13:00:00.000Z","ModuleEndDate": "2013-05-24T22:00:00.000Z","IsHidden": false,"IsLocked": false,"Id": 97657,"Title": "Inleiding","ShortTitle": "","Type": 0}200 OK
Laten we als laatste stap een submodule aan de inleiding toevoegen. (Edit: De route hieronder gecorrigeerd naar POST, in plaats van PUT.)
POST /d2l/api/le/1.0/121535/content/modules/97657/structure/{"Structure": [],"ModuleStartDate":null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Professor-Student Mixer","ShortTitle": "","Type": 0}200 OK
Dit behandelt de basisprincipes van het manipuleren van modules in een cursus.