Create Identifier Entity

Create Identifier Entity. You can create identifiers with the next types:

• card
• ukey
• input_code
• qr
• face_id
• Available only in access control mode

application/json

Request Body

• number string required

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

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

  This model describes the types of identifiers

• owner object

  name string required

  Possible values: non-empty and <= 128 characters

  type string required

  Possible values: [owner, guest]

• floors integer[] required

  Possible values: <= 98

  List of floors available for this identifier

• apartments string[] required

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

  List of apartments available for this identifier

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  UID for entities referenses

{
  "uid": 3
}

{
  "uid": 3
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• error object

  code string

  Possible values: [invalid_authentification, 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_authentification, 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_authentification",
    "message": "Log In"
  }
}

Loading...