front_ponto_eletronico/docs/settings_notificacoes/update.yml

96 lines
2.6 KiB
YAML

tags:
- Settings Notificações
summary: Atualiza uma configuração de notificações existente
description: >
Essa rota permite atualizar uma configuração de notificações especificada pelo ID.
parameters:
- in: path
name: settings_id
required: true
schema:
type: integer
description: ID da configuração que será atualizada.
- in: body
name: body
description: Dados para a atualização da configuração de notificações.
required: true
schema:
type: object
properties:
notificar_esquecimento_ponto:
type: string
example: "True"
notificar_horas_extras:
type: string
example: "True"
notificar_solicitacao_pendentes:
type: string
example: "True"
notificar_banco_horas:
type: string
example: "True"
notificar_gestor:
type: string
example: "False"
relatorios_email:
type: string
example: "True"
relatorios_diario_gestor:
type: string
example: "False"
relatorios_semanal_colaboradores:
type: string
example: "True"
service_instance_id:
type: integer
example: 1
responses:
200:
description: Configuração de notificações atualizada com sucesso
content:
application/json:
schema:
type: object
properties:
message:
type: string
examples:
application/json:
message: "Configuração de notificações atualizada com sucesso"
400:
description: Requisição inválida
content:
application/json:
schema:
type: object
properties:
error:
type: string
examples:
application/json:
error: "Campos obrigatórios ausentes ou inválidos."
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"