Returns info about Identifier

Returns info about Identifier

• Available only in access control mode

Path Parameters

• uid 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

• number string

  • hex or dec if type is card or ukey
  • dec if type is input_code
  • uuid if type is qr
  • pattern for hex and dec - [0-9]{1,17} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})
  • hash value or empty string if type is face_id.
• type string

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

  This model describes the types of identifiers

• owner object

  name string

  Possible values: non-empty and <= 128 characters

  type string

  Possible values: [owner, guest]

• floors integer[]

  Possible values: <= 98

  List of floors available for this identifier

• apartments string[]

  Possible values: Value must match regular expression ^\d{2}-\d{2}$

  List of apartments available for this identifier

{
  "number": "12345678",
  "type": "card",
  "owner": {
    "name": "Sherlock Holmes",
    "type": "owner"
  },
  "floors": [
    1
  ],
  "apartments": [
    "01-11"
  ]
}

{
  "number": "12345678",
  "type": "card",
  "owner": {
    "name": "Sherlock Holmes",
    "type": "owner"
  },
  "floors": [
    1,
    2
  ],
  "apartments": [
    "01-11"
  ]
}

• Wrong Identifier uid

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

Please log in

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error]

  Error code

  message string

  Error message

  data object

  Did not pass validation parameters. Can be represented as an object, which can include field names, arrays, query parameters etc.

  param string

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Log In"
  }
}

Loading...