Redu para desenvolvedores

Disciplina

Fork me on GitHub

No contexto da API disciplina é referida como space. É na disciplina que as interações sociais (ver mural) acontecem e o conteúdo (ver módulo) são postados.

GET /api/spaces/:id

Retorna a disciplina em questão.

Autorização

Deve estar matriculado no Curso ao qual a disciplina pertence.

Parâmetros

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

PUT /api/spaces/:id

Atualiza as informações da disciplina.

Parâmetros

Parâmetro Descrição Restrições
space[name] Nome da disciplina Máximo 40 caracteres; deve ser único
space[description] Descrição da disciplina Máximo de 400 caracteres

POST /api/courses/:course_id/spaces

Cria uma disciplina no contexto do course especificado por course_id.

Autorização

Deve ser teacher ou environment_admin no curso.

Parâmetros

Parâmetro Descrição Restrições
course_id ID do curso N/A
space[name] Nome da disciplina Máximo 40 caracteres
space[description] Descrição da disciplina Máximo de 400 caracteres

Exemplo

POST /api/courses/foo/spaces

Payload:

{
  "space" : {
    "name" : "minha nova disciplina"
  }
}

Resposta:

{
  "links": [
  {
    "href": "http://www.redu.com.br/api/spaces/1626",
      "rel": "self"
  },
  {
    "href": "http://www.redu.com.br/api/courses/meu-novo-curso",
    "rel": "course"
  },
  {
    "href": "http://www.redu.com.br/api/environments/www",
    "rel": "environment"
  },
  {
    "href": "http://www.redu.com.br/api/spaces/1626/users",
    "rel": "users"
  },
  {
    "href": "http://www.redu.com.br/api/spaces/1626/subjects",
    "rel": "subjects"
  },
  {
    "href": "http://www.redu.com.br/api/spaces/1626/statuses",
    "rel": "statuses"
  },
  {
    "href": "http://www.redu.com.br/api/spaces/1626/statuses/timeline",
    "rel": "timeline"
  }
  ],
    "name": "minha nova disciplina",
    "created_at": "2012-09-10T09:51:23-03:00",
    "id": 1626
}

GET /api/courses/:course_id/spaces

Retorna uma lista com as disciplinas do curso especificado.

Autorização

Deve estar matriculado no curso.

Parâmetros

Parâmetro Descrição Restrições
course_id ID ou path do curso N/A

DELETE /api/spaces/:id

Remove uma disciplina. Os que fazem parte do curso ao qual a disciplina faz parte não terão mais acesso aos módulos e aulas.

Autorização

Deve ser teacher ou environment_admin no curso.

Parâmetros

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