Create Identifier Entity

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

• card
• ukey
• inputCode
• face_id
• qr
• license_plate

application/json

Request Body required

• identifier_owner object required

  Identifier owner information

  name string required

  User name

  type string required

  Possible values: [owner, guest]

  Identifier owner type

• identifier_type string required

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

  Identifier type

• identifier_number string required

  • hex, number or face eigenvalue data in Base64 - This param ignored if you create face identifier by uploading image

  • 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 - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})

• lock string required

  Possible values: [first, second, all]

  Lock

Responses

• 200
• 400
• 401
• 403

---

The uid value returned in the response can be used as the identifier-uid parameter in next requests:

• GET/PATCH/DELETE /access/identifier/item/{identifier-uid} - to get info about identifier, update or delete it
• POST /access/identifier/item/{identifier-uid}/passes/reset - to reset left passes to max value
• POST /access/identifier/item/face/file/{identifier-uid} - to create identifier with type face_id from uploaded image
• GET /access/identifier/item/{identifier-uid}/qr - to generate QR image from identifier with type qr
• POST/DELETE /access/identifier/item/{identifier-uid}/timeprofile/{timeprofile-uid}

• to attach/detach a timeprofile to/from identifier

• POST /apartment/item/{apartment-uid}/identifier/{identifier-uid} - to attach an identifier to apartment
• POST /apartment/item/unbind/identifier/{identifier-uid} - to detach and identifier from apartment

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• uid integer

  Possible values: >= -1

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

{
  "uid": 3
}

{
  "uid": 3
}

• Identifier with that type and number already exist
• Cannot create identifier with the same input code number as master code
• Cannot create identifier with same card number as master card
• You cannot create face_id identifier on this panel
• Wrong face_id image data
• Validation error. Required fields are not provided.
• Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

• Required field is not provided. Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

• Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

• Schema
• Example (from schema)
• Base
• No value
• Wrong param type
• Identifier exists
• Duplicate master code
• Duplicate master card
• Cannot create face id
• Wrong face id data

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Identifier with that type and number already exist"
}

{
  "error": "Cannot create identifier with the same input code number as master code"
}

{
  "error": "Cannot create identifier with same card number as master card"
}

{
  "error": "You cannot create face_id identifier on this panel"
}

{
  "error": "Wrong face_id image data"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...