front_ponto_eletronico/docs/settings_notificacoes/list.yml

83 lines
2.6 KiB
YAML

tags:
- Settings Notificações
summary: Lista todas as configurações de notificações
description: >
Essa rota retorna uma lista de todas as configurações de notificações cadastradas, podendo ser filtrada por instância de serviço.
parameters:
- in: query
name: service_instance_id
required: false
schema:
type: integer
description: ID da instância de serviço para filtrar as configurações
responses:
200:
description: Lista de configurações retornada com sucesso
content:
application/json:
schema:
type: object
properties:
settings_notificacoes_list:
type: array
items:
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:
settings_notificacoes_list:
- 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"
400:
description: Requisição inválida
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Parâmetro inválido ou ausente"