Criar Pronome de Tratamento

Cria um novo pronome de tratamento no sistema

Este endpoint é do tipo: Protected

Descrição

Cria um novo pronome de tratamento no sistema com as seguintes funcionalidades:

Cadastra nome completo e abreviação do pronome
Define status ativo/inativo do pronome
Valida unicidade do nome e abreviação
Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

POST

URL BASE

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

ENDPOINT

/treatment-pronouns

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 (padrão: true)

Exemplo de Requisição

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

Cabeçalhos

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

Respostas

Sucesso - 201

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

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
201	Pronome de tratamento criado com sucesso
401	Token inválido ou expirado
422	Dados de validação inválidos

Nunciatura Provista