Nunciatura Provista

API Documentation V1

Excluir Pronome de Tratamento

Remove um pronome de tratamento do sistema

Este endpoint é do tipo: Protected

Descrição

Remove um pronome de tratamento do sistema com as seguintes funcionalidades:

  • Exclui permanentemente o pronome de tratamento
  • Verifica se o pronome está sendo utilizado por informadores
  • Bloqueia exclusão se houver dependências
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

DELETE

URL BASE

http://api.provista.dev.nabrasil.org.br/v1

ENDPOINT

/treatment-pronouns/{id}

Parâmetros da URL

Parâmetro Tipo Obrigatório Descrição
id integer Sim ID único do pronome de tratamento

Cabeçalhos

Parâmetro Valor
Authorization Bearer <token>
Accept application/json

Respostas

Sucesso - 200

{
  "success": true,
  "message": "Pronome de tratamento excluído com sucesso"
}

Erro - 422 (Em uso)

{
  "success": false,
  "message": "Não é possível excluir este pronome pois está sendo utilizado por informadores"
}

Erro - 404 (Não encontrado)

{
  "success": false,
  "message": "Pronome de tratamento não encontrado"
}

Erro - 401 (Token inválido)

{
  "success": false,
  "message": "Token não fornecido"
}

Códigos de Resposta

Código Descrição
200 Pronome de tratamento excluído com sucesso
401 Token inválido ou expirado
404 Pronome de tratamento não encontrado
422 Pronome está sendo utilizado por informadores