Pular para o conteúdo principal

Deletar arquivos do contrato

POST /delete_contract_files

Resumo

Este endpoint permite excluir arquivos anexados a um contrato em uma unidade específica.


Descrição

Utilize este endpoint para excluir arquivos anexados a um contrato. O contato deve existir e estar associado à unidade informada.


Requisição

Body da Requisição

O corpo deve ser um objeto JSON com os seguintes parâmetros:

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringSimToken identificador da unidade.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_token_contractstringSimToken identificador do contato a ser ativado.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
filenameslistSimLista de nome dos arquivos para serem excluidos. Os nomes dos arquivos podem ser achados como filename em /list_contracts[<filename1>, <filename2>]

Exemplo de Requisição

Curl

curl -X POST 'https://portal.fipli.pro/api/v1/delete_contract_files' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "<access_token>",
"unit_token": "<unit_token>",
"id_token_contract": "<id_token_contract>",
"filenames": ["<filename1>, <filename2>"]
}'

Resposta

200 OK

Exclusão dos arquivos realizada com sucesso.

{
"success": true,
"message": "Success deleting contract files",
"data": null
}

Erros Comuns

StatusMensagemDescrição
400"Missing parameters"Algum parâmetro obrigatório (access_token, unit_token, id_token_contract, filenames) não foi enviado.
403"Invalid data"Token de autenticação inválido ou não autorizado.
500"Something went wrong. Please try again later."Erro interno no servidor.