Back to top

Cadtreesa API

API do projeto Cadtreesa (Cadastro de Árvores de Sistemas & Agrícolas), projeto realizado durante a disciplina de Conceitos de Linaguagens de Programação ministrada pelo professor Lauro Ricardo do curso de Sistemas de Informação da Universidade Federal de Mato Grosso, Campus Universitário de Rondonópolis. API realizada para prover dados a aplicação android e a página web do projeto.

API-REST-Cadtreesa

Sobre

API construida com respostas em formato JSON (JavaScript Object Notation) utilizando os métodos de requisição do protocolo HTTP, sendo POST, GET, PUT e DELETE com autorização Bearer Token com JWT.

Usuários

Users

Login de usuário
POST/users/login

Example URI

POST http://localhost:4000/v1/users/login
Request  Fazer login
HideShow
Headers
Accept: application/json
Content-Type: application/json
Body
{
  "email": "Hello, world!",
  "password": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Endereço de e-mail válido"
    },
    "password": {
      "type": "string",
      "description": "Senha do usuário"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Authorization: Bearer JWT
Body
{
  "login": true,
  "access_token": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "login": {
      "type": "boolean",
      "description": "Logado"
    },
    "access_token": {
      "type": "string",
      "description": "JWT"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Logout de usuário
POST/users/logout

Example URI

POST http://localhost:4000/v1/users/logout
Request  Fazer logout
HideShow
Headers
Authorization: Bearer JWT
Response  204
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Tempo esgotado na sessão do usuário
POST/users/timeout

Example URI

POST http://localhost:4000/v1/users/timeout
Request  Dar timeout na sessão
HideShow
Headers
Authorization: Bearer JWT
Response  204
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Solicitar recuperação de senha
POST/users/forgot_password

Example URI

POST http://localhost:4000/v1/users/forgot_password
Request  Solicitar recuperação
HideShow
Headers
Accept: application/json
Content-Type: application/json
Body
{
  "email": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Email válido"
    }
  }
}
Response  202
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Alterar senha
POST/users/change_password{?token}

Example URI

POST http://localhost:4000/v1/users/change_password?token=hdQWdw.dWend33kld.Wdllksad
URI Parameters
HideShow
token
string (required) Example: hdQWdw.dWend33kld.Wdllksad

Json Web Token

Request  Alterar senha
HideShow
Headers
Accept: application/json
Content-Type: application/json
Body
{
  "password": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "password": {
      "type": "string",
      "description": "Senha com o minimo de 5 caracteres"
    }
  }
}
Response  204
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Verificar senha
POST/users/check_pass

Example URI

POST http://localhost:4000/v1/users/check_pass
Request  Verificar senha de usuário
HideShow
Headers
Accept: application/json
Content-Type: application/json
Authorization: Bearer JWT
Body
{
  "password": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "password": {
      "type": "string",
      "description": "Senha com o minimo de 5 caracteres"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "check": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "check": {
      "type": "boolean",
      "description": "Se coincide com a verificação"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Criar usuários
POST/users

Example URI

POST http://localhost:4000/v1/users
Request  Criar um novo usuário
HideShow
Headers
Accept: application/json
Content-Type: application/json
Body
{
  "name": "Hello, world!",
  "rgacpf": "Hello, world!",
  "email": "Hello, world!",
  "password": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome do usuário completo"
    },
    "rgacpf": {
      "type": "string",
      "description": "RGA de matrícula ou CPF caso professor"
    },
    "email": {
      "type": "string",
      "description": "Endereço de e-mail válido"
    },
    "password": {
      "type": "string",
      "description": "Senha do usuário"
    }
  }
}
Response  201
HideShow
Headers
Content-Type: application/json
Content-Location: /v1/users/1
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id gerado"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Listar todos usuários
GET/users{?extends}{&order}{&limit}{&offset}

Example URI

GET http://localhost:4000/v1/users?extends=users&order=id&limit=10&offset=5
URI Parameters
HideShow
extends
string (optional) Example: users

Extender dados na consulta

Choices: users

order
string (optional) Example: id

Ordem dos resultados

Choices: id name created

limit
number (optional) Example: 10

Limite de registros

offset
number (optional) Example: 5

Passo do registro. Requer limit

Request  Listar dados de todos usuários
HideShow
Headers
Authorization: Bearer JWT
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "metadata": {
    "count": 1,
    "offset": 1,
    "limit": 1,
    "size": 1
  },
  "results": [
    {
      "id": 1,
      "name": "Hello, world!",
      "rgacpf": "Hello, world!",
      "email": "Hello, world!",
      "password": "Hello, world!",
      "hash": "Hello, world!",
      "type": "Hello, world!",
      "status": "Hello, world!",
      "created": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Quantidade de registros retornados"
        },
        "offset": {
          "type": "number",
          "description": "Inicio da leitura"
        },
        "limit": {
          "type": "number",
          "description": "Maximo de registros"
        },
        "size": {
          "type": "number",
          "description": "Quantidade total de registros"
        }
      }
    },
    "results": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Listar árvores por usuário
