Set KONE lift settings

Configures KONE lift adapter, required for interaction with KONE module

application/json

Request Body required

• is_enabled boolean required

  Determines whether the feature is enabled

• building_id string required

  Possible values: Value must match regular expression ^building:.+:.+$

  Building id where panel is located and group id

• server_url string required

  Kone lift server address

• source_id int64 required

  Panel area location

• terminal_number integer required

  Lift terminal number used with panel

• walking_time integer required

  Possible values: <= 30

  Delay in seconds, this is added to any walking time determined based on the terminal. This param is needed when panel is outside of the lift lobby

• action_id integer

  Lift destination call action ID. Required for sending lift requests

• show_screen_timeout integer

  Possible values: >= 1 and <= 30

  Delay in seconds before closing the screen of an arriving elevator

• credentials object required

  Auth credentials

  client_secret string required

  Client token

  client_id string required

  Client id

Responses

• 200
• 400
• 401
• 403
• 404

---

OK

• Wrong url
• Building id must match 'building🆔groupId' pattern
• 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)
• Base
• No value
• Wrong param type
• Wrong url
• Wrong building id
• Wrong showing screen timeout
• Walking time

---

Schema

• error string

  Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "Wrong url"
}

{
  "error": "Building id must match `building:id:groupId` pattern"
}

{
  "error": "Show screen timeout must be in range from 1 to 30 seconds"
}

{
  "error": "Walking time must be in range from 0 to 30 seconds"
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

This feature is disabled on your device

Loading...