Atualizar Pronome de Tratamento

Atualiza os dados de um pronome de tratamento existente

Este endpoint é do tipo: Protected

Descrição

Atualiza os dados de um pronome de tratamento existente com as seguintes funcionalidades:

Atualiza nome completo e abreviação do pronome
Altera status ativo/inativo do pronome
Valida unicidade do nome e abreviação (exceto o próprio registro)
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

PUT

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

Parâmetros do Corpo da Requisição

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Sim	Nome completo do pronome (máx. 255 caracteres)
abbreviation	string	Sim	Abreviação do pronome (máx. 10 caracteres)
active	boolean	Não	Status ativo do pronome

Exemplo de Requisição

{
  "name": "Monsenhor",
  "abbreviation": "Mons.",
  "active": false
}

Cabeçalhos

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

Respostas

Sucesso - 200

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Monsenhor",
    "abbreviation": "Mons.",
    "active": false,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T12:00:00.000000Z"
  },
  "message": "Pronome de tratamento atualizado com sucesso"
}

Erro - 404 (Não encontrado)

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

Erro - 422 (Dados inválidos)

{
  "success": false,
  "message": "Os dados fornecidos são inválidos.",
  "errors": {
    "name": ["O nome da categoria é obrigatório."],
    "abbreviation": ["Já existe uma categoria com esta abreviação."]
  }
}

Erro - 401 (Token inválido)

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

Códigos de Resposta

Código	Descrição
200	Pronome de tratamento atualizado com sucesso
401	Token inválido ou expirado
404	Pronome de tratamento não encontrado
422	Dados de validação inválidos

Nunciatura Provista