Create Identifier Entity

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

• card
• ukey
• inputCode
• qr
• license_plate

application/json

Request Body required

• identifier_owner object required

  info about identifier owner

  name string required

  identifier owner name

  type string required

  Possible values: [owner, guest]

  owner type

• identifier_type string required

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

  type of identifier

• identifier_number string required

  • 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 if identifier_type is card or ukey - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})
  • 1..100 characters if identifier_type is license_plate
• lock string required

  Possible values: [second, all, first]

  locks or locks that are linked to identifier

• valid object required

  object for valid identifier

  time object required

  time for which identifier is valid

  is_permanent boolean required

  identifier is permanently valid

  from int64

  Unix Timestamp Date

  to int64

  Unix Timestamp Date

  passes object required

  passes that particular identifier provides

  is_permanent boolean required

  passes are permanently granted

  max_passes integer

  number of passes identifier can provide

Responses

• 200
• 400
• 401

---

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

• GET/PATCH/DELETE /access/identifier/item/{identifierUid} - to get info about identifier, update or delete it
• POST /access/identifier/item/{identifierUid}/passes/reset - to reset left passes to max value
• GET /access/identifier/item/{identifierUid}/qr - to generate QR image from identifier with type qr
• POST/DELETE /access/identifier/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

application/json

• Schema
• Example (from schema)
• Example

---

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

{
  "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
• 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)
• Identifier exist
• Duplicate master code
• Duplicate master card

---

Schema

• error string

  error type/info

{
  "error": true
}

{
  "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"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...