Alarme

• Listar
• Pegar
• Criar
• Atualizar
• Remover

Listar

Endpoint que lista todos os alarmes.

Parameters

_q: alarme x (string) - "Busca alarme pelo nome ou descrição."
_sort: id (string) ("id", "name", "status") - "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."
status: 1 (bool) - "Filtra alarme pelo status."
alarms_category_id: 1 (integer) - "Filtra alarme pelo ID da categoria."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
        "id": 1,
        "name": "Perda de comunicação com o Medidor",
        "description": "Quando probe envia status Sem sinal codi",
        "time_confirmation": 0,
        "initial_hour": null,
        "final_hour": null,
        "days_week": null,
        "days_retention": null,
        "status": true,
        "account_id": null,
        "category": {
            "id": 1,
            "name": "Sistema"
        }
    },
    {
        "id": 2,
        "name": "Alarme consumo",
        "description": null,
        "time_confirmation": 900,
        "initial_hour": "18:00",
        "final_hour": "23:59",
        "days_week": [5,6],
        "days_retention": 30,
        "status": false,
        "account_id": {
            "id": 1,
            "name": "Conta X"
        },
        "category": {
            "id": 3,
            "name": "Usuário"
        }
    }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}

{primary} Response 204 (application/json)

Quando os critérios de parâmetros não contiver registros a serem retornados.

{warning} Response 422 (application/json)

{
    "alarms_category_id": [
        "O campo alarms category id selecionado é inválido."
    ]
}

Pegar

Endpoint que pega um alarme.

Parameters

alarmId: 2 - (integer, required) - "Id do alarme."

Response

{success} Response 200 (application/json)

{
    "id": 2,
    "name": "Alarme consumo",
    "description": null,
    "time_confirmation": 900,
    "initial_hour": "18:00",
    "final_hour": "23:59",
    "days_week": [5,6],
    "days_retention": 30,
    "status": false,
    "account_id": {
        "id": 1,
        "name": "Conta X"
    },
    "category": {
        "id": 1,
        "name": "Sistema"
    }
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Criar

Endpoint que cria um alarme.

Attributes

alarms_category_id: 2 (integer, required) - "ID da categoria do alarme."
name: "Alarme consumo" (string, required) - "Nome do alarme"
description: "Alarme ..." (string) - "Descrição do alarme"
time_confirmation: 900 (integer, required) - "Tempo em segundos necessário para confirmar o acionamento do alarme"
initial_hour: "00:00" (string, required) - "Horário inicial quando o alarme deve ser monitorado apenas dentro de um período do dia"
final_hour: "06:00" (string, required) - "Horário final quando o alarme deve ser monitorado apenas dentro de um período do dia"
days_week: [5,6] (array[integer], required) - "Dias da semana de (0 a 6), que o alarme deve ser monitorado"
days_retention: 30 (integer) - "Dias que o sistema irá armazenar as ocorrências desse alarme"
status: true (bool, required) - "Status do alarme"
account_id: 1 (integer) - "ID da conta que o alarme pertence."

{info} Superadmin pode cadastrar alarme nas categorias 2 (Operação) e 3 (Usuário).
Usuário comun só pode cadastrar na categoria 3.
Quando o campo account_id não for informado, será atribuido a conta do usuário que está realizando o cadastro.

{warning} Quando o alarme for da categoria 2 (Operação), não pode enviar o account_id.

Response

{success} Response 201 (application/json)

{
    "id": 2,
    "name": "Alarme consumo",
    "description": null,
    "time_confirmation": 900,
    "initial_hour": "18:00",
    "final_hour": "23:59",
    "days_week": [5,6],
    "days_retention": 30,
    "status": false,
    "account_id": {
        "id": 1,
        "name": "Conta X"
    },
    "category": {
        "id": 1,
        "name": "Sistema"
    }
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Atualizar

Endpoint que atualiza um alarme.

Attributes

name: "Alarme consumo" (string) - "Nome do alarme"
description: "Alarme ..." (string) - "Descrição do alarme"
time_confirmation: 900 (integer) - "Tempo em segundos necessário para confirmar o acionamento do alarme"
initial_hour: "00:00" (string) - "Horário inicial quando o alarme deve ser monitorado apenas dentro de um período do dia"
final_hour: "06:00" (string) - "Horário final quando o alarme deve ser monitorado apenas dentro de um período do dia"
days_week: [5,6] (array[integer]) - "Dias da semana de (0 a 6), que o alarme deve ser monitorado"
days_retention: 30 (integer) - "Dias que o sistema irá armazenar as ocorrências desse alarme"
status: true (bool) - "Status do alarme"

{info} Não é possível atualizar os campos: alarms_category_id e account_id.

Response

{success} Response 200 (application/json)

{
    "id": 2,
    "name": "Alarme consumo",
    "description": null,
    "time_confirmation": 900,
    "initial_hour": "18:00",
    "final_hour": "23:59",
    "days_week": [5,6],
    "days_retention": 30,
    "status": false,
    "account_id": {
        "id": 1,
        "name": "Conta X"
    },
    "category": {
        "id": 1,
        "name": "Sistema"
    }
}

{warning} Response 400 (application/json)

Quando ocorre algum erro.

Deletar

Endpoint que deleta um alarme.

Response

{primary} Response 204 (application/json)

Quando o registro for excluido com sucesso.

{warning} Response 400 (application/json)

Quando ocorre algum erro.