Skip to content

API Forum

Jump to bottom
humbertogomes edited this page Dec 14, 2012 · 2 revisions

Especificação da API de acesso aos fóruns do Solar 2.0

Este documento descreve a API de acesso aos fóruns do Solar 2.0 disponibilizado pelo Instituto Universidade Virtual(IUVI).

Atualmente esta API é utilizada pela aplicação móvel Mobilis, onde os alunos matriculados nos cursos podem interagir nos fóruns.

Obs.: todas as chamadas, exceto envio de arquivos, devem ser feitas utilizando formato JSON(JavaScript Object Notation).

API de acesso aos fóruns

  1. Lista de Disciplinas

GET /curriculum_units/list

Resposta

Status: 200 OK [ { "id":"1", "code":"RM404", "name":"Introducao a Linguistica" }, {...} ]

  1. Lista de Turmas

GET /curriculum_units/:curriculum_unit_id/groups

Resposta

Status: 200 OK [ { "id":"1", "code":"FOR", "semester":"2011.1" }, {...} ]

  1. Lista de Fóruns

GET /groups/:group_id/discussions

Resposta

Status: 200 OK [ { "id":"2", "status":"1", # => [0,1,2] => [não iniciado, iniciado, fechado] "name":"Forum 1", "description":"Primeiro forum", "last_post_date":"2012-05-24 16:39:48" "start_date":"2012-05-20 00:00:00" "end_date":"2012-08-20 00:00:00" }, {...} ]

  1. Lista de Novos Posts

GET /discussions/:id/posts/news/:date GET /discussions/:id/posts/news/:date/order/:order GET /discussions/:id/posts/news/:date/order/:order/limit/:limit

Resposta

Status: 200 OK [ { "before":"10", "after":"2" }, { "id":"5", "parent_id":"", "profile_id":"1", "discussion_id":"2", "user_id":"2", "user_nick":"Nick do Usuario", "content_first":"primeira resposta...", "content_last":"restante primeira resposta", "updated_at":"2012-05-24T16:39:48-03:00" }, {...} ]

  1. Lista de Posts Antigos

GET /discussions/:id/posts/history/:date GET /discussions/:id/posts/history/:date/order/:order GET /discussions/:id/posts/history/:date/order/:order/limit/:limit Resposta

Status: 200 OK [ { "before":"10", "after":"2" }, { "id":"5", "parent_id":"", "profile_id":"1", "discussion_id":"2", "user_id":"2", "user_nick":"Nick do Usuario", "content_first":"primeira resposta...", "content_last":"restante primeira resposta", "updated_at":"2012-05-24T16:39:48-03:00" }, {...} ]

  1. Recuperar Imagem do Usuário

GET /users/:id/photo

  1. Criar Novo Post

POST /discussions/:discussion_id/posts

Input discussion_id

Id do forum parent_id

Se a postagem é uma resposta a um outro post, o id deste deve ser informado content

Conteúdo da postagem

Formato { "discussion_id":"1", "parent_id":"", "content":"texto do post" }

  1. Adicionar um Arquivo a Um Post

POST /posts/:id/post_files

  1. Deletar Post

DELETE /discussions/:discussion_id/posts/:id

Clone this wiki locally