PropriedadeController

1. Cadastro dos Propriedades

Endpoint: /preProducao/propriedade

method: POST

path: /preProducao/propriedade

description: Endpoint para cadastrar

parameters:
  - name: dados
    type: DadosCadastroPropriedade
    description: Parâmetro dados
    required: true
    in: body

Exemplo de requisição:

curl --request POST \
  --url https://<url>/preProducao/propriedade \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "dados": {
      ...
    }
  }'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /preProducao/propriedade

method: GET

path: /preProducao/propriedade

description: Endpoint para listar

parameters:
  - name: size
    type: Integer
    description: Tamanho da página
    required: false
    in: query
  - name: sort
    type: String
    description: Campo de ordenação
    required: false
    in: query

Exemplo de requisição:

curl --request GET \
  --url https://<url>/preProducao/propriedade \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /preProducao/propriedade

method: PUT

path: /preProducao/propriedade

description: Endpoint para atualizar

parameters:
  - name: dados
    type: DadosAtualizacaoPropriedade
    description: Parâmetro dados
    required: true
    in: body

Exemplo de requisição:

curl --request PUT \
  --url https://<url>/preProducao/propriedade \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "dados": {
      ...
    }
  }'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}

Endpoint: /preProducao/propriedade/{id}

method: DELETE

path: /preProducao/propriedade/{id}

description: Endpoint para excluir

parameters:
  - name: id
    type: String
    description: Parâmetro id
    required: true
    in: path

Exemplo de requisição:

curl --request DELETE \
  --url https://<url>/preProducao/propriedade/{id} \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>'

Exemplo de resposta:

{
    "status": "success",
    "message": "Operação realizada com sucesso",
    "data": {}
}

Exemplo de erro:

{
    "status": "error",
    "message": "Erro na operação",
    "code": 500
}