Get Identifier Entity

Returns detailed info about Identifier

Path Parameters

• identifierUid integer required

  Possible values: >= 1

  Unique Id for physical/input code identifier

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• identifier_owner object

  name string

  type string

  Possible values: [owner, guest]

• identifier_type string

  Possible values: [card, ukey, inputCode, qr]

• identifier_number hex

  number or uuid if identifier_type is qr

• lock string

  Possible values: [first, second, all]

• time object

  is_permanent boolean

  from int64

  Unix Timestamp Date

  to int64

  Unix Timestamp Date

• passes object

  is_permanent boolean

  max_passes integer

  Possible values: >= 1

• apartment object

  uid integer

  Possible values: >= -1

  UID for entities referenses. If value is -1, then it means that is no entity reference for this structure

  logical_address object

  building int32

  Possible values: >= 1 and <= 999

  Building number

  unit int32

  Possible values: >= 1 and <= 99

  Unit number

  floor int32

  Possible values: >= 1 and <= 99

  Floor number

  room int32

  Possible values: >= 1 and <= 99

  Room number

• time_profiles object

  count integer

  The number of values in the array

  uid_items integer[]

  Possible values: >= -1

  Array of UID for entities referenses.

• link_id stringnull

  Can be settled only by remote server. By default return null value

• additional object

  passes_left integer

  Possible values: >= -1

  if access is permanent - return -1 value

{
  "identifier_owner": {
    "name": "Sherlock Holmes",
    "type": "owner"
  },
  "identifier_type": "ukey",
  "identifier_number": "12345678",
  "lock": "first",
  "time": {
    "is_permanent": false,
    "from": 1540819272,
    "to": 1540819272
  },
  "passes": {
    "is_permanent": false,
    "max_passes": 3
  },
  "apartment": {
    "uid": 3,
    "logical_address": {
      "building": 1,
      "unit": 1,
      "floor": 1,
      "room": 1
    }
  },
  "time_profiles": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "additional": {
    "passes_left": 3
  }
}

{
  "identifier_owner": {
    "name": "Sherlock Holmes",
    "type": "owner"
  },
  "identifier_type": "ukey",
  "identifier_number": "12345678",
  "lock": "first",
  "time": {
    "is_permanent": false,
    "from": 1540819272,
    "to": 1540819272
  },
  "passes": {
    "is_permanent": false,
    "max_passes": 3
  },
  "apartment": {
    "uid": 3,
    "logical_address": {
      "building": 1,
      "unit": 1,
      "floor": 1,
      "room": 1
    }
  },
  "time_profiles": {
    "count": 4,
    "uid_items": [
      11,
      13,
      23,
      42
    ]
  },
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "additional": {
    "passes_left": 3
  }
}

Wrong Identifier uid

Log In

Loading...