Header

Servicios API Rest Disponibles

GET - Consulta de Carga General

Ejemplo de respuesta JSON - Servicio /api/cargageneral

    [
      {
        "Id": 3,
        "NodeAddress": 5026621,
        "NodeNetworkId": 4877723,
        "Alarm": "none",
        "State": "default",
        "FormattedLastUpdate": "2023-10-03T16:12:45",
        "Battery": 3828,
        "BatteryStatus": "Full",
        "ZoneDescription": "2",
        "Status": "offline"
      },
      {
        "Id": 2,
        "NodeAddress": 5026620,
        "NodeNetworkId": 4877723,
        "Alarm": "none",
        "State": "default",
        "FormattedLastUpdate": "2023-10-03T16:12:57",
        "Battery": 3772,
        "BatteryStatus": "Full",
        "ZoneDescription": "1",
        "Status": "online"
      }
    ]

Desglose de la estructura JSON

Campo Tipo Descripción
Id int Identificador único del registro.
NodeAddress int Dirección única del beacon (nodo).
NodeNetworkId int ID de red del beacon.
Alarm string Estado de la alarma del nodo. Valores: none, button_short, button_long.
State string Estado del nodo. Valores: default, motion, alarm, sleep.
FormattedLastUpdate datetime Última fecha y hora de actualización con formato ISO. Ejemplo: 2025-07-02T10:31:08
Battery int Voltaje de batería del beacon en milivoltios. Ejemplo: 2970, 2958, 3808.
BatteryStatus string Estado estimado de la batería. Valores: Full, Half, Low.
ZoneDescription string Zona actual donde está ubicado el beacon. Ejemplo: anden_01, patio_descanso, entrada_cedis_01. (20 caracteres)
Status string Estado de disponibilidad del nodo. Valores: online, offline.

GET - Consulta de Carga General con Sleep Definido

URL: /api/cargageneralSleepDefinido

Regresa la misma estructura de /api/cargageneral, pero consulta el tiempo configurado en tblTiempoSleep. Si el tiempo es mayor a 0, no muestra registros con State = sleep cuyo FormattedLastUpdate sea anterior al rango configurado. Si el tiempo es 0, no se aplica ningun filtro de sleep.

GET - Consultar Tiempo Sleep

URL: /api/tiemposleep

Regresa el tiempo configurado en minutos y si actualmente se aplica el filtro de sleep.

POST - Actualizar Tiempo Sleep

URL: /api/tiemposleep

El rango permitido es de 0 a 30 minutos. No se registrara ningun valor fuera de ese rango. El valor 0 significa que no se aplica ningun filtro de sleep.

Body (JSON):

        {
          "minutos": 5
        }

Ejemplo de respuesta JSON - Servicio /api/tiemposleep

    {
        "mensaje": "Tiempo sleep actualizado correctamente",
        "minutos": 5,
        "aplicaFiltro": true,
        "descripcion": "Se ocultan registros en sleep con formattedLastUpdate anterior al tiempo configurado."
    }

POST - Actualizar Disponibilidad de Beacon

URL: /api/beacon/disponibilidad

Body (JSON):

        {
          "nodeAddress": 5026620,
          "available": true
        }

Ejemplo de respuesta JSON - Servicio /api/beacon/disponibilidad

    {
        "mensaje": "Disponibilidad actualizada correctamente",
        "node_address": 5026620,
        "available": true,
        "fecha": "2025-07-26T13:09:29.6144616-07:00"
    }
Footer