Internet of Things (IoT) Controller API
This API defines the web service device which manufacturers must create to enable Arghon users
to manage/control your Internet connected devices.
Click here for XSD Specification file
Data Formats Sent and Received
HTTPS POST - REST/XML
API XML/REST INPUT Fields (Parameters)
The accountid used in authenticating the request as coming from arghon.com by your web-service.
This ID is supplied to arghon.com at the time the device manufacturer registers their device(s) at arghon.com.
The arghonpassword used in authenticating the request as coming from arghon.com by your web-service.
This password is supplied to arghon.com at the time the device manufacturer registers their device(s) at arghon.com.
The optional user's account id that allows your web-service to authenticate the request as coming from a legitimate user.
The optional user's account password that allows your web-service to authenticate the request as coming from a legitimate user.
optional device serial number. To make this a required field, set the "requires_serialnumber=1" when registering the device.
This value in this field is determined by you the device manufacturer. Some manufacturers require
the device's serial number in this field. Others require the name of the device. Here are some examples:
(1) 9344-43430-3444 :device's serial number.
The period character "." is reserved for deviceid that are sub control.
Example of controlnameid, the ones with a period denote sub controls:
The controlfeaturecode specifies the feature on the device the user is targeting for change.
An example value would be "power", to turn on the device.
An actioncode specifies the action that should be taken for the feature code. Action codes fall in 3 categories:
1. The action code could be a value such as a temperature or pressure to set on the vehicle.
2. The second type is mostly enabling or disabling a feature.
3. The final action code is the "status". When this value is sent, the response should be the current status of the feature in the controlFeatureCode.
If a device does not support an actioncode it should return the correct error message.
Click here to view list of action codes in xsd
API Response XML Fields
A text message that explains the error.
One single featurestatus is returned for all request except exstatus, which retuns one for each feature on a device.
See XSD documentation See documentation of "exstatus" feature.
The values for this field should be the same as the controlRequest action field.
featurename (featurestatus) required
The name of the feature code that is presented to the user when displaying the feature status.
controlfeaturecode=burn1 then featurename=Front Left Burner.
controlfeaturecode=oven_timer then featurename=Baking timer.
The text that is displayed to the user that has the current status of the device.
The actual current alpha or numeric value of the feature.
All temperatures are in Celsius. Do not include °C or °F in the value.
All distances are in meters. Do not include "M" or "m" or "meters" in value.
A code that tells Arghon how to interpret the value field.
See XSD documentation See documentation of "valueFormatTypes" codes.
The optional latitude of the device. Example 34.12304
The optional longitude of the device. Example -78.39488
This is an optional full URL to the an image of the device. It does not have to show the device's current settings.
The URL Arghon connects to is specified by you when in the registration IoT API
REST Example Control Request to turn on TV.
https://yourwebsite.com/services/devicecontroller/ HTTP POST
The URL to your web-service is specified in the call to the registration IoT API
Example XML Request to turn on TV
Example Response to REST/XML Request to turn on TV