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

  info about identifier owner

  name string

  identifier owner name

  type string

  Possible values: [owner, guest]

  owner type

• identifier_type string

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

  type of identifier

• identifier_number string

  • hex or dec if identifier_type is card or ukey
  • dec if identifier_type is inputCode
  • uuid if identifier_type is qr
  • pattern for hex and dec if identifier_type is card or ukey - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})
  • 1..100 characters if identifier_type is license_plate
• lock string

  Possible values: [second, all, first]

  locks or locks that are linked to identifier

• valid object

  object for valid identifier

  time object

  time for which identifier is valid

  is_permanent boolean

  identifier is permanently valid

  from int64

  Unix Timestamp Date

  to int64

  Unix Timestamp Date

  passes object

  passes that particular identifier provides

  is_permanent boolean

  passes are permanently granted

  max_passes integer

  number of passes identifier can provide

• apartment object

  object with info about apartment

  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

  Logical address - an entity defines the device/user address in the address hierarchy and is used during a call, issuing identifiers, creating call forwarding rules etc.

  building int32

  Possible values: >= 1 and <= 9999

  Building number

  unit int32

  Possible values: <= 99

  Unit number

  floor int32

  Possible values: <= 98

  Floor number

  room int32

  Possible values: <= 99

  Room number

• time_profiles object

  Model used to providing array of UIDs of various enumerated entities are stored in the panel, such as apartments, identifiers, forward, and similar with count param

  uid_items integer[]

  Possible values: >= -1

  Array of UID for entities referenses.

  count integer

  The number of values in the array

• additional object

  schema to describe IdentifierPassesLeftOptions model

  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",
  "valid": {
    "time": {
      "is_permanent": true,
      "from": 1540819272,
      "to": 1540819272
    },
    "passes": {
      "is_permanent": true,
      "max_passes": 2
    }
  },
  "apartment": {
    "uid": 3,
    "logical_address": {
      "building": 1,
      "unit": 1,
      "floor": 1,
      "room": 1
    }
  },
  "time_profiles": {
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "count": 4
  },
  "additional": {
    "passes_left": 3
  }
}

{
  "identifier_owner": {
    "name": "Sherlock Holmes",
    "type": "owner"
  },
  "identifier_type": "ukey",
  "identifier_number": "12345678",
  "lock": "first",
  "valid": {
    "time": {
      "is_permanent": true,
      "from": 1540819272,
      "to": 1540819272
    },
    "passes": {
      "is_permanent": true,
      "max_passes": 0
    }
  },
  "apartment": {
    "uid": 3,
    "logical_address": {
      "building": 1,
      "unit": 1,
      "floor": 1,
      "room": 1
    }
  },
  "time_profiles": {
    "uid_items": [
      11,
      13,
      23,
      42
    ],
    "count": 4
  },
  "additional": {
    "passes_left": 3
  }
}

Wrong Identifier uid

application/json

• Schema
• Example (from schema)
• Wrong Identifier uid

---

Schema

• error string

  error type/info

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong Identifier uid"
}

Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...