Listar Alertas do Dispositivo
Obtém o histórico de alertas e alarmes do dispositivo no período especificado.
Requisição HTTP
| Método | Caminho (Path) |
|---|---|
GET | /api/alarm/list2 |
Parâmetros de Consulta (Query)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
access_token | string | true | O token de acesso. |
imei | string | true | IMEI de destino. |
begintime | long | true | Tempo inicial (carimbo de data/hora UNIX em segundos). |
endtime | long | true | Tempo final (carimbo de data/hora UNIX em segundos). |
Exemplo
Request URL:
GET https://api.brasilsatgps.com.br/api/alarm/list2?access_token={ACCESS_TOKEN}&imei=358899123456789&begintime=1541575497&endtime=1541575598Estrutura de Retorno (Schema)
| Campo JSON | Tipo de Dado | Descrição |
|---|---|---|
record | Array | Lista de objetos de registro de alertas. |
record[].alarmtype | int | Tipo de alerta. Para detalhes, consulte a tabela de Tipos de Alerta. |
record[].longitude | double | Longitude. |
record[].latitude | double | Latitude. |
record[].gpstime | long | Hora do GPS (carimbo de data/hora UNIX em segundos). |
record[].systemtime | long | Hora no sistema do servidor quando o alerta foi recebido (carimbo de data/hora UNIX em segundos). |
record[].speed | int | Velocidade (KM/H). |
record[].course | int | Direção (Norte é 0, aumento no sentido horário, no máximo 360). |
record[].geofenceid | long | ID da cerca virtual. Quando alarmtype for 5 (Entrada na Cerca) ou 6 (Saída da Cerca), contém o ID da cerca correspondente, caso contrário será 0. |
record[].geofencename | string | Nome da cerca virtual. Quando alarmtype for 5 (Entrada na Cerca) ou 6 (Saída da Cerca), contém o nome da cerca correspondente, caso contrário será "". |
Exemplo de Resposta JSON
{
"code": 0,
"record": [
{
"alarmtype": 27,
"latitude": -23.53665,
"longitude": -49.246352,
"gpstime": 1541575497,
"systemtime": 1541575507,
"speed": 20,
"course": 8,
"geofenceid": 0,
"geofencename": ""
},
{
"alarmtype": 5,
"latitude": -23.53668,
"longitude": -49.246362,
"gpstime": 1541575598,
"systemtime": 1541575617,
"speed": 45,
"course": 93,
"geofenceid": 1075558,
"geofencename": "test-geofence"
}
]
}⚠️
Note: Esta API retorna um máximo de 100 registros de alerta de cada vez. Se o cliente obtiver 100 registros, ele deverá solicitar os próximos 100. Na requisição seguinte, o begintime deve ser o tempo do sistema (systemtime) do 100º registro, repetindo o processo até receber menos de 100 registros (indicando que todos foram recuperados).