Get logs list

Return log's list. Available events:

Access

• access_denied_by_not_valid_identifier
• access_denied_by_not_valid_face_identifier
• access_denied_by_not_valid_input_code
• access_denied_by_remote_server_api_call
• access_denied_by_unknown_card
• access_granted_by_api_call
• access_granted_by_call_host
• access_granted_by_master_code
• access_granted_by_remote_server_api_call
• access_granted_by_valid_identifier
• access_granted_by_valid_face_identifier
• door_was_closed
• access_denied_unknown_identifier
• door_sensor_was_closed
• door_was_opened
• door_sensor_was_opened
• emergency_lock_is_opened
• lock_was_opened_by_exit_btn
• lock_was_opened_by_free_access_button
• multi_access_granted
• identifiers_without_linkage_to_user_access_denied
• multi_access_denied
• lift_call_success
• lift_call_error
• lift_module_access_error

Info

• incoming_call
• outgoing_call
• outgoing_call_missed
• device_booted
• sip_registration_lost
• outgoing_call_web

System

• incorrect_login_api_call
• incorrect_login_gui_settings
• successful_login_api_call
• successful_login_gui_settings

Emergency

• door_was_not_closed_too_long
• tamper_event

Query Parameters

• locale string

  Possible values: [en, es, ru, uk, pl]

  Default value: en

  Language for localizing logs. Value by default is 'en'

• from int64

  Unix time used to get entities in a specific time window.

  • Used in conjunction with timeTo param
• to int64

  Unix time used to get entities in a specific time window.

  • Used in conjunction with timeFrom param
• limit integer

  Possible values: [10, 20, 30, 50]

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

• sort_type string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options for Logs

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Logs with options

---

Schema

