Nunciatura Provista

API Documentation V1

Visualizar Pronome de Tratamento

Retorna os dados de um pronome de tratamento específico

Este endpoint é do tipo: Protected

Descrição

Retorna os dados completos de um pronome de tratamento específico:

  • Exibe nome completo e abreviação do pronome
  • Mostra status ativo/inativo
  • Inclui timestamps de criação e atualização
  • Requer autenticação JWT válida

Detalhes do Endpoint

VERBO

GET

URL BASE

http://api.provista.hmg.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,
  "data": {
    "id": 1,
    "name": "Senhor",
    "abbreviation": "Sr.",
    "active": true,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

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 retornado com sucesso
401 Token inválido ou expirado
404 Pronome de tratamento não encontrado