api communities Page History

Communities - API

Lista Comunidades

Pega uma lista de comunidades

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

GET /communities

Parâmetros:

  • from - Data de onde começa a pesquisa.
  • until - Data até aonde a pesquisa é realizada.
{
  "communities": [
    {
      "identifier": "use-the-environment",
      "name": "Use the environment",
      "id": 67,
      "created_at": "2016/01/27 17:12:38",
      "updated_at": "2016/01/27 17:12:38",
      "additional_data": {},
      "image": null,
      "region": null,
      "description": null,
      "admins": [
        {
          "name": "José Oliveira",
          "id": 8,
          "username": "jose-oliveira"
        }
      ],
      "categories": [],
      "members": [
        {
          "identifier": "jose-oliveira",
          "name": "José Oliveira",
          "id": 8,
          "created_at": "2016/01/27 17:11:59",
          "updated_at": "2016/01/27 17:12:16",
          "additional_data": {},
          "image": null,
          "region": null,
          "user": {
            "id": 5,
            "login": "jose-oliveira"
          }
        }
      ]
    }
  ]
}

Lista uma única comunidade

Retorna a comunidade.

GET /communities/:id

Parâmetros:

  • id (obrigatório) - ID da comunidade.
{
  "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"
        }
      }
    ]
  }
}

Cria uma comunidade

Retorna a comunidade criada.

POST /communities

Parâmetros:

  • community[name] (obrigatório) - Nome da comunidade Você pode colocar os outros campos seguindo o padrão community[campo]. A comunidade criada, caso não especificada terá o usuário do private_token como seu administrador.
{
  "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"
        }
      }
    ]
  }
}

Atualiza uma comunidade

Retorna a comunidade atualizada.

POST /communities/:id

Parâmetros:

  • community[name] (obrigatório) - Nome da comunidade 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