front_ponto_eletronico/docs/settings_notificacoes/get.yml

76 lines
2.2 KiB
YAML

tags:
- Settings Notificações
summary: Busca uma configuração de notificações por ID
description: >
Essa rota retorna os detalhes de uma configuração de notificações com base no ID informado.
parameters:
- in: path
name: id
required: true
schema:
type: integer
description: ID da configuração de notificações.
responses:
200:
description: Detalhes da configuração retornados com sucesso
content:
application/json:
schema:
type: object
properties:
id:
type: integer
notificar_esquecimento_ponto:
type: string
notificar_horas_extras:
type: string
notificar_solicitacao_pendentes:
type: string
notificar_banco_horas:
type: string
notificar_gestor:
type: string
relatorios_email:
type: string
relatorios_diario_gestor:
type: string
relatorios_semanal_colaboradores:
type: string
service_instance_id:
type: integer
examples:
application/json:
id: 1
notificar_esquecimento_ponto: "True"
notificar_horas_extras: "True"
notificar_solicitacao_pendentes: "True"
notificar_banco_horas: "True"
notificar_gestor: "False"
relatorios_email: "True"
relatorios_diario_gestor: "False"
relatorios_semanal_colaboradores: "True"
service_instance_id: 1
401:
description: Token inválido ou ausente
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Token inválido ou ausente"
404:
description: Configuração não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Configuração não encontrada"