Instalações

Listar instalações ativas

GET /api/v1/installations

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Datas devem ser passadas no formato ISO 8601.

Este serviço suporta paginação.

id: o id da instalação.
- Se passado, a consulta retorna somente a instalação com este id.
virtual_equipment: pode ser true ou false. Se for true, apenas as boxes virtuais serão listadas.
- Caso não seja passado, é considerado false.
client_id: o id do cliente das instalações.
- Se passado, a consulta retorna somente as instalações deste cliente.
location_id: o id do local das instalações.4
- Se passado, a consulta retorna somente as instalações deste local.
machine_id: o id da máquina das instalações.
- Se passado, a consulta retorna somente as instalações com este modelo de máquina.
machine_type_id: o id do tipo de máquina das instalações.
- Se passado, a consulta retorna somente as instalações com este tipo de máquina.
equipment_id: o id do equipamento das instalações.
- Se passado, a consulta retorna somente as instalações com este equipamento.
point_of_sale: o ponto de captura das instalações.
- Se passado, a consulta retorna somente as instalações com este ponto de captura.
distribution_center_id: o id do centro de distribuição das instalações.*
connection_status_interface_kind: o tipo de conexão das instalações.
- Pode ser GPRS, WIFI ou BLUETOOTH. Se for GPRS, apenas as instalações com conexão GPRS serão listadas.
filled_inventory: percentual mínimo de estoque das instalações.
- Se passado, a consulta retorna somente as instalações com estoque acima deste percentual.
start_date: filtra instalações instaladas a partir da data informada (inclusive).
- Deve ser informado junto com o parâmetro end_date.
route_id: o id da rota das instalações.
- Se passado, a consulta retorna somente as instalações com este id de rota.
items_at_alert_level: quantidade de items com saldo abaixo do nível de alerta.
- Se passado, a consulta retorna somente as instalações que possua no mínimo a quantidade informada de items com saldo abaixo do nível de alerta.
empty_items: quantidade de items com saldo zerado.
- Se passado, a consulta retorna somente as instalações que possua no mínimo a quantidade informada de items com saldo zerado.
operation_status: o estado das instalações.
- Se passado, a consulta retorna as instalações que possuam um estados informados,
  - red: Fora de operação
  - blue: Em alerta gerencial
  - green: Em operação
  - yellow: Parcialmente em operação
  - grey: Sem informação
tags: lista de tags das instalações.
- Se passado, a consulta retorna somente as instalações que possuam máquinas as tags informadas.

Retorno

status	descrição
200	OK

Exemplo:

[
  {
    "id": 77,
    "created_at": "2014-10-17T16:11:43.000-03:00",
    "updated_at": "2014-11-20T10:14:31.000-02:00",
    "location_id": 34,
    "machine_id": 42,
    "equipment_id": 314,
    "place": "Recepção",
    "cash_mode": "cash_and_cashless",
    "restock_mode": "restock_and_cash_collect",
    "restock_strategy": "allow_pick_list_or_full",
    "notifications_enabled": true,
    "last_audit_began_at": "2017-08-02T17:59:14.000Z",
    "last_audit_ended_at": "2017-08-02T17:59:16.000Z",
    "removed_at": null,
    "no_vend_schedule_id": 1,
    "audit_enabled": true,
    "enable_audit_schedule": true,
    "audit_schedule": "7:00 12:30 18:00 23:50 (instalação)",
    "visit_schedule": [],
    "enable_bluetooth": false,
    "enable_contactless": false,
    "issues_invoice": false,
    "operation_status": "green",
    "states": ["hatched"],
    "route_ids": [10, 68, 123],
    "last_communication": "26/09/2018 19:13",
    "virtual_equipment": false,
    "connection": {
      "kind": "GPRS",
      "label": "wwan0",
      "ip": "179.246.209.53",
      "tunnel_label": null,
      "tunnel_ip": null,
      "rssi": 22,
      "carrier": "vivo"
    },
    "services": {
      "bluetooth": {
        "mac": null,
        "status": "inactive"
      },
      "pl_mifare": {
        "mac": null,
        "status": "inactive"
      }
    }
  },
  {
    "id": 88,
    "created_at": "2014-10-24T12:25:15.000-02:00",
    "updated_at": "2014-11-20T10:14:31.000-02:00",
    "location_id": 28,
    "machine_id": 42,
    "equipment_id": 314,
    "place": "Hall Biblioteca",
    "cash_mode": "cash_and_cashless",
    "restock_mode": "restock_and_cash_collect",
    "restock_strategy": "allow_pick_list_or_full",
    "notifications_enabled": true,
    "last_audit_began_at": "2017-08-02T17:59:14.000Z",
    "last_audit_ended_at": "2017-08-02T17:59:16.000Z",
    "removed_at": "2014-11-20T10:14:31.000-02:00",
    "no_vend_schedule_id": 1,
    "audit_enabled": true,
    "enable_audit_schedule": true,
    "audit_schedule": "6:00 10:00 14:00 18:00 22:00 23:50 (padrão)",
    "visit_schedule": ["tuesday", "thursday"],
    "enable_bluetooth": true,
    "enable_contactless": false,
    "issues_invoice": false,
    "operation_status": "yellow",
    "states": ["audit_failure", "hatched"],
    "route_ids": [10, 13],
    "last_communication": "15/06/2018 23:18",
    "virtual_equipment": false
  },
  {
    "id": 138,
    "created_at": "2014-11-21T16:54:19.000-02:00",
    "updated_at": "2014-11-21T19:40:14.000-02:00",
    "location_id": 34,
    "machine_id": 42,
    "equipment_id": 314,
    "place": "Recepção",
    "cash_mode": "cash_and_cashless",
    "restock_mode": "restock_and_cash_collect",
    "restock_strategy": "require_pending_pick_list",
    "notifications_enabled": true,
    "last_audit_began_at": "2017-08-02T17:59:14.000Z",
    "last_audit_ended_at": "2017-08-02T17:59:16.000Z",
    "removed_at": "2014-11-21T19:40:14.000-02:00",
    "no_vend_schedule_id": null,
    "audit_enabled": false,
    "enable_audit_schedule": false,
    "audit_schedule": "",
    "visit_schedule": ["monday", "wednesday", "friday"],
    "enable_bluetooth": true,
    "enable_contactless": true,
    "issues_invoice": true,
    "operation_status": "red",
    "states": ["extended_power_loss", "hatched"],
    "route_ids": [23],
    "last_communication": "12/09/2018 13:13",
    "virtual_equipment": false
  }
]