Equipment Access Config v1

The equipment access configuration endpoint retrieves the access configuration data for a given equipment using the equipment_id parameter at a given location using the location_id parameter.

Introduction

/locations/{location_id}/equipment/{equipment_id}/access/config/v1

Definition

An equipments access configuration relevant truck configuration (e.g. timeout values) and if access is enabled/disabled. It also includes the information, when a configuration was sent to the truck and when it was acknowledged by the truck. There is a default configuration that can be overwritten e.g. by sending an api post requests. An updated configuration will be acknowledged by the truck.

Example entity

{
  "location_id": "12345678",
  "equipment_id": "9f0314ce61a169af6eb8e972babee65c3a0f8f27a2904527ea7265bd9bb06de7",
  "activationStatus": "activated",
  "standby_timeout_in_seconds": 0,
  "standby_config_state": "inactive",
  "shutdown_timeout_in_seconds": 60,
  "shutdown_config_state": "pending",
  "sent_at": "2020-01-02T09:08:07.000Z",
  "received_at": "2020-01-02T09:11:14.000Z"
}

Frequency

The data up-to-dateness is dependent on the connection of the truck. If an access configuration is updated, it usually takes only a few seconds/minutes until the acknowledgment of the truck appears in the endpoint.

Reference Docs