Módulo

No contexto da API, o módulo é referido como suject. É um agrupamento de diversas aulas (conteúdos) em um contexto.

GET /api/spaces/:space_id/subjects

Retorna os módulos de uma disciplina.

Parâmetros

Parâmetro	Descrição	Restrições
space_id	ID da disciplina	N/A

GET /api/sujects/:id

Retorna o módulo em questão.

Parâmetros

Parâmetro	Descrição	Restrições
id	ID do módulo	N/A

POST /api/spaces/:space_id/subjects

Cria um módulo no contexto da disciplina especificada por space_id.

Parâmetros

Parâmetro	Descrição	Restrições
space_id	ID da disciplina	N/A
subject[name]	Nome do módulo	Máximo 40 caracteres
subject[description]	Descrição do módulo	Máximo 250 caracteres

Exemplo

POST /api/spaces/1/subjects

Payload:

{
  "subject": {
    "name": "Novo módulo",
      "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit"
  }
}

Resposta:

{
  "id": 1,
    "title": "Novo módulo",
    "description": "Lorem ipsum dolor sit amet, consectetur adipisicing elit",
    "created_at": "2012-04-27T13:07:21-03:00"
      "links": [{
        "rel": "self",
        "href": "http://www.redu.com.br/api/subjects/1"
      }, {
        "rel": "lectures",
        "href": "http://www.redu.com.br/api/subjects/1/lectures"
      }, {
        "rel": "space",
        "href": "http://www.redu.com.br/api/spaces/1"
      }, {
        "rel": "course",
        "href": "http://www.redu.com.br/api/courses/course-name"
      }, {
        "rel": "environment",
        "href": "http://www.redu.com.br/api/environments/environment-name"
      }, {
        "rel": "users",
        "href": "http://www.redu.com.br/api/subjects/347/users"
      }]
}

PUT /api/subjects/:id

Atualiza as informações do módulo.

Parâmetros

Parâmetro	Descrição	Restrições
subject[name]	Nome do módulo	Máximo 40 caracteres
subject[description]	Descrição do módulo	Máximo 250 caracteres

DELETE /api/subjects/:id

Remove um módulo. Os que fazem parte do módulo não terão mais acesso às aulas.

Parâmetros

Parâmetro	Descrição	Restrições
id	ID do módulo	N/A