myViewBoard Open API Doc v2.3

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This API allow user to integrate myViewBoard control system with the myViewBoard Manager. User can obtain a valid API Key and use it to make operations on remote devices.

Base URLs:

https://oapi.myviewboard.com

Authentication

API Key (auth-mvbkey-prod)
- Parameter Name: Authorization, in: header.
API Key (auth-oidc-prod)
- Parameter Name: Authorization, in: header. Please contact myViewBoard customer service to get the API Key

Groups

Get list

Code samples

# You can also use wget
curl -X GET https://oapi.myviewboard.com/groups?entity_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'


const headers = {
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/groups?entity_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://oapi.myviewboard.com/groups", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.get('https://oapi.myviewboard.com/groups', params={
  'entity_id': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.get 'https://oapi.myviewboard.com/groups',
  params: {
  'entity_id' => 'string'
}, headers: headers

p JSON.parse(result)

GET /groups

Get the list of group information

Parameters

Name	In	Type	Required	Description
entity_id	query	string	true	entity ID
count	query	string	false	the number of groups per page, 100 by default
page	query	string	false	the page number, it will start at 1 by default

Example responses

200 Response

[
  {
    "id": "0pq4a8a1-gsvn-g048-ozx9-sxwrdvdb7apm",
    "name": "mENHtbGSwDkmTWul",
    "number_of_devices": 89014162
  },
  {
    "id": "zdqmatoj-kec0-ersr-cy2u-af7pmyx4pmt7",
    "name": "L7wgqIO94ExCAuNV",
    "number_of_devices": 89121141
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	200 response	GroupInfoList

Get device list

Code samples

# You can also use wget
curl -X GET https://oapi.myviewboard.com/groups/devices?entity_id=string&group_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'


const headers = {
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/groups/devices?entity_id=string&group_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://oapi.myviewboard.com/groups/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.get('https://oapi.myviewboard.com/groups/devices', params={
  'entity_id': 'string',  'group_id': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.get 'https://oapi.myviewboard.com/groups/devices',
  params: {
  'entity_id' => 'string',
'group_id' => 'string'
}, headers: headers

p JSON.parse(result)

GET /groups/devices

Get the list of device information

Parameters

Name	In	Type	Required	Description
count	query	string	false	the number of devices per page, 100 by default
page	query	string	false	the page number, it will start at 1 by default
entity_id	query	string	true	entity ID
group_id	query	string	true	group ID

Example responses

200 Response

[
  {
    "id": "pwqyneq8-vyk8-mdkn-4744-1lswanoqykk3",
    "last_connected": "2022-01-01T03:00:00.000Z",
    "local_ip_address": "172_21906130",
    "model": "AUCPJR4ZFW",
    "name": "Zl23SEfJy6vsEbwf",
    "note": "svizr9k7ajn2q35zin8j8lsit23j7jye",
    "status": true
  },
  {
    "id": "hc6f3ylb-rdg4-oh9u-3ca1-xz07udz6g6ke",
    "last_connected": "2022-01-01T03:00:00.000Z",
    "local_ip_address": "172l21o0Z130",
    "model": "ZMKU4Y8DGQ",
    "name": "XecTe78GA0adM9c9",
    "note": "axhdi9310e1k0b3tqtf6nokluz9n31ra",
    "status": false
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	200 response	GroupDeviceInfoList

Devices

Get list

Code samples

# You can also use wget
curl -X GET https://oapi.myviewboard.com/devices?entity_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'


const headers = {
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/devices?entity_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://oapi.myviewboard.com/devices", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.get('https://oapi.myviewboard.com/devices', params={
  'entity_id': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.get 'https://oapi.myviewboard.com/devices',
  params: {
  'entity_id' => 'string'
}, headers: headers

p JSON.parse(result)

GET /devices

Get the list of device information

Parameters

Name	In	Type	Required	Description
entity_id	query	string	true	entity ID
count	query	string	false	the number of devices per page, 100 by default
page	query	string	false	the page number, it will start at 1 by default

Example responses

200 Response

[
  {
    "advanced": false,
    "agent_version": "1.75.2",
    "asset_tag": "nzSpIpmcS6C",
    "date_of_enrollment": "2022-01-01T03:00:00.000Z",
    "fw_version": "75660627.521978",
    "id": "k2dd7i1c-cejd-vpnq-wx0c-qx9vqpfnwe93",
    "mac_address": "9c:5b:84:01:60:28",
    "model": "JAH10BEGQN",
    "name": "w9t95pzX6tpx0ynA",
    "note": "2gdc7bj6fc0paxgl3dm403zrpn6bgs2v",
    "os_version": "7zat2bxji9qp",
    "serial_number": "OB62W3L5VG5P",
    "status": true,
    "volume": "17",
    "wifi_ssid": "phyguz"
  },
  {
    "advanced": false,
    "agent_version": "1.1.11",
    "asset_tag": "RfKM9xosZzu",
    "date_of_enrollment": "2022-01-01T03:00:00.000Z",
    "fw_version": "77849754.721689",
    "id": "ql1um3y4-t0co-muaa-z9z8-mveldofjiete",
    "mac_address": "36:01:cb:1e:30:06",
    "model": "DRHXYHF2HF",
    "name": "yJBxbZm9ovdJFtiJ",
    "note": "8cjydfz1l9gc3ejb44pvz2xwtj8wzes2",
    "os_version": "ief27qnkrrpv",
    "serial_number": "1SKQX0JVJJBV",
    "status": false,
    "volume": "74",
    "wifi_ssid": "1t0bit"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	200 response	DeviceProfileList

Get statistics

Code samples

# You can also use wget
curl -X GET https://oapi.myviewboard.com/devices/statistics?entity_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'


const headers = {
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/devices/statistics?entity_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://oapi.myviewboard.com/devices/statistics", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.get('https://oapi.myviewboard.com/devices/statistics', params={
  'entity_id': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.get 'https://oapi.myviewboard.com/devices/statistics',
  params: {
  'entity_id' => 'string'
}, headers: headers

p JSON.parse(result)

GET /devices/statistics

Get the list of device statistics

Parameters

Name	In	Type	Required	Description
count	query	string	false	the number of devices per page, 100 by default
page	query	string	false	the page number, it will start at 1 by default
device_id	query	string	false	device IDs belong to the entity (concatenate multiple IDs into one string with comma)
entity_id	query	string	true	entity ID
group_id	query	string	false	group IDs belong to the entity (concatenate multiple IDs into one string with comma)

Example responses

200 Response

[
  {
    "id": "s6t08er7-4ckq-m45o-hlxp-nh9us9vm33uf",
    "last_boot_up": "2022-01-01T01:00:00.000Z",
    "last_connected": "2022-01-01T03:00:00.000Z",
    "total_uptime": "9 hrs 57 mins"
  },
  {
    "id": "hdibsq0a-m78a-usde-1bar-ph394tmoupxa",
    "last_boot_up": "2022-01-01T01:00:00.000Z",
    "last_connected": "2022-01-01T03:00:00.000Z",
    "total_uptime": "4 hrs 57 mins"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	200 response	DeviceStatisticsList

Get usage

Code samples

# You can also use wget
curl -X GET https://oapi.myviewboard.com/devices/usage?entity_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'


const headers = {
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/devices/usage?entity_id=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://oapi.myviewboard.com/devices/usage", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.get('https://oapi.myviewboard.com/devices/usage', params={
  'entity_id': 'string'
}, headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.get 'https://oapi.myviewboard.com/devices/usage',
  params: {
  'entity_id' => 'string'
}, headers: headers

p JSON.parse(result)

GET /devices/usage

Get the list of device usage

Parameters

Name	In	Type	Required	Description
count	query	string	false	the number of devices per page, 100 by default
device_id	query	string	false	device IDs belong to the entity (concatenate multiple IDs into one string with comma)
entity_id	query	string	true	entity ID
group_id	query	string	false	group IDs belong to the entity (concatenate multiple IDs into one string with comma)
end_time	query	string	false	the end time of time period (unix time in milliseconds)
start_time	query	string	false	the start time of time period (unix time in milliseconds)
page	query	string	false	the page number, it will start at 1 by default

Example responses

200 Response

[
  {
    "id": "y0fsumd2-93do-drx1-2lne-pg2x8yykpuhm",
    "name": "jdtC65Mmv28vVYKG",
    "usage_time": "71.9"
  },
  {
    "id": "bfuo5erq-n533-8pxm-7ior-w6lg1iv16pre",
    "name": "8oTUhamI3TBfKSys",
    "usage_time": "51.9"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	200 response	DeviceUsageList

Broadcast

Post broadcast message

Code samples

# You can also use wget
curl -X POST https://oapi.myviewboard.com/devices/broadcast \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'

const inputBody = '{
  "deviceIds": [
    "egzvxxnm-yhjj-5bei-nmlg-lhj7nz0p7deh",
    "6zkdnwv9-9y6c-23u8-96md-8zvu3s75mj28"
  ],
  "entityId": "fy05an9l-ywiq-z62b-lv5n-xas00t1gr8j0",
  "message": "XkBRCn`l3x+B:X~yQ`?A+YB'_tJ3vFUgWv._`p}i4%U,\\v~\"D+[BS!d'#K*o1|5oJuoX7sCZznt9w})Md}ze2^0DsgDn* \" y+m%x[bf(s.p]!*C0zX^5j~Fr--m!aGZskcj)zB@OWEeei'2p_S,-PURKSoZuxhIj{?ZLqw[q8[n>qCo7OOH%)j6:y@Ev[#I-eEJQA?M.UxL~Z vBlI~vHJ#\\a:+gPE(X\\-]O99jm_rt>p**J?SOQ sC8vkdHtm!>lqwSgJ~ij$3ukrNB02JQR)J,8]BvMq:YGo}1YjAHd'ZP3i1eQ}'g]&p&:+Dk @s\\ rTh;E2%Mir*Og\"L,?~Bbd*)eZ-T[wuK06YL$NSV9<Uyh]bwF0T%>rcW5^1bM[724jG)th&-u)f@7@   =?a:x6W5di%y>+B3u^95Xb~OhU(gfcMU8s;sv'\"5*D'XH~nw1> +@n+7c[+sign|d-co`:0MHA\\nA_C',WEG94#@2FH:,oFaFt(3fn(H p6`BL~HK3}]]e9gNiG$~,80ra(",
  "type": "urgent",
  "siren": true,
  "loops": -48693672
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/devices/broadcast',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://oapi.myviewboard.com/devices/broadcast", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.post('https://oapi.myviewboard.com/devices/broadcast', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.post 'https://oapi.myviewboard.com/devices/broadcast',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /devices/broadcast

Capture the broadcast message from the manager interface and send it from a control system - meaning that if we can connect myViewBoard Manager to their control system so they can streamline the broadcasting process. Instead of doing the broadcast using their control system and use Manager to broadcast to the panels, if they can integrate with our API, they can make this a one-step process.

Body parameter

{
  "deviceIds": [
    "egzvxxnm-yhjj-5bei-nmlg-lhj7nz0p7deh",
    "6zkdnwv9-9y6c-23u8-96md-8zvu3s75mj28"
  ],
  "entityId": "fy05an9l-ywiq-z62b-lv5n-xas00t1gr8j0",
  "message": "XkBRCn`l3x+B:X~yQ`?A+YB'_tJ3vFUgWv._`p}i4%U,\\v~\"D+[BS!d'#K*o1|5oJuoX7sCZznt9w})Md}ze2^0DsgDn* \" y+m%x[bf(s.p]!*C0zX^5j~Fr--m!aGZskcj)zB@OWEeei'2p_S,-PURKSoZuxhIj{?ZLqw[q8[n>qCo7OOH%)j6:y@Ev[#I-eEJQA?M.UxL~Z vBlI~vHJ#\\a:+gPE(X\\-]O99jm_rt>p**J?SOQ sC8vkdHtm!>lqwSgJ~ij$3ukrNB02JQR)J,8]BvMq:YGo}1YjAHd'ZP3i1eQ}'g]&p&:+Dk @s\\ rTh;E2%Mir*Og\"L,?~Bbd*)eZ-T[wuK06YL$NSV9<Uyh]bwF0T%>rcW5^1bM[724jG)th&-u)f@7@   =?a:x6W5di%y>+B3u^95Xb~OhU(gfcMU8s;sv'\"5*D'XH~nw1> +@n+7c[+sign|d-co`:0MHA\\nA_C',WEG94#@2FH:,oFaFt(3fn(H p6`BL~HK3}]]e9gNiG$~,80ra(",
  "type": "urgent",
  "siren": true,
  "loops": -48693672
}

Parameters

Name	In	Type	Required	Description
body	body	DeviceBroadcastRequest	true	none
» deviceIds	body	[string]	true	a list of device IDs
» entityId	body	string	true	entity ID
» loops	body	integer	false	loop period in seconds (0 = forever and it is for standard message only)
» message	body	string	true	message content (1024 character max for standard and 300 character max for urgent)
» siren	body	boolean	false	siren on or off (it is for urgent message only)
» type	body	string	true	standard or urgent message

Example responses

200 Response

{
  "message": "success",
  "messageCode": -17411942,
  "responseCode": -89942439,
  "status": -31141133
}

Responses

Status	Meaning	Description	Schema
200	OK	200 response	DeviceBroadcastResponse

Post stop the broadcast

Code samples

# You can also use wget
curl -X POST https://oapi.myviewboard.com/devices/broadcast/stop \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: bearer ************'

const inputBody = '{
  "deviceIds": [
    "nbxtch21-2wpz-3ucp-pj4r-ggbo1n2m3wfu",
    "lgn3b5hm-8cn3-10tv-7pln-os2olpfyy04h"
  ],
  "entityId": "vv29t4ny-d084-j1nj-f7gr-5bjct21gcbgq"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'bearer ************'
};

fetch('https://oapi.myviewboard.com/devices/broadcast/stop',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"bearer ************"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://oapi.myviewboard.com/devices/broadcast/stop", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'bearer ************'
}

r = requests.post('https://oapi.myviewboard.com/devices/broadcast/stop', headers = headers)

print(r.json())

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'bearer ************'
}

result = RestClient.post 'https://oapi.myviewboard.com/devices/broadcast/stop',
  params: {
  }, headers: headers

p JSON.parse(result)

POST /devices/broadcast/stop

Stop broadcasting to device

Body parameter

{
  "deviceIds": [
    "nbxtch21-2wpz-3ucp-pj4r-ggbo1n2m3wfu",
    "lgn3b5hm-8cn3-10tv-7pln-os2olpfyy04h"
  ],
  "entityId": "vv29t4ny-d084-j1nj-f7gr-5bjct21gcbgq"
}

Parameters

Name	In	Type	Required	Description
body	body	DeviceBroadcastStopRequest	true	none
» deviceIds	body	[string]	true	a list of device IDs
» entityId	body	string	true	entity ID

Example responses

200 Response

{
  "message": "success",
  "messageCode": -41088787,
  "responseCode": -66419152,
  "status": 91939082
}

Responses

Status	Meaning	Description	Schema
200	OK	200 response	DeviceBroadcastResponse

Schemas

DeviceUsageList

[
  {
    "id": "string",
    "name": "string",
    "usage_time": "string"
  }
]

Device Usage List

Properties

Name	Type	Required	Restrictions	Description
Device Usage List	[DeviceUsage]	false	none	none

DeviceBroadcastRequest

{
  "deviceIds": [
    "string"
  ],
  "entityId": "string",
  "loops": 0,
  "message": "string",
  "siren": true,
  "type": "string"
}

Broadcast request

Properties

Name	Type	Required	Restrictions	Description
deviceIds	[string]	true	none	a list of device IDs
entityId	string	true	none	entity ID
loops	integer	false	none	loop period in seconds (0 = forever and it is for standard message only)
message	string	true	none	message content (1024 character max for standard and 300 character max for urgent)
siren	boolean	false	none	siren on or off (it is for urgent message only)
type	string	true	none	standard or urgent message

GroupInfoList

[
  {
    "id": "string",
    "name": "string",
    "number_of_devices": 0
  }
]

Group list

Properties

Name	Type	Required	Restrictions	Description
Group list	[GroupInfo]	false	none	none

GroupInfo

{
  "id": "string",
  "name": "string",
  "number_of_devices": 0
}

Group information

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
number_of_devices	integer	true	none	none

DeviceBroadcastResponse

{
  "message": "string",
  "messageCode": 0,
  "responseCode": 0,
  "status": 0
}

Broadcast response

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	none
messageCode	integer	true	none	none
responseCode	integer	true	none	none
status	integer	true	none	none

GroupDeviceInfoList

[
  {
    "id": "string",
    "last_connected": "string",
    "local_ip_address": "string",
    "model": "string",
    "name": "string",
    "note": "string",
    "status": true
  }
]

Group device list

Properties

Name	Type	Required	Restrictions	Description
Group device list	[GroupDeviceInfo]	false	none	none

GroupDeviceInfo

{
  "id": "string",
  "last_connected": "string",
  "local_ip_address": "string",
  "model": "string",
  "name": "string",
  "note": "string",
  "status": true
}

Group device information

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
last_connected	string	true	none	none
local_ip_address	string	true	none	none
model	string	true	none	none
name	string	true	none	none
note	string	true	none	none
status	boolean	true	none	HTTP Status Code

DeviceUsage

{
  "id": "string",
  "name": "string",
  "usage_time": "string"
}

Device usage information

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
name	string	true	none	none
usage_time	string	true	none	none

DeviceProfile

{
  "advanced": true,
  "agent_version": "string",
  "asset_tag": "string",
  "date_of_enrollment": "string",
  "fw_version": "string",
  "id": "string",
  "mac_address": "string",
  "model": "string",
  "name": "string",
  "note": "string",
  "os_version": "string",
  "serial_number": "string",
  "status": true,
  "volume": "string",
  "wifi_ssid": "string"
}

Device information

Properties

Name	Type	Required	Restrictions	Description
advanced	boolean	true	none	none
agent_version	string	true	none	none
asset_tag	string	true	none	none
date_of_enrollment	string	true	none	none
fw_version	string	true	none	none
id	string	true	none	none
mac_address	string	true	none	none
model	string	true	none	none
name	string	true	none	none
note	string	true	none	none
os_version	string	true	none	none
serial_number	string	true	none	none
status	boolean	true	none	HTTP Status Code
volume	string	true	none	none
wifi_ssid	string	true	none	none

Empty

{}

Empty Schema

Properties

None

DeviceProfileList

[
  {
    "advanced": true,
    "agent_version": "string",
    "asset_tag": "string",
    "date_of_enrollment": "string",
    "fw_version": "string",
    "id": "string",
    "mac_address": "string",
    "model": "string",
    "name": "string",
    "note": "string",
    "os_version": "string",
    "serial_number": "string",
    "status": true,
    "volume": "string",
    "wifi_ssid": "string"
  }
]

Device Profile List

Properties

Name	Type	Required	Restrictions	Description
Device Profile List	[DeviceProfile]	false	none	none

DeviceStatisticsList

[
  {
    "id": "string",
    "last_boot_up": "string",
    "last_connected": "string",
    "total_uptime": "string"
  }
]

Device Statistics List

Properties

Name	Type	Required	Restrictions	Description
Device Statistics List	[DeviceStatistics]	false	none	none

DeviceStatistics

{
  "id": "string",
  "last_boot_up": "string",
  "last_connected": "string",
  "total_uptime": "string"
}

Device statistics information

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
last_boot_up	string	true	none	none
last_connected	string	true	none	none
total_uptime	string	true	none	none

DeviceBroadcastStopRequest

{
  "deviceIds": [
    "string"
  ],
  "entityId": "string"
}

root

Properties

Name	Type	Required	Restrictions	Description
deviceIds	[string]	true	none	a list of device IDs
entityId	string	true	none	entity ID