GET/users/{id}/trees{?extends}{&order}{&limit}{&offset}

Example URI

GET http://localhost:4000/v1/users/1/trees?extends=users&order=name&limit=7&offset=2
URI Parameters
HideShow
id
number (required) Example: 1
extends
string (optional) Example: users

Extender dados na consulta

Choices: users

order
string (optional) Example: name

Ordem dos resultados

Choices: id name specie created

limit
number (optional) Example: 7

Limite de registros

offset
number (optional) Example: 2

Passo do registro. Requer limit

Request  Listar dados de árvores por usuários
HideShow
Headers
Authorization: Bearer JWT
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "metadata": {
    "count": 0,
    "offset": 0,
    "limit": 0,
    "size": 0,
    "father": ""
  },
  "results": [
    {
      "id": 0,
      "name": "",
      "specie": "",
      "family": "",
      "cap": "",
      "height": "",
      "classcup": "",
      "sanity": "",
      "growth": "",
      "sociological": "",
      "utilization": "",
      "features": "",
      "image": "",
      "latitude": 0,
      "longitude": 0,
      "created": "",
      "validated": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Quantidade de registros retornados"
        },
        "offset": {
          "type": "number",
          "description": "Inicio da leitura"
        },
        "limit": {
          "type": "number",
          "description": "Maximo de registros"
        },
        "size": {
          "type": "number",
          "description": "Quantidade total de registros"
        },
        "father": {
          "type": "string",
          "description": "link da entidade pai"
        }
      }
    },
    "results": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Listar uma árvore por usuário
GET/users/{id_user}/trees/{id_tree}

Example URI

GET http://localhost:4000/v1/users/1/trees/1
URI Parameters
HideShow
id_user
number (required) Example: 1
id_tree
number (required) Example: 1
Request  Listar dados de árvores por usuários
HideShow
Headers
Authorization: Bearer JWT
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "metadata": {
    "father": ""
  },
  "results": {
    "id": 0,
    "name": "",
    "specie": "",
    "family": "",
    "cap": "",
    "height": "",
    "classcup": "",
    "sanity": "",
    "growth": "",
    "sociological": "",
    "utilization": "",
    "features": "",
    "image": "",
    "latitude": 0,
    "longitude": 0,
    "created": "",
    "validated": false
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "father": {
          "type": "string",
          "description": "link da entidade pai"
        }
      }
    },
    "results": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "Id da árvore"
        },
        "name": {
          "type": "string",
          "description": "Nome da árvore"
        },
        "specie": {
          "type": "string",
          "description": "Espécie na classificação ciêntifica"
        },
        "family": {
          "type": "string",
          "description": "Família da espécie"
        },
        "cap": {
          "type": "string",
          "description": "Circunferência da altura do peito"
        },
        "height": {
          "type": "string",
          "description": "Altura total da árvore"
        },
        "classcup": {
          "description": "Classe da copa (ample, mediana, curta)"
        },
        "sanity": {
          "type": "string",
          "description": "Sanidade da árvore (boa, média, ruim)"
        },
        "growth": {
          "type": "string",
          "description": "Crescimento da árvore (lento, devagar, rápido)"
        },
        "sociological": {
          "type": "string",
          "description": "Posição sociológica (emergente, superior, médio, inferior, isolada)"
        },
        "utilization": {
          "type": "string",
          "description": "Utilização da árvore no meio que atua"
        },
        "features": {
          "type": "string",
          "description": "Características principais"
        },
        "image": {
          "type": "string",
          "description": "Imagem da árvore"
        },
        "latitude": {
          "type": "number",
          "description": "Latitude da localização da árvore"
        },
        "longitude": {
          "type": "number",
          "description": "Longitude da localização da árvore"
        },
        "created": {
          "type": "string",
          "description": "Data de criação"
        },
        "validated": {
          "type": "boolean",
          "description": "Status da árvore (1 validada, 0 não validada)"
        }
      }
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Listar usuário
GET/users/{id}{?extends}

