Creating Access Code CRUD Endpoints

Overview

Access Codes CRUD endpoints Seam to list access codes created on a door lock.

Listing Access Codes

After a Door Lock Owner logs in and Seam lists all the access codes that have been programmed and shows them what's been programmed on the door lock. Your Door Locks system should return a JSON list of the access codes on a door lock.

List all access codes for a lock

GET https://devicecloud.example.com/access_codes?lock_id=<LOCK_ID>

Headers

Name	Type	Description
Authorization*	String	Bearer <access_token>

200: OK List of Access Codes in JSON

{
    "access_codes": [
        {
            "access_code_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "lock_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "owner_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "code": "1234",
            // Optional, but recommended
             "name": "Resident 001 Code"
        },
        {
            "access_code_id": "3043fde0-3c6d-4913-981f-2607f05fe743",
            "lock_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "owner_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
            "code": "2345",
            // Optional, but recommended
             "name": "Resident 002 Code"
        },
    ]
}

Getting an Access Code

Seam may request access code information to display information about an access code to the connecting user.

Get information about a single access code

GET https://devicecloud.example.com/access_codes/<ACCESS_CODE_ID>

Query Parameters

Name	Type	Description
ACCESS_CODE_ID*	String	Identifier for Access Code

Headers

Name	Type	Description
Authorization*	String	Bearer <access_token>

200: OK A single access code JSON object

{
  "access_code_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
  "intercom_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
  "owner_id": "3043fde0-3c6d-4913-981f-2607f05fe74e",
  "code": "1234",
  // Optional, but recommended
  "name": "Resident 001 Code"
}

Removing an Access Code

Seam needs to disable access codes. We need an endpoint to be able to remove an access code.

Remove an access code

DELETE https://devicecloud.example.com/access_codes/<ACCESS_CODE_ID>

Headers

Name	Type	Description
Authorization*	String	Bearer <access_token>
Content-Type*	String	application/json

500: Internal Server Error Something went wrong removing the access code.

{
    "error_id": "ACCESS_CODE_REMOVAL_FAILED",
    "error_message": "Unexpected Server Error"
}

200: OK Access Code successfully removed.

{
    "ok": true
}