Cercas Virtuais (Geofences)Listar Cercas da Conta

Listar Cercas da Conta

Obtém a lista de cercas virtuais criadas na conta.

Requisição HTTP

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

Parâmetros de Consulta (Query)

ParâmetroTipoObrigatórioDescrição
access_tokenstringtrueO token de acesso.
accountstringtrueNome da conta.
pagenumberinttrueNúmero da página, começando em 1.
pagesizeinttrueTamanho da página, no máximo 100.

Exemplo

Request URL:

GET https://api.brasilsatgps.com.br/api/geofence/list?access_token={ACCESS_TOKEN}&account=demo&pagenumber=1&pagesize=20

Estrutura de Retorno (Schema)

Campo JSONTipo de DadoDescrição
recordArrayLista de objetos de cerca virtual.
record[].idstringID da Cerca Virtual.
record[].namestringNome da cerca virtual.
record[].typeintTipo de cerca: 2: círculo, 3: polígono.
record[].parameterstringParâmetros das coordenadas da cerca virtual.
Círculo (tipo 2): longitude,latitude,raio (unidade: metros).
Polígono (tipo 3): longitude,latitude;longitude,latitude;.... Máximo de 1000 coordenadas. Coordenadas de latitude/longitude mantêm 6 casas decimais.
record[].speedingintLimite de velocidade da cerca virtual. 0 significa desativado. Unidade: KM/H.
record[].usetimesstringPeríodos permitidos para disparo do alerta. "" significa o dia todo. Formato: HH:mm,HH:mm;HH:mm,HH:mm;.... Intervalo: [00:00, 23:59].

Exemplo de Resposta JSON

{
  "code": 0,
  "record": [
    {
      "id": "1076078",
      "name": "geofence1",
      "type": 2,
      "parameter": "-77.036871,38.907192,1000",
      "speeding": 0,
      "usetimes": ""
    },
    {
      "id": "1076079",
      "name": "geofence2",
      "type": 3,
      "parameter": "105.069202,-3.994672;105.077767,-4.000879;105.074495,-4.010923;105.063909,-4.010923;105.060638,-4.000879",
      "speeding": 85,
      "usetimes": "00:00,06:00;10:00,12:00"
    }
  ]
}
ℹ️

Note: The response results are arranged in reverse order of creation time.