Get User Entity

Returns detailed info about User

Path Parameters

• user-id integer required

  Possible values: >= 1

  Unique Identifier for User Item

Responses

• 200
• 400
• 401

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• 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

• info string

  Possible values: <= 255 characters

  Extra information about of the user entity

• is_security boolean

  Security user has access to blocked doors.

• 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

  identifiers integer

  Count of identifiers attached to the user

  apartments integer

  Count of apartments attached to the user

  time_profiles integer

  Count of time_profiles attached to the user

  access_rules integer

  Count of access_rules attached to the user

{
  "id": 3,
  "name": "John Smith",
  "info": "Employee",
  "is_security": false,
  "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
  "references_count": {
    "identifiers": 1,
    "apartments": 1,
    "time_profiles": 1,
    "access_rules": 1
  }
}

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...