api articles Page History

Articles - API

Lista Artigos

Pega uma lista de artigos.

Está requisição utiliza os parâmetros de paginação page e per_page para restringir a lista.

Parâmetros:

  • fields (opcional) - Mostra somente os campos escolhidos, separado por vírgulas.
GET /articles

{
  "articles": [
    {
      "id": 570,
      "body": null,
      "abstract": null,
      "created_at": "2016/02/04 20:32:59",
      "updated_at": "2016/02/04 20:32:59",
      "title": "Solidarity Economy World Forum",
      "author": null,
      "profile": {
        "identifier": "teste-name",
        "name": "Teste-name",
        "id": 74,
        "created_at": "2016/02/04 20:32:59",
        "updated_at": "2016/02/04 20:32:59",
        "additional_data": {},
        "image": null,
        "region": null
      },
      "categories": [],
      "image": null,
      "votes_for": 0,
      "votes_against": 0,
      "setting": {},
      "position": null,
      "hits": 0,
      "start_date": "2016-02-06T00:00:00.000Z",
      "end_date": null,
      "tag_list": [],
      "children_count": 0,
      "slug": "solidarity-economy-world-forum",
      "path": "solidarity-economy-world-forum",
      "parent": null,
      "children": []
    }
  ]
}

Lista um único artigo

Retorna o artigo.

GET /articles/:id

Parâmetros:

  • id (obrigatório) - ID da comunidade.
{
  "article": {
    "id": 570,
    "body": null,
    "abstract": null,
    "created_at": "2016/02/04 20:32:59",
    "updated_at": "2016/02/04 20:32:59",
    "title": "Solidarity Economy World Forum",
    "author": null,
    "profile": {
      "identifier": "teste-name",
      "name": "Teste-name",
      "id": 74,
      "created_at": "2016/02/04 20:32:59",
      "updated_at": "2016/02/04 20:32:59",
      "additional_data": {},
      "image": null,
      "region": null
    },
    "categories": [],
    "image": null,
    "votes_for": 0,
    "votes_against": 0,
    "setting": {},
    "position": null,
    "hits": 0,
    "start_date": "2016-02-06T00:00:00.000Z",
    "end_date": null,
    "tag_list": [],
    "children_count": 0,
    "slug": "solidarity-economy-world-forum",
    "path": "solidarity-economy-world-forum",
    "parent": null,
    "children": []
  }
}

Comentários do artigo

Retorna os comentários do artigo

GET /articles/:id/comments

Parâmetros:

  • id (obrigatório) - ID da comunidade

Cria um artigo

Retorna o artigo criada.

POST /articles

Parâmetros:

  • community[name] (obrigatório) - Nome da comunidade Você pode colocar os outros campos seguindo o padrão community[campo].

Atualiza um artigo

Retorna o artigo atualizado.

POST /articles/:id

Parâmetros:

Você pode colocar os outros campos seguindo o padrão community[campo].

{
  "community": {
    "identifier": "teste-name",
    "name": "Teste-name",
    "id": 74,
    "created_at": "2016/02/04 20:32:59",
    "updated_at": "2016/02/04 20:32:59",
    "additional_data": {},
    "image": null,
    "region": null,
    "description": null,
    "admins": [
      {
        "name": "adminuser",
        "id": 54,
        "username": "adminuser"
      }
    ],
    "categories": [],
    "members": [
      {
        "identifier": "adminuser",
        "name": "adminuser",
        "id": 54,
        "created_at": "2016/01/27 17:12:15",
        "updated_at": "2016/01/27 17:12:19",
        "additional_data": {},
        "image": null,
        "region": null,
        "user": {
          "id": 51,
          "login": "adminuser"
        }
      }
    ]
  }
}
Last edited by Gust