Skip to main content

Create Identifier Entity

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

  • card
  • ukey
  • inputCode
  • face_id
  • qr
  • license_plate
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

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

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

Loading...