End user Operations

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def authenticate_device_code(self, device_name, device_password):
        try:
            endpoint = '{0}deviceAuth'.format(self.url)
            args = {
                'secToken': self.token,
                'name': device_name,
                'password': device_password,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            return root.find('devId').text
        except AttributeError:
            print_error('deviceAuth', root)
            exit()

    def add_device(self, device_name, device_id, device_type_name):
        try:
            endpoint = '{0}addDeviceToUser'.format(self.url)
            args = {
                'secToken': self.token,
                'userId': self.user_id,
                'deviceId': device_id,
                'deviceName': device_name,
                'typeName': device_type_name,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            return_code = root.find('retCode').text
            if return_code == '0':
                print('Device successfully added to account.')
        except AttributeError:
            print_error('addDeviceToUser', root)
            exit()

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"
device_name = "1234500474"
device_password = "DH"
device_type_name = "MonitorDemo"

customer = Customer(username, password, app_id, url)
customer.log_in()
device_id = customer.authenticate_device_code(device_name, device_password)
customer.add_device(device_name, device_id, device_type_name)

deviceAuth

Authenticates a Device Code.

Parameters

The diagram below explains the relationship between the terms Device Code, Device Password, and Device Name.

Response

Examples

HTTP

The name parameter corresponds to the Device Name of the device. The password parameter corresponds to the Device Password of the device.

https://example.arrayent.com/zdk/services/zamapi/deviceOwner?secToken=
28954789257-fg897245687ab987frt&name=1234569150234&password=25KBA

<ns1:deviceOwnerResponse xmlns:ns1="http://arrayent.com/zamapi/">
 <devId>28954789257</devId> </ns1:deviceOwnerResponse>

Python

getDeviceAttribute

Retrieves the current value for a single attribute of a single device.

Usage

This operation is documented for legacy purposes. For retrieving device attrbute values see getDeviceValueList.

Warning

If you need to retrieve the values of two or more attributes then you should use getDeviceValueList, rather than callinggetDeviceAttribute once for each attribute. The batch operation is significantly more efficient.

Parameters

Response

Examples

https://example.arrayent.com/zdk/services/zamapi/getDeviceAttribute?
secToken=000-12345678&devId=12345&name=foo

<ns1:getDeviceAttributeResponse xmlns:ns1="http://arrayent.com/zamapi/">
 <value>30</value>
 <updTime>1829402054</updTime>
</ns1:getDeviceAttributeResponse>

getDeviceAttributesWithValues

Retrieves the list of device attribute definitions for a single device, in addition to the current value of each device attribute. This includes any global attributes that have been defined for the specified device data model.

Parameters

Response

configuration

attrList

Examples

HTTP

https://DevKit-api.arrayent.com/zdk/services/zamapi/
getDeviceAttributesWithValues?deviceTypeId=1016&
devId=19300&secToken=912-1769025809

Show more
Show less
<ns1:getDeviceAttributesWithValuesResponse xmlns:ns1="http://arrayent.com/zamapi/">
 <typeId>1016</typeId>
 <typeName>Refrigerator</typeName>
 <presenceInfo>0</presenceInfo>
 <configurations>
 <property>sleepMode</property>
 <value>SHORT</value>
 </configurations>
 <configurations>
 <property>multiAttributeCapable</property>
 <value>false</value>
 </configurations>
 <attrList>
 <id>12971</id>
 <name>is_open</name>
 <displayName>Status of refrigerator door.</displayName>
 <device>true</device>
 <presistent>true</presistent>
 <ts>true</ts>
 <global>false</global>
 <tsValueType>1</tsValueType>
 <hardwareIOType>Input</hardwareIOType>
 <enumeratedAlias>200</enumeratedAlias>
 <value>1</value>
 <updTime>1390265012344</updTime>
 </attrList>
 <attrList>
 <id>12981</id>
 <name>target_temperature_fahrenheit</name>
 <displayName>Desired temperature, Farhenheit.</displayName>
 <device>true</device>
 <presistent>true</presistent>
 <ts>false</ts>
 <global>false</global>
 <tsValueType>7</tsValueType>
 <hardwareIOType>Output</hardwareIOType>
 <enumeratedAlias>201</enumeratedAlias>
 <value>40</value>
 <updTime>1390265016311</updTime>
 </attrList>
</ns1:getDeviceAttributesWithValuesResponse>

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
          'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def get_device_list(self):
        try:
            endpoint = '{0}getDeviceList'.format(self.url)
            args = {
                'secToken': self.token,
                'userId': self.user_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            if root.find('devList') is not None:
                return root
        except AttributeError:
            print_error('getDeviceList', root)
            exit()

    def get_device_attributes_with_values(self, device_type_id, device_id):
        try:
            endpoint = '{0}getDeviceAttributesWithValues'.format(self.url)
            args = {
                'deviceTypeId': device_type_id,
                'secToken': self.token,
                'devId': device_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            if root.find('typeName') is not None:
                return root
        except AttributeError:
            print_error('getDeviceAttributesWithValues', root)
            exit()
        
username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
device_list = customer.get_device_list()
for device in device_list.findall('devList'):
    device_id = device.find('devId').text
    device_type_id = device.find('typeId').text
    data = customer.get_device_attributes_with_values(device_type_id, device_id)
    print('Device Type: {0}'.format(data.find('typeName').text))
    print('Online Status: {0}'.format(data.find('presenceInfo').text))

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def get_device_list(self):
        try:
            endpoint = '{0}getDeviceList'.format(self.url)
            args = {
                'secToken': self.token,
                'userId': self.user_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            print('Device list retrieved. Printing device information...')
            i = 1
            for device in root.findall('devList'):
                device_name = device.find('devName').text
                device_id = device.find('devId').text
                device_type_id = device.find('typeId').text
                print('[{0}] Device Name: {1}, Device ID: {2}, Device Type ID: {3}'
                      .format(i, device_name, device_id, device_type_id))
                i += 1
        except AttributeError:
            print_error('getDeviceList', root)
            exit()

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
customer.get_device_list()

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class System(object):
    def __init__(self, username, password, url):
        self.username = username
        self.password = password
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}systemLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.app_id = root.find('appId').text
        except AttributeError:
            print_error('systemLogin', root)
            exit()

    def delete_customer_account(self, user_id):
        try:
            endpoint = '{0}deleteUser'.format(self.url)
            args = {
                'sysSecToken': self.token,
                'userId': user_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            if root.find('retCode').text == '0':
                print('Customer account successfully deleted.')
            else:
                print('Customer account deletion failed.')
        except AttributeError:
            print_error('deleteUser', root)
            exit()

    def get_user_id(self, username):
        try:
            endpoint = '{0}getUserByName'.format(self.url)
            args = {
                'sysSecToken': self.token,
                'name': username,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            return root.find('userID').text
        except AttributeError:
            print_error('getUserByName', root)
            exit()

system_account_username = "devkit2165"
system_account_password = "password1234"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"
customer_account_username = "john@email.com"

system = System(system_account_username, system_account_password, url)
system.log_in()
user_id = system.get_user_id(customer_account_username)
system.delete_customer_account(user_id)

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def get_arrayent_cloud_time(self):
        try:
            endpoint = '{0}getServerTime'.format(self.url)
            args = {
                'secToken': self.token,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            time = root.find('time').text
            print('Current time in Arrayent Cloud: {0}'.format(time))
            print('Note: time is milliseconds since UNIX epoch, GMT')
        except AttributeError:
            print_error('userLogin', root)
            exit()       

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
customer.get_arrayent_cloud_time()

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def get_user_attributes(self):
        try:
            endpoint = '{0}getUserValueList'.format(self.url)
            args = {
                'secToken': self.token,
                'userName': self.username,
                'userId': self.user_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            for attribute in root.findall('valist'):
                print('{0}: {1}'.format(attribute.find('name').text, 
                                        attribute.find('value').text))
        except AttributeError:
            print_error('userLogin', root)
            exit()
            
username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
customer.get_user_attributes()  

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

    def log_out(self):
        try:
            endpoint = '{0}logout'.format(self.url)
            args = {
                'secToken': self.token,
                'username': self.username,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            if root.find('retCode').text == '0':
                print('User successfully logged out.')
            else:
                print('Something went wrong. Printing response to logout...')
                print(response.text)
        except AttributeError:
            print_error('logout', root)
            exit()

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
customer.log_out()

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()
            
    def set_user_attribute(self, name, value):
        try:
            endpoint = '{0}setUserAttribute'.format(self.url)
            args = {
                'secToken': self.token,
                'userId': self.user_id,
                'name': name,
                'value': value,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            result = root.find('retCode').text
        except AttributeError:
            print_error('userLogin', root)
            exit()
            
    def get_user_attributes(self):
        try:
            endpoint = '{0}getUserValueList'.format(self.url)
            args = {
                'secToken': self.token,
                'userName': self.username,
                'userId': self.user_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            for attribute in root.findall('valist'):
                print('{0}: {1}'.format(attribute.find('name').text, 
                                        attribute.find('value').text))
        except AttributeError:
            print_error('userLogin', root)
            exit()            

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
print('Setting zipCode to 94010...')
print('Note: zipCode is a custom user attribute that was' + 
      'defined specifically for this App ID. It does not exist by default.')
customer.set_user_attribute('zipCode', '94010')
print('Getting all attributes and verifying zipCode is now set to 94010...')
customer.get_user_attributes()

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()
            
    def update_password(self, new_password):
        try:
            endpoint = '{0}updatePassword'.format(self.url)
            args = {
                'secToken': self.token,
                'username': self.username,
                'oldPassword': self.password,
                'newPassword': new_password,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            if root.find('retCode').text == '0':
                print('Password updated.')
            self.password = new_password
            self.log_in() # log in with new password
        except AttributeError:
            print_error('updatePassword', root)
            exit()
            

username = "john@email.com"
old_password = "password1234"
new_password = 'newpass1234'
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, old_password, app_id, url)
customer.log_in()
customer.update_password(new_password)
print('Setting password back to original...')
customer.update_password(old_password) # set password back to original

import requests  # docs.python-requests.org
import xml.etree.ElementTree as element_tree

def print_error(operation_name, xml_root):
    print('{0} failed! Printing error message...'.format(operation_name))
    for element in xml_root:
        print('{0}: {1}'.format(element.tag, element.text))

class Customer(object):
    def __init__(self, username, password, app_id, url):
        self.username = username
        self.password = password
        self.app_id = app_id
        self.url = url

    def log_in(self):
        try:
            endpoint = '{0}userLogin'.format(self.url)
            args = {
                'name': self.username,
                'password': self.password,
                'appId': self.app_id,
            }
            response = requests.get(endpoint, params=args)
            root = element_tree.fromstring(response.text)
            self.token = root.find('securityToken').text
            self.user_id = root.find('userId').text
        except AttributeError:
            print_error('userLogin', root)
            exit()

username = "john@email.com"
password = "password1234"
app_id = "2165"
url = "https://devkit-api.arrayent.com/zdk/services/zamapi/"

customer = Customer(username, password, app_id, url)
customer.log_in()
print('Security Token: {0}, User ID: {1}'.format(customer.token, customer.user_id))