Redu para desenvolvedores

AVA

Fork me on GitHub

O AVA (Ambiente Virtual de Aprendizagem) no contexto da API é chamado simplesmente de environment. Ele serve como um organizador de cursos e representa a instituição ou empresa que detém estes. Além de uma forma de organizar cursos o AVA detém opções administrativas que fazem sentido ao Gestor de conhecimento ou Gestor de EAD. Por si só não detém conteúdo (aulas, arquivos e posts) nem usuários. Estes estão dentro das disciplinas e cursos, respectivamente.

Atributos

Atributo Descrição
ID Identificador do ambiente
name Nome
initials Iniciais
path Caminho usado na URL
description Descrição
courses_count Quantidade de cursos
thumbnails Thumbnails do ambiente. Tamanhos disponíveis: 32×32, 48×48, 90×90, 96×96 e 140×140

Links

Link Descrição
self Ambiente em questão
courses Cursos
user Usuário criador

Representação

{
    "description": "Ambiente de MOOCs (Massive Open Online Courses, ou Cursos Online Abertos Massivos), organizados pela ABMES (Associação Brasileira de Mantenedoras de Ensino Superior) e coordenados por João Mattar e o GPTED-TIDD (Grupo de Pesquisa em Tecnologias Educacionais do Programa de Pós-Graduação em Tecnologias da Inteligência e Design Digital da PUC-SP).",
    "links": [
        {
            "href": "http://www.redu.com.br/api/users/Anderson",
            "rel": "user"
        },
        {
            "href": "http://www.redu.com.br/api/environments/moocs",
            "rel": "self"
        },
        {
            "href": "http://www.redu.com.br/api/environments/moocs/courses",
            "rel": "courses"
        }
    ],
    "name": "MOOCs",
    "created_at": "2013-02-23T12:09:56-03:00",
    "path": "moocs",
    "updated_at": "2013-03-16T16:09:00-03:00",
    "initials": "MOOCs",
    "id": 1362,
    "thumbnails": [
        {
            "size": "140x140",
            "href": "http://s3.amazonaws.com/redu_uploads/environments/avatars/1362/thumb_140/logo_abmes_90_90.jpg?1362484765"
        },
        {
            "size": "32x32",
            "href": "http://s3.amazonaws.com/redu_uploads/environments/avatars/1362/thumb_32/logo_abmes_90_90.jpg?1362484765"
        },
        {
            "size": "90x90",
            "href": "http://s3.amazonaws.com/redu_uploads/environments/avatars/1362/thumb_90/logo_abmes_90_90.jpg?1362484765"
        },
        {
            "size": "48x48",
            "href": "http://s3.amazonaws.com/redu_uploads/environments/avatars/1362/thumb_48/logo_abmes_90_90.jpg?1362484765"
        },
        {
            "size": "96x96",
            "href": "http://s3.amazonaws.com/redu_uploads/environments/avatars/1362/thumb_96/logo_abmes_90_90.jpg?1362484765"
        }
    ],
}

GET /api/environments/:id

Retorna o AVA especificado. Tanto o ID quanto o path podem ser utilizados aqui, porém o path é passível de modificações pelo usuário, portanto pode não servir como um identificador único.

Autorização

O usuário deve fazer parte de pelo menos um curso do AVA ou ser o dono do mesmo.

Parâmetros

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

POST /api/environments

Cria AVA. Por si só o AVA é apenas uma maneira de organizar um conjunto de cursos dentro do contexto de uma instituição.

Parâmetros

Parâmetro Descrição Restrições
environment[name] Nome do ambiente Máximo 40 caracteres; deve ser único
environment[path] Nome que aparecerá na barra de endereço Deve respeitar a seguinte regex: ^[-_A-Za-z0-9]*$
environment[initials] Abreviação (usado em alguns lugares da interface) Deve ser único; Máximo de 10 caracteres
environment[description] Descrição do ambiente Máximo de 400 caracteres

Exemplo

POST /api/environments/23

Payload (JSON):

{
  "environment" : {
    "name" : "meu novo ambiente",
      "path" : "meu-novo-ambiente",
      "initials" : "mna"
  }
}

Resposta:

{
  "initials": "mna",
    "links": [
    {
      "href": "http://www.redu.com.br/api/environments/meu-novo-ambiente",
      "rel": "self"
    },
    {
      "href": "http://www.redu.com.br/api/environments/meu-novo-ambiente/courses",
      "rel": "courses"
    },
    {
      "href": "http://www.redu.com.br/api/users/guiocavalcanti",
      "rel": "user"
    }
  ],
    "name": "meu novo ambiente",
    "created_at": "2012-09-10T09:42:00-03:00",
    "path": "meu-novo-ambiente",
    "id": 909
}

PUT /api/environments/:id

Atualiza informações do AVA em questão.

Autorização

O usuário deve ser administrador do AVA.

Parâmetros

Parâmetro Descrição Restrições
environment[name] Nome do ambiente Máximo 40 caracteres; deve ser único
environment[path] Nome que aparecerá na barra de endereço Deve respeitar a seguinte regex: ^[-_A-Za-z0-9]*$
environment[initials] Abreviação (usado em alguns lugares da interface) Deve ser único; Máximo de 10 caracteres
environment[description] Descrição do ambiente Máximo de 400 caracteres

DELETE /api/environments/:id

Remove o AVA em questão. Todos os cursos, disciplinas, módulos e aulas insteridos neste ambiente serão perdidos e não estarão mais acessíveis aos usuários.

Autorização

O usuário deve ser administrador do AVA.

Parâmetros

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