Set the type of lock used
Set the type of lock used:
- electromagnetic
- electromechanical
- application/json
Request Body required
- locks object[] required
Lock type settings
Responses
- 200
- 400
- 401
- 403
OK
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
- Only 1, 2 indexes are available for the lock number
- "
pulse_on
andpulse_off
must be in range [1, 300]" - Invalid type of lock
- application/json
- Schema
- Example (from schema)
- Base
- No value
- Wrong param type
- Wrong lock type
- Wrong index
- Wrong pulse param
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": "Invalid type of lock"
}
{
"error": "Only 1, 2 indexes are available for the lock number"
}
{
"error": "`pulse_on` and `pulse_off` must be in range [1, 300]"
}
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"
}
Loading...