Incidents

This endpoint shows the logs of alarms like Door Left Open (DLO), tamper, Intruder Alarms and Low Battery Warnings.

What is Audit Trail? Check out our Glossary.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
call response
Endpoint: "/v1/incidents"
Method: GET

          
Response Content Type (application/json):
{
  
items;
type: array

items returned as result

"items"
: [ {
id;
type: string, format: uuid;

The id of the entry

"id"
: "string",
type;
type: string
enumeration: [unknown, intrusion_alarm, tamper_alarm, door_left_open_alarm, end_of_door_left_open_alarm, end_of_intrusion_alarm, end_of_tamper_alarm, lock_connection_lost, lock_connection_restored, low_battery_warning, lock_time_set, easyofficemode_finish_failed, iq_connection_lost, iq_connection_restored];

The type of the incident

"type"
: "string",
utc_date_time;
type: string, format: date-time;

The UTC timestamp that marks when the event happened

"utc_date_time"
: "string",
local_date_time;
type: string, format: date-time;

The timestamp that marks when the event happened but converted to the timezone of the IQ the lock is connected to

"local_date_time"
: "string",
lock;

The lock which is subject of the incident

"lock"
: [ {
id;
type: string, format: uuid;

Id of the lock

"id"
: "string",
customer_reference;
type: string

The name or any sort of reference that can be used to identify the lock by the client

"customer_reference"
: "string",
mac_address;
type: string

Mac address of the lock

"mac_address"
: "string",
is_online;
type: boolean

Online status of the lock

"is_online"
: boolean,
collection_id;
type: string, format: uuid;

The id of the collection the lock is assigned

"collection_id"
: "string" } ],
iq;

The IQ which is subject of the incident

"iq"
: [ {
id;
type: string, format: uuid;

id of the IQ

"id"
: "string",
customer_reference;
type: string

Name of the IQ

"customer_reference"
: "string",
mac_address;
type: string

Mac address of the IQ

"mac_address"
: "string",
is_online;
type: boolean

Is IQ online or not

"is_online"
: boolean,
collection_id;
type: string, format: uuid;

The id of the collection the IQ is assigned

"collection_id"
: "string",
revision;
type: string

Iq version

"revision"
: "string" } ] } ],
next_page_link;
type: string

next page uri link

"next_page_link"
: "string",
count;
type: integer, format: int64;

number of items returned

"count"
: "integer" }