Get the main device id

Function Description:

Get the main device id value.

Corresponding JS API:
Device.getMain()
Whether to support multiple devices:

No

Resource Information:

Method GET
URL .../devices/main?type=number
Requires authentication? Yes


Method Parameters:

Parameter Type Required Description
type String No A fixed value: number, to get device serial number(for Total Control Version 6.9.0 and later).


Response Parameters:

A JSON string representing an array of objects with the following fields.

If resource URL is ".../devices/main", the return value is as follows:

Field Type Description
id String The main device id value, for example:device@1116106541

If resource URL is ".../devices/main?type=number", the return value is as follows:

Field Type Description
id Int The main device serial number, for example:5.
Note that the device serial number is returned only in MDCC, not in the MDCC, and the returned id value is always 0.


Request Example:
http://localhost:8090/TotalControl/v1/devices/main?token=270eq7lXQK8bXYsJ 

or

http://localhost:8090/TotalControl/v1/devices/main?token=270eq7lXQK8bXYsJ&type=number
Response Example:

If this API executes successfully, it returns:

{
    "id":"device@1116106541"
}

or

{
    "id":3
}


Example:

Warm tip:
Get the token needed for Total Control script development,see here.

RingoJS Example:
// Import the packages
var {request} = require("ringo/httpclient");
var base64 = require("ringo/base64");

// The username and password are separated by a single : and sent on the wire base64 encoded
var userpass = base64.encode("sigma:3D391497");

// First step: Get the API token
var gettoken = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/login",
	headers: {
		"Authorization": userpass
	}
});
var ret_token = JSON.parse(gettoken.content); 
var token = ret_token.value.token; 
print("//The value of token is:" + token);

// Second step: Get the device id value of the master device
var getdevice = request({
	method: "GET",
	url: "http://localhost:8090/TotalControl/v1/devices/main?type=number&token=" + token
});
print("Get the device id,Return value: "+getdevice.content);
var device = JSON.parse(getdevice.content).id; 
print("//The value of device ID is:"+ device);
The running result of the RingoJS:

If it executes successfully, it will return:

//The value of token is:veLZf8EL7gUoyFOL
Get the device id,Return value: {"id":1}
//The value of device ID is:1
Python Example:
#!/user/bin/python
#-*- coding:utf-8 -*-
import base64
import requests

# The username and password are separated by a single : and sent on the wire base64 encoded
user_pass = 'sigma:3D391497'
encodeStr = base64.b64encode(user_pass.encode("UTF-8"))

# First step: Get the API token
LoginUrl = "http://localhost:8090/TotalControl/v1/login"
response = requests.get(LoginUrl, headers={'Authorization':encodeStr})
print("Get the token,Return value: ",response.json())
token = response.json()['value']['token']
print("The value of token is: ",token)

# Second step: Get the device id value of the master device
if token is not None:
    GetDeviceUrl = "http://localhost:8090/TotalControl/v1/devices/main?token=" + token
    response = requests.get(url=GetDeviceUrl)
    print("Get the device id,Return value: ", response.json())
    device = response.json()['id']

    if device is not None:
        print("The value of device id is: ", device)
    else:
        print("Failed to get device id.")
else:
    print("Failed to get token.")
The running result of the python:

If it executes successfully, it will return:

Get the token,Return value:  {'status': True, 'value': {'token': 'SPQxpZO2Qz79oFWG'}}
The value of token is:  SPQxpZO2Qz79oFWG
Get the device id,Return value:  {'id': 'device@33254183'}
The value of device id is:  device@33254183