sync-single.rst

Sync single

Sync single lock state by id.

Warning

You shouldn't run this endpoint more than once every 20 seconds.

GET |apiUrl|/api/|apiVersion|/my/lock/{id}/sync

URI Parameters

Name	Type	Description
id	number	id of lock to sync

Responses

Name	Type	Description
200 OK	Lock sync <../../datastructures/lock-sync>	successful operation

Scopes

Name	Description
Device.Read	Grants user possibility to read data connected with devices
Device.ReadWrite	Grants user possibility to read and write data connected with devices

Examples

Sync single lock

Sample Request

curl -X GET "|apiUrl|/api/|apiVersion|/my/lock/1/sync" -H "accept: application/json" -H "Authorization: Bearer <<access token>>"

Sample response for lock connected to bridge

HTTP status code: 200

{
    "result": {
        "id": 1,
        "isConnected": true,
        "lockProperties": {
            "state": 3,
            "isCharging": false,
            "batteryLevel": 54,
            "stateChangeResult": 0,
            "lastStateChangedDate": "2021-04-26T06:02:04.197Z"
        }
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 200
}

Sample response for lock disconnected from bridge

HTTP status code: 200

{
    "result": {
        "id": 1,
        "isConnected": false,
        "lockProperties": null
    }
    "success": true,
    "errorMessages": [],
    "statusCode": 200
}