Example URI

GET http://localhost:4000/v1/users/1?extends=trees
URI Parameters
HideShow
id
number (required) Example: 1

ID do usuário

extends
string (optional) Example: trees

Extender dados na consulta

Choices: trees

Request  Listar dados de um usuário
HideShow
Headers
Authorization: Bearer JWT
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "name": "Hello, world!",
  "rgacpf": "Hello, world!",
  "email": "Hello, world!",
  "password": "Hello, world!",
  "hash": "Hello, world!",
  "type": "Hello, world!",
  "status": "Hello, world!",
  "created": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id do usuário"
    },
    "name": {
      "type": "string",
      "description": "Nome do usuário completo"
    },
    "rgacpf": {
      "type": "string",
      "description": "RGA de matrícula ou CPF caso professor"
    },
    "email": {
      "type": "string",
      "description": "Endereço de e-mail válido"
    },
    "password": {
      "type": "string",
      "description": "Senha do usuário"
    },
    "hash": {
      "type": "string",
      "description": "Hash de criação do usuário"
    },
    "type": {
      "type": "string",
      "description": "Tipo do usuário"
    },
    "status": {
      "type": "string",
      "description": "Estado atual do usuário"
    },
    "created": {
      "type": "string",
      "description": "Data de criação do usuário"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Obter metadados
HEAD/users/info

Example URI

HEAD http://localhost:4000/v1/users/info
Request  Obter metadados da entidade usuários
HideShow
Headers
Authorization: Bearer JWT
Response  204
HideShow
Headers
X-Total-Count: 56
Response  401
Response  403
Response  500

Users

Editar usuário
PATCH/users/{id}

Example URI

PATCH http://localhost:4000/v1/users/1
URI Parameters
HideShow
id
number (required) Example: 1

ID do usuário

Request  Editar parcialmente os dados de um usuário
HideShow
Headers
Authorization: Bearer JWT
Accept: application/json
Content-Type: application/json
Body
{
  "field": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "Campo de edição, nome, rgacpf ou email"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id a ser processado"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Editar usuário
PUT/users/{id}

Example URI

PUT http://localhost:4000/v1/users/1
URI Parameters
HideShow
id
number (required) Example: 1

ID do usuário

Request  Editar dados de um usuário
HideShow
Headers
Authorization: Bearer JWT
Accept: application/json
Content-Type: application/json
Body
{
  "name": "Hello, world!",
  "rgacpf": "Hello, world!",
  "email": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome do usuário completo"
    },
    "rgacpf": {
      "type": "string",
      "description": "RGA de matrícula ou CPF caso professor"
    },
    "email": {
      "type": "string",
      "description": "Endereço de e-mail válido"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id a ser processado"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Users

Remover usuário
DELETE/users/{id}

Example URI

DELETE http://localhost:4000/v1/users/1
URI Parameters
HideShow
id
number (required) Example: 1

ID do usuário

Request  Remover usuário
HideShow
Headers
Authorization: Bearer JWT
Response  204
HideShow
Headers
Content-Type: application/json
Entity: 1
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Árvores

Trees

Criar árvores
POST/trees

Example URI

POST http://localhost:4000/v1/trees
Request  Criar uma nova árvore
HideShow
Headers
Authorization: Bearer JWT
Accept: application/json
Content-Type: application/json
Body
{
  "name": "",
  "specie": "",
  "family": "",
  "cap": "",
  "height": "",
  "classcup": "",
  "sanity": "",
  "growth": "",
  "sociological": "",
  "utilization": "",
  "features": "",
  "image": "",
  "latitude": 0,
  "longitude": 0
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome da árvore"
    },
    "specie": {
      "type": "string",
      "description": "Espécie na classificação ciêntifica"
    },
    "family": {
      "type": "string",
      "description": "Família da espécie"
    },
    "cap": {
      "type": "string",
      "description": "Circunferência da altura do peito"
    },
    "height": {
      "type": "string",
      "description": "Altura total da árvore"
    },
    "classcup": {
      "description": "Classe da copa (ample, mediana, curta)"
    },
    "sanity": {
      "type": "string",
      "description": "Sanidade da árvore (boa, média, ruim)"
    },
    "growth": {
      "type": "string",
      "description": "Crescimento da árvore (lento, devagar, rápido)"
    },
    "sociological": {
      "type": "string",
      "description": "Posição sociológica (emergente, superior, médio, inferior, isolada)"
    },
    "utilization": {
      "type": "string",
      "description": "Utilização da árvore no meio que atua"
    },
    "features": {
      "type": "string",
      "description": "Características principais"
    },
    "image": {
      "type": "string",
      "description": "Imagem da árvore"
    },
    "latitude": {
      "type": "number",
      "description": "Latitude da localização da árvore"
    },
    "longitude": {
      "type": "number",
      "description": "Longitude da localização da árvore"
    }
  }
}
Response  201
HideShow
Headers
Content-Type: application/json
Content-Location: /v1/trees/1
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id gerado"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Trees

Listar todas as árvores
GET/trees{?extends}{&order}{&limit}{&offset}

Example URI

GET http://localhost:4000/v1/trees?extends=users&order=specie&limit=20&offset=2
URI Parameters
HideShow
extends
string (optional) Example: users

Extender dados na consulta

Choices: users

order
string (optional) Example: specie

Ordem dos resultados

Choices: id name specie created

limit
number (optional) Example: 20

Limite de registros

offset
number (optional) Example: 2

Passo do registro. Requer limit

Request  Listar dados de todas árvores
HideShow
Headers
Authorization: Bearer JWT
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "metadata": {
    "count": 0,
    "offset": 0,
    "limit": 0,
    "size": 0
  },
  "results": [
    {
      "id": 0,
      "name": "",
      "specie": "",
      "family": "",
      "cap": "",
      "height": "",
      "classcup": "",
      "sanity": "",
      "growth": "",
      "sociological": "",
      "utilization": "",
      "features": "",
      "image": "",
      "latitude": 0,
      "longitude": 0,
      "created": "",
      "validated": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Quantidade de registros retornados"
        },
        "offset": {
          "type": "number",
          "description": "Inicio da leitura"
        },
        "limit": {
          "type": "number",
          "description": "Maximo de registros"
        },
        "size": {
          "type": "number",
          "description": "Quantidade total de registros"
        }
      }
    },
    "results": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Trees

