Get logs list

Get logs list. Available events:

Access

• access_denied_by_not_valid_identifier
• access_denied_by_not_valid_input_code
• access_denied_by_remote_server_api_call
• access_denied_by_web_api_call
• access_denied_by_unknown_card
• access_granted_by_valid_identifier
• access_granted_by_master_code
• access_granted_by_api_call
• access_granted_by_call_host
• access_granted_by_remote_server_api_call
• lock_was_opened_by_exit_btn
• access_denied_by_unknown_qr_code

Info

• outgoing_call
• incoming_call
• lock_is_opened_to_long

System

• successful_login_api_call
• incorrect_login_api_call

Query Parameters

• locale string

  Possible values: [en, ru, uk]

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

• from integer

  Unix time

• to integer

  Unix time

• limit integer required

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

  Default value: 10

  Number of items. Value by default is 10

• pageNumber integer required

  Possible values: >= 1

  Default value: 1

  Page number

• sortType string

  Possible values: [asc, desc]

  Default value: asc

  Sort type (asc/desc)

• filter object

  Filtering options

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• list_option object[]

  locale object

  locale string

  Possible values: [en, ru, uk]

  available_locales string[]

  filter object

  available_filtering boolean

  is_filtered boolean

  available_fields object[]

  available_values object

  category string[]

  priority string[]

  name object[]

  key string

  this key should be used for filtering options

  localized string

  english string

  sort object

  asc boolean

  Default value: true

  available_sorting string[]
• list_items object[]

  timestamp int64

  Unix Timestamp Date

  category string

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

  priority string

  name object

  key string

  filter key

  localized string

  english string

  info object

  model object

  localized string

  english string

  This filed is presented when you choose locale different from "en"

{
  "list_option": [
    {
      "locale": {
        "locale": "en",
        "available_locales": [
          "en, ru, uk"
        ]
      },
      "filter": {
        "available_filtering": true,
        "is_filtered": true,
        "available_fields": [
          {
            "filter_field": "priority",
            "available_types": [
              "more, less, equal"
            ]
          },
          {
            "filter_field": "category",
            "available_types": [
              "equal"
            ]
          },
          {
            "filter_field": "name",
            "available_types": [
              "equal"
            ]
          }
        ],
        "available_values": {
          "category": [
            "access, emergency, system, info"
          ],
          "priority": [
            "critical, high, low, medium"
          ],
          "name": [
            {
              "key": "access_denied_by_not_valid_input_code",
              "localized": "Wrong input code",
              "english": "Wrong input code"
            }
          ]
        }
      },
      "sort": {
        "asc": true,
        "available_sorting": [
          "asc, desc"
        ]
      }
    }
  ],
  "list_items": [
    {
      "timestamp": 1540819272,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_web_api_call",
        "localized": "Access denied by web interface",
        "english": "Access denied by web interface"
      },
      "info": {
        "model": {},
        "localized": "string",
        "english": "string"
      }
    }
  ]
}

{
  "list_option": {
    "pagination": {
      "total_items": 3,
      "items_limit": 10,
      "total_pages": 1,
      "current_page": 1
    },
    "filter": {
      "available_filtering": false,
      "available_values": {
        "category": [
          "access",
          "emergency",
          "system",
          "info"
        ],
        "priority": [
          "low",
          "medium",
          "high",
          "critical"
        ],
        "available_locales": [
          "en",
          "es",
          "pl",
          "ru",
          "uk"
        ]
      }
    }
  },
  "list_items": [
    {
      "timestamp": 37391500,
      "category": "access",
      "priority": "medium",
      "name": {
        "key": "access_granted_by_valid_identifier",
        "localized": "Lock opened by identifier",
        "english": "Lock opened by identifier"
      },
      "info": {
        "number": "3750404",
        "code": "3750404",
        "card": "3750404",
        "type": "card",
        "owner": "Sherlock Holmes",
        "lock": "1",
        "apartment_address": "1-2-3-4",
        "apartment_name": "221b Baker St",
        "english": "Valid identifier 3750404 was used, apartment number 1-2-3-4, owner Sherlock Holmes, lock 1 was opened",
        "localized": "Valid identifier 3750404 was used, apartment number 1-2-3-4, owner Sherlock Holmes, lock 1 was opened"
      }
    },
    {
      "timestamp": 37384899,
      "category": "access",
      "priority": "high",
      "name": {
        "key": "access_denied_by_not_valid_identifier",
        "localized": "Not valid identifier",
        "english": "Not valid identifier"
      },
      "info": {
        "number": "9893270",
        "code": "9893270",
        "card": "9893270",
        "type": "card",
        "owner": "Sherlock Holmes",
        "apartment_address": "1-2-3-4",
        "apartment_name": "221b Baker St",
        "english": "Not valid identifier 9893270 used",
        "localized": "Not valid identifier 9893270 used"
      }
    },
    {
      "timestamp": 37371321,
      "category": "system",
      "priority": "low",
      "name": {
        "key": "successful_login_api_call",
        "localized": "Login to the web interface",
        "english": "Login to the web interface"
      },
      "info": {
        "account_type": "admin",
        "password": "E10ADC3949BA59ABBE56E057F20F883E",
        "english": "Successful (admin) login to the web interface",
        "localized": "Successful (admin) login to the web interface"
      }
    }
  ]
}

• Bad request.
• Pagination: wrong limit
• Pagination: wrong page
• Wrong time format
• Wrong time range: 'to' must be greater then 'from'
• Filter: wrong filter_type
• Filter: wrong filter_field
• Filter: wrong filter_value
• Sort: wrong sort_type
• Wrong number format

Log In

Loading...