Everything the device needs to render: status, onboarding code while waiting, home, parents, members, pending requests and the acknowledged event cursor.
Parameters
Output
application/jsondeviceId
string
Required
No description available.
home
ref#homeRef
Optional
No description available.
lastEventId
integer
Optional
No description available.
members
array
Optional
No description available.
onboardingCode
ref#onboardingCode
Optional
No description available.
parent1
ref#parent1
Optional
No description available.
parents
array
Optional
No description available.
pendingRequests
array
Optional
No description available.
status
string
Required
No description available.
registered, awaitingLink, active, unlinked, retiredErrors
DeviceNotFound
Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Everything the device needs to render: status, onboarding code while waiting, home, parents, members, pending requests and the acknowledged event cursor.",
"errors": [
{
"name": "DeviceNotFound"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"deviceId": {
"type": "string"
},
"home": {
"ref": "#homeRef",
"type": "ref"
},
"lastEventId": {
"type": "integer"
},
"members": {
"items": {
"ref": "ai.newnal.illi.home.defs#memberView",
"type": "ref"
},
"type": "array"
},
"onboardingCode": {
"ref": "#onboardingCode",
"type": "ref"
},
"parent1": {
"ref": "#parent1",
"type": "ref"
},
"parents": {
"items": {
"ref": "ai.newnal.illi.home.defs#parentView",
"type": "ref"
},
"type": "array"
},
"pendingRequests": {
"items": {
"ref": "#pendingRequest",
"type": "ref"
},
"type": "array"
},
"status": {
"knownValues": [
"registered",
"awaitingLink",
"active",
"unlinked",
"retired"
],
"type": "string"
}
},
"required": [
"deviceId",
"status"
],
"type": "object"
}
},
"parameters": {
"properties": {
"deviceId": {
"maxLength": 64,
"type": "string"
}
},
"required": [
"deviceId"
],
"type": "params"
},
"type": "query"
}