Cercas Virtuais (Geofences)Listar Cercas do Dispositivo

Listar Cercas do Dispositivo

Obtém a lista de cercas virtuais vinculadas a um dispositivo específico.

Requisição HTTP

MétodoCaminho (Path)
GET/api/device/geofence

Parâmetros de Consulta (Query)

ParâmetroTipoObrigatórioDescrição
access_tokenstringtrueO token de acesso.
imeistringtrueIMEI de destino.

Exemplo

Request URL:

GET https://api.brasilsatgps.com.br/api/device/geofence?access_token={ACCESS_TOKEN}&imei=358899123456789

Estrutura de Retorno (Schema)

Campo JSONTipo de DadoDescrição
recordArrayLista de configurações de vínculo de cercas virtuais do dispositivo.
record[].geofenceidstringID da Cerca Virtual.
record[].geofencenamestringNome da cerca virtual.
record[].inintAlerta ao entrar na cerca virtual (1: Ligado, 0: Desligado).
record[].outintAlerta ao sair da cerca virtual (1: Ligado, 0: Desligado).
record[].speedingalertintAlerta de excesso de velocidade dentro da cerca virtual (1: Ligado, 0: Desligado).
record[].relaycommandintA Stop Engine command will be automatically sent to the selected device once it leaves the Geo-fence (1: ON, 0: OFF). Note: This option requires out geofence alert to be ON.

Exemplo de Resposta JSON

{
  "code": 0,
  "record": [
    {
      "geofenceid": "1075642",
      "geofencename": "geofence1",
      "in": 1,
      "out": 1,
      "speedingalert": 0,
      "relaycommand": 0
    },
    {
      "geofenceid": "1075643",
      "geofencename": "geofence2",
      "in": 1,
      "out": 1,
      "speedingalert": 1,
      "relaycommand": 1
    }
  ]
}