Unlock a Lock

Issue an unlock command on the Device by its Device ID

Unlock Door for Device

POST https://connect.getseam.com/locks/unlock_door

Headers

NameTypeDescription

Authorization*

String

Bearer <API_KEY>

Request Body

NameTypeDescription

device_id*

String

ID of device to be unlocked

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UNLOCK_DOOR",
    "action_attempt_id": "e685a885-5f16-4b4d-acd1-22f5c00c6786",
    "result": null,
    "error": null
  },
  "ok": true
}

Code Example

seam.locks.unlock_door("123e4567-e89b-12d3-a456-426614174000")

# <Seam::ActionAttempt:0x008f6b0                                                         
#   status="pending"                                                                     
#   action_type="UNLOCK_DOOR"
#   action_attempt_id="4c3f9e12-5c9e-474e-92c4-719f72e13496"
#   result={}>

Parameters

device_id

type: string

Device ID

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

{
  "action_attempt": {
    "status": "pending",
    "action_type": "UNLOCK_DOOR",
    "action_attempt_id": "9d407023-acb3-4525-adc8-97c6dcf86104",
    "result": null,
    "error": null
  },
  "ok": true
}

status

"success" | "error" | "pending"

success determines a completed action performed on the device. error determines an unsuccessful action performed on the device. pending determines Seam is still trying to perform the action on the device

action_type

"UNLOCK_DOOR"

Determines the type of action performed on the device

action_attempt_id

String

ID of the action attempt

result

String

result only exists for the success status describing the event

error

Object

error only exists for the error status describing the event. It is an object with type and message. Where type determines type of error and message describes the error

Last updated

Logo

Β© Seam Labs, Inc. All rights reserved.