• list_option object

  The model provides options can be used to sort, filter, and paginate log items

  pagination object

  Available pagination options for tables

  total_items integer

  The total number of items found and reflected across all pages

  items_limit integer

  Possible values: [10, 25, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  Possible values: >= 1

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

  filter object

  This model describes available filter options can be used to display logs

  available_filtering boolean

  is_filtered boolean

  available_fields object[]

  available_values object

  category string[]

  Possible values: [access, emergency, system, info]

  priority string[]

  Possible values: [critical, high, low, medium]

  name undefined[]

  text string

  Log description

  key string

  Possible values: [access_denied_by_not_valid_identifier, access_denied_by_not_valid_face_identifier, access_denied_by_not_valid_input_code, access_denied_by_remote_server_api_call, access_denied_by_unknown_card, access_granted_by_api_call, access_granted_by_call_host, access_granted_by_master_code, access_granted_by_remote_server_api_call, access_granted_by_valid_identifier, access_granted_by_valid_face_identifier, door_was_closed, door_sensor_was_closed, door_was_opened, door_sensor_was_opened, emergency_lock_is_opened, lock_was_opened_by_exit_btn, lock_was_opened_by_free_access_button, incoming_call, outgoing_call, outgoing_call_missed, device_booted, sip_registration_lost, outgoing_call_web, incorrect_login_api_call, incorrect_login_gui_settings, successful_login_api_call, successful_login_gui_settings, door_was_not_closed_too_long, multi_access_granted, identifiers_without_linkage_to_user_access_denied, multi_access_denied, access_denied_by_unknown_qr, access_denied_unknown_identifier, lift_call_success, lift_call_error, lift_module_access_error]

  Log key that should be used for filtering

  sort object

  This model describes available sort options can be used to display logs

  asc boolean

  Default value: true

  available_sorting string[]

  Possible values: [asc, desc]

  locale object

  This model describes available languages can be used to display logs

  locale string

  Possible values: [en, es, ru, uk, pl]

  Default value: en

  available_locales string[]

  Possible values: [en, es, ru, uk, pl]

• list_items object[]

  timestamp int64

  Unix Timestamp Date

  category string

  Possible values: [access, emergency, system, info]

  priority string

  name object

  key string

  filter key

  text string

  info object

  This model provides detailed information about log event

  model object

  Represents log event raw data

  oneOf

  • MOD2
  • MOD3
  • MOD4
  • MOD5
  • MOD6
  • MOD7
  • MOD8
  • MOD9
  • MOD10
  • MOD11
  • MOD12
  • MOD13
  • MOD14
  • MOD15
  • MOD16
  • MOD18
  • MOD19
  • MOD20
  • MOD21
  • MOD26
  • MOD27
  • MOD28
  • MOD29
  • MOD30
  • MOD31
  • MOD34
  • MOD35
  • MOD36

  ---

  status string

  Possible values: [checking, downloading, backuping, installing, finishing, error]

  account_type string

  Possible values: [admin, manager]

  account_type string

  Possible values: [admin, manager]

  number string

  answered boolean

  number string

  answered boolean

  info string

  info string

  number integer

  type string

  owner string

  apartment_address string

  lock integer

  number integer

  type string

  Possible values: [card, ukey, input_code, face_id, qr, license_plate]

  owner string

  apartment_address string

  lock integer

  code string

  lock integer

  host string

  lock integer

  lock integer

  card string

  qr string

  identifier_number string

  identifier_type string

  Possible values: [card, ukey, input_code, face_id, qr, license_plate]

  used_identifiers_list object[]

  identifier_number string

  auth_type string

  user_name string

  user_info string

  apartments_list string[]

  reject_reasons object[]

  invalid_identifier object

  identifier_number string

  auth_type string

  invalid_identifier_time_rules object[]

  identifier_number string

  auth_type string

  not_enough_passes_for_identifier object[]

  identifier_number string

  auth_type string

  not_valid_time_profile_for_identifier object[]

  identifier_number string

  auth_type string

  not_valid_time_profile_for_user object

  user_name string

  user_info string

  not_enough_identifiers_for_current_authentication_type string[]

  Possible values: [face_id, card, qr]

  recognition_type_is_not_enabled object

  recognition_type_is_not_enabled string

  Possible values: [qr, face_id]

  used_identifiers_list object[]

  identifier_number string

  auth_type string

  user_name string

  user_info string

  apartments_list string[]

  lock_number integer

  identifier_number string

  identifier_type string

  number integer

  type string

  owner string

  apartment_address string

  lock integer

  number integer

  type string

  Possible values: [card, ukey, input_code, face_id, qr, license_plate]

  owner string

  apartment_address string

  lock integer

  lock_opened_time integer

  In seconds

  account_type string

  Possible values: [admin, manager]

  account_type string

  Possible values: [admin, manager]

  number string

  answered boolean

  info object

  user object

  Caller user info

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  name string

  destination object

  id integer

  short_name string

  lift

  id integer

  short_name string

  info object

  user object

  Caller user info

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  name string

  destination object

  id integer

  short_name string

  error

  message string

  info object

  user object

  Caller user info

  link_id uuid

  Unique entity set by the server to bind some parameters with each other. By default return null value

  name string

  error

  message string

  text string

  Human-readable information about event

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "is_filtered": true,
      "available_fields": [
        {
          "filter_field": true,
          "available_types": [
            "equal"
          ]
        }
      ],
      "available_values": {
        "category": [
          "access",
          "emergency",
          "system",
          "info"
        ],
        "priority": [
          "critical",
          "high",
          "low",
          "medium"
        ],
        "name": [
          {
            "text": "Unknown identifier",
            "key": "access_denied_by_unknown_card"
          }
        ]
      }
    },
    "sort": {
      "asc": true,
      "available_sorting": [
        "asc",
        "desc"
      ]
    },
    "locale": {
      "locale": "en",
      "available_locales": [
        "en",
        "es",
        "ru",
        "uk",
        "pl"
      ]
    }
  },
  "list_items": [
    {
      "timestamp": 1540819272,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "incoming_call",
        "text": "Access denied by web interface"
      },
      "info": {
        "model": {},
        "text": "Lock 1 opened from the web interface"
      }
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_pages": 1,
      "items_limit": 10,
      "total_items": 1,
      "current_page": 1
    },
    "filter": {
      "available_filtering": true,
      "available_fields": [
        {
          "available_types": [
            "more",
            "less",
            "equal"
          ],
          "filter_field": "priority"
        },
        {
          "available_types": [
            "equal"
          ],
          "filter_field": "category"
        },
        {
          "available_types": [
            "equal"
          ],
          "filter_field": "name"
        }
      ],
      "available_values": {
        "category": [
          "emergency",
          "access",
          "system",
          "info"
        ],
        "priority": [
          "low",
          "critical",
          "medium",
          "high"
        ],
        "name": [
          {
            "text": "SIP registration lost",
            "key": "sip_registration_lost"
          },
          {
            "text": "Unknown identifier",
            "key": "access_denied_by_unknown_card"
          },
          {
            "text": "Wrong input code",
            "key": "access_denied_by_not_valid_input_code"
          },
          {
            "text": "Access granted by remote server",
            "key": "access_granted_by_remote_server_api_call"
          },
          {
            "text": "Missed outgoing call",
            "key": "outgoing_call_missed"
          },
          {
            "text": "Door is not closed too long",
            "key": "door_was_not_closed_too_long"
          },
          {
            "text": "Unknown QR code",
            "key": "access_denied_by_unknown_qr"
          },
          {
            "text": "Lock opened by response device",
            "key": "access_granted_by_call_host"
          },
          {
            "text": "Door was closed",
            "key": "door_was_closed"
          },
          {
            "text": "Lock opened by free access button",
            "key": "lock_was_opened_by_free_access_button"
          },
          {
            "text": "Outgoing call",
            "key": "outgoing_call"
          },
          {
            "text": "Device booted",
            "key": "device_booted"
          },
          {
            "text": "Failed login attempt to the GUI settings",
            "key": "incorrect_login_gui_settings"
          },
          {
            "text": "Entered to GUI settings",
            "key": "successful_login_gui_settings"
          },
          {
            "text": "Incoming call",
            "key": "incoming_call"
          },
          {
            "text": "Door was opened",
            "key": "door_was_opened"
          },
          {
            "text": "Access denied by remote server",
            "key": "access_denied_by_remote_server_api_call"
          },
          {
            "text": "Door sensor opened",
            "key": "door_sensor_was_opened"
          },
          {
            "text": "Not valid face identifier",
            "key": "access_denied_by_not_valid_face_identifier"
          },
          {
            "text": "Failed login attempt to the web interface",
            "key": "incorrect_login_api_call"
          },
          {
            "text": "Not valid identifier",
            "key": "access_denied_by_not_valid_identifier"
          },
          {
            "text": "Access granted by the web interface",
            "key": "access_granted_by_api_call"
          },
          {
            "text": "Lock opened by identifier",
            "key": "access_granted_by_valid_identifier"
          },
          {
            "text": "The lock is open on alarm",
            "key": "emergency_lock_is_opened"
          },
          {
            "text": "Lock opened by exit button",
            "key": "lock_was_opened_by_exit_btn"
          },
          {
            "text": "General access code entered",
            "key": "access_granted_by_master_code"
          },
          {
            "text": "Lock opened by face identifier",
            "key": "access_granted_by_valid_face_identifier"
          },
          {
            "text": "Door sensor closed",
            "key": "door_sensor_was_closed"
          },
          {
            "text": "Login to the web interface",
            "key": "successful_login_api_call"
          },
          {
            "text": "Outgoing call from web",
            "key": "outgoing_call_web"
          },
          {
            "text": "Tamper triggered",
            "key": "tamper_event"
          },
          {
            "text": "Multi factor access granted",
            "key": "multi_access_granted"
          },
          {
            "text": "Multi factor access denied",
            "key": "multi_access_denied"
          },
          {
            "text": "Identifiers without linkage to user are not allowed",
            "key": "identifiers_without_linkage_to_user_access_denied"
          },
          {
            "text": "Access denied by unknown identifier",
            "key": "access_denied_unknown_identifier"
          },
          {
            "text": "Successful lift call",
            "key": "lift_call_success"
          },
          {
            "text": "Failed to call the lift",
            "key": "lift_call_error"
          },
          {
            "text": "Cannot access lift module",
            "key": "lift_module_access_error"
          }
        ]
      }
    },
    "locale": {
      "available_locales": [
        "pl",
        "uk",
        "en",
        "ru",
        "es"
      ],
      "locale": "en"
    },
    "sort": {
      "asc": false,
      "available_values": [
        "asc",
        "desc"
      ]
    }
  },
  "list_items": [
    {
      "timestamp": 1608292485815,
      "category": "system",
      "priority": "medium",
      "info": {
        "text": "Successful (admin) login to the web interface",
        "model": {
          "account_type": "admin"
        }
      },
      "name": {
        "text": "Login to the web interface",
        "key": "successful_login_api_call"
      }
    }
  ]
}

Base errors for all entities

• Wrong pagination limit
• Wrong page number
• Wrong filter type
• Wrong filter field
• Wrong filter format
• Wrong filter value
• Wrong sort type
  Errors appeared only in log entities:
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
  Errors apperared in other entities:
• Wrong sort field

application/json

• Schema
• Example (from schema)
• Pagination Limit
• Pagination Page Number
• Sort type
• Sort field
• Filter type
• Filter field
• Filter value
• Filter format
• Time format
• Time range

---

Schema

• error string

{
  "error": "Administrator rights required"
}

{
  "error": "Wrong pagination limit"
}

{
  "error": "Wrong page number"
}

{
  "error": "Wrong sort type"
}

{
  "error": "Wrong sort field"
}

{
  "error": "Wrong filter type"
}

{
  "error": "Wrong filter field"
}

{
  "error": "Wrong filter value"
}

{
  "error": "Wrong filter format"
}

{
  "error": "Wrong time format"
}

{
  "error": "Wrong time range: 'to' must be greater then 'from'"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...