Set time after opening until locking

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Time for which the relay contacts will be closed after opening

Path Parameters

• lockNumber integer required

  Possible values: [1, 2]

  1 - first lock, 2 - second lock

application/json

Request Body required

• lock_timeout integer required

  Possible values: >= 1 and <= 40

  Timeout in seconds

Responses

• 200
• 400
• 401

---

OK

• Wrong lockNumber
• Wrong timeout range
• 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 lock number
• Wrong timeout

---

Schema

• error string

  error type/info

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

{
  "error": "Wrong timeout range"
}

Log In

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• error string

  error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Loading...