As APIs do Brightspace expõem a funcionalidade para permitir que os usuários adicionem e removam conteúdo de cursos. Os exemplos a seguir mostram como essas APIs podem ser usadas para criar uma estrutura de tópicos padrão para um curso.
Suponha que todos os cursos devam ter os seguintes módulos:
- Introdução
- Esquema de marcação
- Revisão intercalar
- Revisão do exame
Se tivermos uma lista de cursos identificados pelo ID da unidade organizacional, podemos verificar se há algum conteúdo atribuído e modificá-los conforme necessário.
Podemos consultar a documentação de Valence para rotas que nos permitem manipular o curso conteúdo.
Primeiro, recuperaremos o conteúdo atual de um curso com um ID de unidade organizacional de 121535.
GET /d2l/api/le/1.0/121535/content/root/200 OK[{"Estrutura": [],"Data_de_Início_do_Módulo": null,"Data_do_Módulo": null,"IsHidden": falso,"IsLocked": falso,"Id": 97657,"Título": "Alfândega","TítuloCurto": "","Tipo": 0}]
Parece já haver um módulo criado para este curso. Vamos excluí-lo antes de adicionarmos nossos próprios módulos.
DELETE /d2l/api/le/1.0/121535/content/modules/97657200 OK
Se verificarmos novamente a raiz do conteúdo do curso, devemos receber uma matriz vazia.
GET /d2l/api/le/1.0/121535/content/root/200 OK[]
Agora estamos prontos para adicionar nossos próprios módulos.
POST /d2l/api/le/1.. 0/121535/content/root/{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Esquema de marcação","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": "Introdução","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": "Revisão intermediária","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": "Revisão do exame","ShortTitle": "","Type": 0}200 OK
Agora podemos verificar novamente a raiz do conteúdo do curso e recuperar os IDs do módulo. (Se você estiver fazendo chamadas em um Ambiente de Aprendizagem versão 10.2.0 ou posterior, as chamadas para criar tópicos e módulos deverão retornar a você informações sobre cada estrutura à medida que você as cria, para que você tenha o valor do Módulo ou da ID do Tópico nesse ponto.)
GET /d2l/api/le/1.GET /d2l/api/1.0/121535/content/root/200 OK[{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97657,"Title": "Introdução","ShortTitle": "","Type": 0},{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97658,"Title": "Esquema de marcação","ShortTitle": "","Type": 0},{"Structure": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false," Id": 97659,"Title": "Revisão intermediária","ShortTitle": "","Tipo": 0},{"Estrutura": [],"ModuleStartDate": null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": 97660,"Title": "Revisão do exame","ShortTitle": "","Type": 0}]
Agora, o curso tem um conjunto padrão de módulos criados. Vamos definir as datas de início e término do módulo de introdução.
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": "Introdução","ShortTitle": "","Type": 0}200 OK
Como etapa final, vamos adicionar um submódulo à introdução. (Editar: Corrigida a rota abaixo para POST, em vez de PUT.)
POST /d2l/api/le/1.0/121535/content/modules/97657/structure/{"Structure": [],"ModuleStartDate":null,"ModuleEndDate": null,"IsHidden": false,"IsLocked": false,"Id": null,"Title": "Mixer Professor-Aluno","ShortTitle": "","Type": 0}200 OK
Isso abrange os conceitos básicos de manipulação de módulos em um curso.