Notificações

• Listar
• Detalhar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista todas as configurações de notificações por níveis.

Parameters

_sort: id (string) ("id") - "Define o campo de ordenação da lista."
_order: desc (string) ("asc", "desc") - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."
alarm_id: 1 (integer, required) - "Filtra por ID do alarme."
level: 1 (integer) - "Filtra por nível de notificação."
delay: 1 (integer) - "Filtra pelo delay da notificação."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "id": 1,
      "alarm_notification_channel_id": 1,
      "alarm_id": 1,
      "user_id": 1,
      "configs": null,
      "level": 1,
      "delay": 2,
      "alarm_notification_channel": {
        "id": 1,
        "name": "E-mails"
      },
      "alarm": {
        "id": 1,
        "name": "Medição Desconectada"
      },
      "user": {
        "id": 1,
        "name": "Super Admin",
        "email": "super.admin@local.com"
      }
    }
  ],
  "total": 1,
  "per_page": 10,
  "current_page": 1
}

{warning} Response 422 (application/json)

Quando os campos filtrados não passarem em alguma validação.

Detalhar

Endpoint que pega a configuração de uma notificação por níveis.

Parameters

id: 1 - (integer, required) - "Id da configuração de uma notificação por nível."

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "alarm_notification_channel_id": 1,
  "alarm_id": 1,
  "user_id": 1,
  "configs": null,
  "level": 1,
  "delay": 2,
  "alarm_notification_channel": {
    "id": 1,
    "name": "E-mails"
  },
  "alarm": {
    "id": 1,
    "name": "Medição Desconectada"
  },
  "user": {
    "id": 1,
    "name": "Super Admin",
    "email": "super.admin@local.com"
  }
}

{warning} Response 404 (application/json)

Quando um registro não for encontrado.

Criar

Endpoint que cria a configuração de uma notificação por níveis.

Attributes

alarm_id: 1 (integer, required) - "ID do alarme"
alarm_notification_channel_id: 1 (integer, required) - "ID do canal de notificação."
user_id: 10 (integer, required) - "ID do usuário dono da configuração de notificação."
configs: ["email@email.com"] (array) - "E-mails a serem notificados."
level: 1 (integer, required) - "Nível da configuração de notificação."
delay: 1 (integer, required) - "Delay em dias da notificação de número anterior para a atual."

Response

{success} Response 201 (application/json)

{
  "id": 6,
  "alarm_notification_channel_id": 1,
  "alarm_id": 2,
  "user_id": 1,
  "configs": null,
  "level": 3,
  "delay": 1,
  "alarm_notification_channel": {
    "id": 1,
    "name": "E-mails",
    "configs": null,
    "created_at": null,
    "updated_at": null
  },
  "alarm": {
    "id": 2,
    "alarms_category_id": 2,
    "account_id": null,
    "name": "Falha de energia",
    "description": "Alarme de desconexão da rede de energia AC",
    "time_confirmation": 0,
    "initial_hour": "00:00",
    "final_hour": "23:59",
    "days_week": [
      0
    ],
    "days_retention": null,
    "status": true,
    "created_at": "2024-07-02T12:51:54.000000Z",
    "updated_at": "2024-07-02T12:51:54.000000Z",
    "deleted_at": null
  },
  "user": {
    "id": 1,
    "active": true,
    "crm_id": null,
    "name": "Super Admin",
    "last_name": null,
    "email": "super.admin@local.com",
    "email_verified_at": null,
    "pincode": null,
    "admin": true,
    "cellphone": null,
    "birth_date": null,
    "avatar": "",
    "last_access": "2025-04-16T13:37:04.000000Z",
    "receive_alert_emails": 0,
    "cognito_user_id": "44d22c38-8d45-45ab-9829-3d764e98b752",
    "migrated": 0
  }
}

{warning} Response 422 (application/json)

{
  "alarm_notification_channel_id": [
    "O campo alarm notification channel id é obrigatório."
  ],
  "alarm_id": [
    "O campo alarm id é obrigatório."
  ],
  "user_id": [
    "O campo user id é obrigatório."
  ],
  "level": [
    "O campo level é obrigatório."
  ],
  "delay": [
    "O campo tempo de espera é obrigatório."
  ],
  "level": [
    "Os níveis vão do 1 ao 3 e o anterior ao solicitado não existe."
  ]
}

Atualizar

Endpoint que atualiza a configuração de uma notificação por níveis.

Attributes

alarm_notification_channel_id: 1 (integer, required) - "ID do canal de notificação."
configs: ["email@email.com"] (array) - "E-mails a serem notificados."
delay: 2 (integer, required) - "ID da frequência de envio da notificação."

Response

{success} Response 200 (application/json)

{
  "id": 4,
  "alarm_notification_channel_id": 1,
  "alarm_id": 2,
  "user_id": 1,
  "configs": null,
  "level": 1,
  "delay": 3,
  "alarm_notification_channel": {
    "id": 1,
    "name": "E-mails",
    "configs": null,
    "created_at": null,
    "updated_at": null
  },
  "alarm": {
    "id": 2,
    "alarms_category_id": 2,
    "account_id": null,
    "name": "Falha de energia",
    "description": "Alarme de desconexão da rede de energia AC",
    "time_confirmation": 0,
    "initial_hour": "00:00",
    "final_hour": "23:59",
    "days_week": [
      0
    ],
    "days_retention": null,
    "status": true,
    "created_at": "2024-07-02T12:51:54.000000Z",
    "updated_at": "2024-07-02T12:51:54.000000Z",
    "deleted_at": null
  },
  "user": {
    "id": 1,
    "active": true,
    "crm_id": null,
    "name": "Super Admin",
    "last_name": null,
    "email": "super.admin@local.com",
    "email_verified_at": null,
    "pincode": null,
    "admin": true,
    "cellphone": null,
    "birth_date": null,
    "avatar": "",
    "last_access": "2025-04-16T20:53:38.000000Z",
    "receive_alert_emails": 0,
    "cognito_user_id": "44d22c38-8d45-45ab-9829-3d764e98b752",
    "migrated": 0
  }
}

{warning} Response 422 (application/json)

["Permissões insuficientes!"]

Deletar

Endpoint que deleta a configuração de uma notificação por níveis.

Response

{primary} Response 204 (application/json)

Quando o registro for excluido com sucesso.

{warning} Response 404 (application/json)

Quando o registro não existe ou não temos permissão de acesso.