CompartilhamentoController

Informações dos compartilhamentos de dados entre usuários e Apis Keys

Endpoint: /compartilhamento

method: POST

path: /compartilhamento

description: Endpoint para cadastrar

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

Exemplo de requisição:

curl --request POST \
  --url https://<url>/compartilhamento \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "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: /compartilhamento

method: GET

path: /compartilhamento

description: Endpoint para listar

parameters:
  - name: =
    type: (size
    description: Parâmetro =
    required: false
    in: query
  - name: =
    type: sort
    description: Parâmetro =
    required: false
    in: query

Exemplo de requisição:

curl --request GET \
  --url https://<url>/compartilhamento \
  --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: /compartilhamento

method: PUT

path: /compartilhamento

description: Endpoint para atualizar

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

Exemplo de requisição:

curl --request PUT \
  --url https://<url>/compartilhamento \
  --header 'X-API-ACCESS-KEY: <chave_de_acesso>' \
  --header 'X-API-SECRET-KEY: <chave_de_seguranca>' \
  -d '{
    "safraId": "<id_safra>",
    "safraCodigo": "<codigo_safra>",
    "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: /compartilhamento/{id}

method: DELETE

path: /compartilhamento/{id}

description: Endpoint para excluir

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

Exemplo de requisição:

curl --request DELETE \
  --url https://<url>/compartilhamento/{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
}