Redu para desenvolvedores

Progresso

Fork me on GitHub

O recurso de Progresso refere-se ao progresso de um usuário em relação a uma Aula. Este recurso indica se a aula foi finalizada pelo aluno.

Atributos

Atributo Descrição
id ID do progresso
finalized Indica se a aula foi finalizada
updated_at Indica quando a aula foi finalizada (se finalized = true)

Links

Link Descrição
self Progresso em questão
user Usuário responsável pelo progresso na aula
lecture Aula à ser finalizada
subject Módulo ao qual a aula pertence

GET /api/progress/:id

Retorna um progresso com o ID especificado

Autorização

É necessário estar matriculado no curso ao qual a aula pertence e ser o user da entidade Progresso.

Parâmetros

Atributo Descrição Restrições
id ID do progresso N/A

Exemplo

Requisição:
GET /api/progress/4

Resposta:

{
  "id" : 4,
  "finalized" : false,
  "updated_at" : "2012-01-13T12:11:22-02:00",
  "links" : [
    { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/1" },
    { "rel" : "user", "href" : "http://www.redu.com.br/api/users/4" },
    { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/8" },
    { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
  ]
}

PUT /api/progress/:id

Atualiza o progresso do usuário logado em relação a uma aula.

Autorização

É necessário estar matriculado no curso ao qual a aula pertence e ser o user da entidade Progresso.

Parâmetros

Atributo Descrição Restrições
id ID do progresso N/A
progress[finalized] Indicativo de que a aula foi finalizada Deve ser true ou false

Exemplo

Requisição:
PUT /api/progress/4

Resposta:

{
  "id" : 4,
  "finalized" : true,
  "updated_at" : "2012-01-15T12:11:22-02:00",
  "links" : [
    { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/1" },
    { "rel" : "user", "href" : "http://www.redu.com.br/api/users/4" },
    { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/8" },
    { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
  ]
}

GET /api/lectures/:lecture_id/progress/

Retorna todos os progressos de uma aula, ou seja, de todos os usuários relacionados à aula. Pode-se filtrar os progressos de uma aula pelo(s) usuário(s).

Autorização

É necessário estar matriculado no curso ao qual a aula pertence como teacher ou environment_admin.

Parâmetros

Atributo Descrição Restrições
lecture_id ID da aula N/A
users_ids[] ID do usuário. Permite filtrar os progressos baseado no(s) usuário(s) Precisa ser um usuário matriculado no curso ao qual a aula pertence

Exemplo

Requisição:
GET /api/lectures/25/progress

Resposta:

[
  {
    "id" : 1,
    "finalized" : true,
    "updated_at" : "2012-01-15T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/1" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/4" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/25" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
    ]
  },
  {
    "id" : 9,
    "finalized" : false,
    "updated_at" : "2012-01-07T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/9" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/23" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/25" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
    ]
  },
]

GET /api/subjects/:subject_id/progress/

Retorna todos os progressos de um módulo, ou seja, de todos os usuários relacionados ao módulo. Pode-se filtrar os progressos de um módulo pelo(s) usuário(s).

Autorização

É necessário estar matriculado no curso ao qual o módulo pertence como teacher ou environment_admin.

Parâmetros

Atributo Descrição Restrições
subject_id ID da módulo N/A
users_ids[] ID do usuário. Permite filtrar os progressos baseado no(s) usuário(s) Precisa ser um usuário matriculado no curso ao qual o módulo pertence

Exemplo

Requisição:
GET /api/subjects/74/progress

Resposta:

[
  {
    "id" : 1,
    "finalized" : true,
    "updated_at" : "2012-01-15T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/1" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/4" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/25" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
    ]
  },
  {
    "id" : 9,
    "finalized" : false,
    "updated_at" : "2012-01-07T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/9" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/23" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/25" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/5" }
    ]
  },
  {
    "id" : 2,
    "finalized" : true,
    "updated_at" : "2012-01-15T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/2" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/4" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/48" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/7" }
    ]
  },
  {
    "id" : 10,
    "finalized" : true,
    "updated_at" : "2012-01-07T12:11:22-02:00",
    "links" : [
      { "rel" : "self", "href" : "http://www.redu.com.br/api/progress/10" },
      { "rel" : "user", "href" : "http://www.redu.com.br/api/users/23" },
      { "rel" : "lecture", "href" : "http://www.redu.com.br/api/lectures/48" },
      { "rel" : "subject", "href" : "http://www.redu.com.br/api/subjects/7" }
    ]
  },
]

GET /api/users/:user_id/progress/

Retorna todos os progressos de um usuário. Pode-se filtrar os progressos de um usuário pela(s) aulas(s) ou módulo(s).

Autorização

Apenas o próprio usuário tem acesso.

Parâmetros

Atributo Descrição Restrições
user_id ID do usuário N/A
lectures_ids[] ID da aula. Permite filtrar os progressos baseado na(s) aulas(s) Precisa ser uma aula pertencente a um curso cujo usuário é matriculado
subjects_ids[] ID do módulo. Permite filtrar os progressos baseado no(s) módulos(s) Precisa ser um módulo pertencente a um curso cujo usuário é matriculado

Exemplo

Requisição:
GET /api/users/216/progress

Resposta:

[
  {
    "updated_at": "2013-03-26T15:52:53-03:00",
    "id": 131061,
    "finalized": false,
    "links": [
      { "rel": "self", "href": "http://www.redu.com.br/api/progress/131061" },
      { "rel": "user", "href": "http://www.redu.com.br/api/users/juliana" },
      { "rel": "subject", "href": "http://www.redu.com.br/api/subjects/78" },
      { "rel": "lecture", "href": "http://www.redu.com.br/api/lectures/82" }
    ]
  },
  {
    "updated_at": "2013-05-02T15:25:01-03:00",
    "id": 580275,
    "finalized": false,
    "links": [
      { "rel": "self", "href": "http://www.redu.com.br/api/progress/580275" },
      { "rel": "user", "href": "http://www.redu.com.br/api/users/juliana" },
      { "rel": "subject", "href": "http://www.redu.com.br/api/subjects/114" },
      { "rel": "lecture", "href": "http://www.redu.com.br/api/lectures/964" }
    ]
  }
]