PropriedadeProprietarioController

1. Cadastro da Associação Propriedade x Proprietario

Endpoint: /preProducao/propriedadeProprietario

method: GET

path: /preProducao/propriedadeProprietario

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/propriedadeProprietario \
  --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/propriedadeProprietario/proprietario/{proprietarioId}/propriedade/{propriedadeId}

method: POST

path: /preProducao/propriedadeProprietario/proprietario/{proprietarioId}/propriedade/{propriedadeId}

description: Endpoint para criarPropriedadeProprietario

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

Exemplo de requisição:

curl --request POST \
  --url https://<url>/preProducao/propriedadeProprietario/proprietario/{proprietarioId}/propriedade/{propriedadeId} \
  --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/propriedadeProprietario/proprietario/{proprietarioId}/propriedades

method: GET

path: /preProducao/propriedadeProprietario/proprietario/{proprietarioId}/propriedades

description: Endpoint para getPropriedadesDoProprietario

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

Exemplo de requisição:

curl --request GET \
  --url https://<url>/preProducao/propriedadeProprietario/proprietario/{proprietarioId}/propriedades \
  --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/propriedadeProprietario/propriedade/{propriedadeId}/proprietarioes

method: GET

path: /preProducao/propriedadeProprietario/propriedade/{propriedadeId}/proprietarioes

description: Endpoint para getProprietarioesDaPropriedade

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

Exemplo de requisição:

curl --request GET \
  --url https://<url>/preProducao/propriedadeProprietario/propriedade/{propriedadeId}/proprietarioes \
  --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
}