GET
Get information about a paired button.
| Responses | |
| 200 | GET successful. |
| 404 | Resource does not exist. |
| Response (application/json): object | ||
| Member | Type | Description |
connected | boolean | Indicates if the button is currently connected to this Base Unit. |
connectionCount | integer (int32) | The number of times this button has been connected to this Base Unit. |
firmwareVersion | string | The firmware version of the button. Example: 04.05.00 |
id | number | The ID for this button. Example: 1 read-only |
ipAddress | string (ipv4) | The IP address of the button. Example: 192.168.2.10 |
lastConnected | string (date-time) | The date and time that this button was last connected to this Base Unit. Example: 2019-04-11 19:37:53 |
lastPaired | string (date-time) | The date and time that this button was last paired by this Base Unit. Buttons that have been paired using the Button Manager will give the date and time of the first connection with the Base Unit after pairing. Example: 2019-05-14 16:55:38 |
macAddress | string (mac-address) | The MAC address of the button. Example: 00:11:22:33:44:55 |
modelInfo | string | The model info of the button. Example: GEN4.0 Since version: 2.12 read-only |
productId | string | The product ID of the button. Example: 0x0114 Since version: 2.17 read-only |
serialNumber | string | The serial number of the button. Example: 1860000001 |
status | string | The firmware and software status of the button. A value of 'Ok' means that the button firmware and software are up to date. A value of 'Error' means that the button firmware version is probably incompatible with the Base Unit firmware version and needs updating. A value of 'Warning' means that the firmware and software on the button is not the same as the one on the Base Unit, but they should be compatible and updating is not strictly required. |
supportedUsbIdentifierModes | array | The supported identification modes for the button's serial number. Example: ['Default', 'Room'] Since version: 2.16 read-only |
usbIdentifierMode | string | The identification mode in use for button's serial number Since version: 2.16 read-only |
vendorId | string | The vendor ID of the button. Example: 0x0600 Since version: 2.17 read-only |