Listar árvore
GET/trees/{id}{?extends}

Example URI

GET http://localhost:4000/v1/trees/1?extends=
URI Parameters
HideShow
id
number (required) Example: 1

ID da árvore

extends
string (optional) 

Extender dados na consulta

Choices: users

Request  Listar dados de uma árvore
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 0,
  "name": "",
  "specie": "",
  "family": "",
  "cap": "",
  "height": "",
  "classcup": "",
  "sanity": "",
  "growth": "",
  "sociological": "",
  "utilization": "",
  "features": "",
  "image": "",
  "latitude": 0,
  "longitude": 0,
  "created": "",
  "validated": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id da árvore"
    },
    "name": {
      "type": "string",
      "description": "Nome da árvore"
    },
    "specie": {
      "type": "string",
      "description": "Espécie na classificação ciêntifica"
    },
    "family": {
      "type": "string",
      "description": "Família da espécie"
    },
    "cap": {
      "type": "string",
      "description": "Circunferência da altura do peito"
    },
    "height": {
      "type": "string",
      "description": "Altura total da árvore"
    },
    "classcup": {
      "description": "Classe da copa (ample, mediana, curta)"
    },
    "sanity": {
      "type": "string",
      "description": "Sanidade da árvore (boa, média, ruim)"
    },
    "growth": {
      "type": "string",
      "description": "Crescimento da árvore (lento, devagar, rápido)"
    },
    "sociological": {
      "type": "string",
      "description": "Posição sociológica (emergente, superior, médio, inferior, isolada)"
    },
    "utilization": {
      "type": "string",
      "description": "Utilização da árvore no meio que atua"
    },
    "features": {
      "type": "string",
      "description": "Características principais"
    },
    "image": {
      "type": "string",
      "description": "Imagem da árvore"
    },
    "latitude": {
      "type": "number",
      "description": "Latitude da localização da árvore"
    },
    "longitude": {
      "type": "number",
      "description": "Longitude da localização da árvore"
    },
    "created": {
      "type": "string",
      "description": "Data de criação"
    },
    "validated": {
      "type": "boolean",
      "description": "Status da árvore (1 validada, 0 não validada)"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Trees

Obter metadados
HEAD/trees/info

Example URI

HEAD http://localhost:4000/v1/trees/info
Request  Obter metadados da entidade árvores
HideShow
Headers
Authorization: Bearer JWT
Response  204
HideShow
Headers
X-Total-Count: 33
X-Total-Count-Validated: 12
Response  401
Response  403
Response  500

Trees

Editar árvore
PUT/trees/{id}

Example URI

PUT http://localhost:4000/v1/trees/1
URI Parameters
HideShow
id
number (required) Example: 1

ID da árvore

Request  Editar dados de uma árvore
HideShow
Headers
Authorization: Bearer JWT
Accept: application/json
Content-Type: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Id a ser processado"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  415
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Trees

Remover árvore
DELETE/trees/{id}

Example URI

DELETE http://localhost:4000/v1/trees/1
URI Parameters
HideShow
id
number (required) Example: 1

ID da árvore

Request  Remover árvore
HideShow
Headers
Authorization: Bearer JWT
Response  204
HideShow
Headers
Content-Type: application/json
Entity: 1
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  403
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

E-mails

E-mails

Enviar e-mail
POST/mail

Example URI

POST http://localhost:4000/v1/mail
Request  Enviar mensagem por email
HideShow
Headers
Accept: application/json
Content-Type: application/json
Body
{
  "name": "Hello, world!",
  "email": "Hello, world!",
  "subject": "Hello, world!",
  "message": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Nome do remetente"
    },
    "email": {
      "type": "string",
      "description": "Email válido do remetente"
    },
    "subject": {
      "type": "string",
      "description": "Assunto da mensagem"
    },
    "message": {
      "type": "string",
      "description": "Mensagem"
    }
  }
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

QrCode

QrCode

Gerar código QR
GET/qrcode{?url}

Example URI

GET http://localhost:4000/v1/qrcode?url=https:/github.com
URI Parameters
HideShow
url
string (required) Example: https://github.com

URL a ser codificada

Request  Gerar código QR de URL
Response  200
HideShow
Headers
Content-Type: image/png
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "errors": [
    {
      "code": 1,
      "field": "Hello, world!",
      "message": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Código do erro"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do erro"
    },
    "errors": {
      "type": "array"
    }
  }
}
Response  500
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 1,
  "message": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "description": "Status code"
    },
    "message": {
      "type": "string",
      "description": "Mensagem do status"
    },
    "description": {
      "type": "string",
      "description": "Descrição do status"
    }
  }
}

Generated by aglio on 25 Apr 2018