Skip to content

device-code.md

Latest commit

 

History

History
41 lines (33 loc) · 1.56 KB

device-code.md

File metadata and controls

41 lines (33 loc) · 1.56 KB
Raw

Device Code

Structure

Device Code

Fields

Name Type Tags Description
id string Optional The unique id for this device code.
name string Optional An optional user-defined name for the device code.
Constraints: Maximum Length: 128
code string Optional The unique code that can be used to login.
device_id string Optional The unique id of the device that used this code. Populated when the device is paired up.
product_type string Required Default: 'TERMINAL_API'
Default: 'TERMINAL_API'
location_id string Optional The location assigned to this code.
Constraints: Maximum Length: 50
status str (Device Code Status) Optional DeviceCode.Status enum.
pair_by string Optional When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format.
created_at string Optional When this DeviceCode was created. Timestamp in RFC 3339 format.
status_changed_at string Optional When this DeviceCode's status was last changed. Timestamp in RFC 3339 format.
paired_at string Optional When this DeviceCode was paired. Timestamp in RFC 3339 format.

Example (as JSON)

{
  "id": null,
  "name": null,
  "code": null,
  "device_id": null,
  "product_type": "TERMINAL_API",
  "location_id": null,
  "status": null,
  "pair_by": null,
  "created_at": null,
  "status_changed_at": null,
  "paired_at": null
}