GET /edgeDevices/{linkId}/time

Gateway Firmware Versions 1.52.XX and later.

This resource is used to retrieve the current real-time clock (rtc) time from the specified edge device. When this resource is requested the Gateway requests the rtc time from the lock, sends this information to the host (in the response to this request), and caches this time for the next 8 hours. If any further requests of this endpoint are issued within 8 hours, the Gateway responds with the previously cached rtc time for that edge device. This 8 hour window prevents consecutive requests from waking the lock to send updated rtc time. For further requests after 8 hours the Gateway requests the rtc time from the lock, sends this information to the host (in the response to this request), and caches this time for the next 8 hours.

The time resolution reported is in minutes, therefore the seconds field always returns 00. If the edge device is disconnected from the Gateway when this resource is requested the Gateway returns the cached rtc value. Therefore it is recommended that the connection status of the edge device be consulted via the linkList resource if the rtc value in the response is the same as was sent previously and 8 hours have elapsed since the last request.

Authentication

Basic: Unique credentials defined and accepted during setup.

Request

URI parameters:  <missing or is this 'None'?>

• None

Success Response

HTTP status code: 200

Response parameters: <missing or is this 'None'?>

Type: application/json

• rtcTime = definition in ENGAGE – JSON Data Structures document.

  • If the request is received while the edge device is disconnected and the Gateway does not have a cached time value, the returned value will be “”.

Example

{"rtcTime”:”20170405051500}

Last Modified: October 16, 2019