Get Identifier Entity

Returns detailed info about Identifier

Path Parameters

• identifier-id integer required

  Possible values: >= 1

  Unique Id for physical/input code identifier

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• name string

  Possible values: <= 100 characters

  Name of the identifier

• affiliation string

  Possible values: [owner, guest]

  Identifier affiliation type

• type string

  Possible values: [card, ukey, input_code, license_plate]

  Identifier type used for access

• number string

  Possible values: <= 256 characters

  • hex if identifier type is card or ukey - max length is 32 bytes

  • binary if identifier type is card or ukey - min length is 16 symbols, max length is 256 symbols

  • dec if identifier type is input_сode - max length is 10 symbols

  • string if identifier type is license_plate - max length is 100 symbols

  • pattern for hex ([0-9A-Fa-f]{2}[:-]){1,31}([0-9A-Fa-f]{2})

  • pattern for dec - [0-9]{1,10}

  • pattern for bin - [01]{16,256}

• valid object

  Describes identifier restriction by time, passes

  time object

  Describes identifier restriction by time

  is_permanent boolean

  Determines if enabled identifier restriction by time

  from int64

  Unix Timestamp Date

  to int64

  Unix Timestamp Date

  passes object

  Describes identifier passes restriction settings

  is_permanent boolean

  Determines if passes restriction enabled

  max_passes integer

  Possible values: >= 1 and <= 99999

  Identifier restriction by max allowed passes

• id integer

  Possible values: >= -1

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

• link_id uuid

  Possible values: <= 36 characters

  Unique entity set by the server to bind some parameters with each other. By default return null value

• apartment object

  Apartment entity

  id integer

  Possible values: >= -1

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

  name string

  Possible values: <= 100 characters

  Name for the apartment, owner full name or apartment number usually used. Nonempty string.

  link_id uuid

  Possible values: <= 36 characters

  Unique entity set by the server to bind some parameters with each other. By default return null value

  address object

  Logical address - an entity defines the device/user address in the address hierarchy and is used during a call, issuing identifiers, creating call forwarding rules etc.

  building integer

  Possible values: >= 1 and <= 9999

  Building number

  unit integer

  Possible values: <= 99

  Unit number

  floor integer

  Possible values: <= 98

  Floor number

  room integer

  Possible values: <= 99

  Room number

• user object

  User related to identifier

  id integer

  Possible values: >= -1

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

  name string

  Possible values: <= 100 characters

  Name of the user entity

  link_id uuid

  Possible values: <= 36 characters

  Unique entity set by the server to bind some parameters with each other. By default return null value

• references_count object

  list of the number of links

  time_profiles integer

  Count of time_profiles attached to the apartment

  access_rules integer

  Count of access_rules attached to the apartment

• additional object

  Amount of passes remaining by identifier passes restriction

  passes_left integer

  Possible values: >= -1

  if access is permanent - return -1 value

{
  "name": "John Smith main card",
  "affiliation": "owner",
  "type": "card",
  "number": "ff:ff:ff:ff",
  "valid": {
    "time": {
      "is_permanent": false,
      "from": 1540819272,
      "to": 1540819272
    },
    "passes": {
      "is_permanent": false,
      "max_passes": 3
    }
  },
  "id": 3,
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "apartment": {
    "id": 3,
    "name": "221B Baker Street",
    "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
    "address": {
      "building": 1,
      "unit": 1,
      "floor": 1,
      "room": 1
    }
  },
  "user": {
    "id": 3,
    "name": "John Smith",
    "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5"
  },
  "references_count": {
    "time_profiles": 1,
    "access_rules": 1
  },
  "additional": {
    "passes_left": 3
  }
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  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

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "bad_request",
    "message": "Bad request sent"
  }
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error object

  Error object, contains error details

  code string

  Possible values: [invalid_authentication, permission_denied, not_valid, system_error, bad_request, connection_timeout]

  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

  Contains validation error details

{
  "error": {
    "code": "not_valid",
    "message": "Data validation error",
    "data": {
      "param": "must be an string"
    }
  }
}

{
  "error": {
    "code": "invalid_authentication",
    "message": "Invalid authentication"
  }
}

Loading...