Skip to main content

Create Identifier Entity​

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

  • card
  • ukey
  • inputCode
  • qr
Request Body required
  • identifier_owner object
  • name string required
  • type string

    Possible values: [owner, guest]

  • identifier_type string required

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

  • identifier_number hex|dec|uuid required
    • hex or dec if identifier_type is card or ukey
    • dec if identifier_type is inputCode
    • uuid if identifier_type is qr
  • lock string required

    Possible values: [first, second, all]

Responses

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

  • GET/PATCH/DELETE /access/identifiers/item/{identifierUid} - to get info about identifier, update or delete it
  • POST /access/identifiers/item/{identifierUid}/passes/reset - to reset left passes to max value
  • GET /access/identifiers/item/{identifierUid}/qr - to generate QR image from identifier with type qr
  • POST/DELETE /access/identifiers/item/{identifierUid}/timeProfile/{timeProfileUid} - to attach/detach a timeprofile to/from identifier
  • POST /apartment/item/{apartmentUid}/identifier/{identifierUid} - to attach an identifier to apartment
  • POST /apartment/item/unbind/identifier/{identifierUid} - to detach and identifier from apartment
Schema
  • uid integer

    Possible values: >= -1

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

Loading...