IoT Controller API: Get Vehicle Status Command
This API examples demonstrates Arghon sending the get complete vehicle status command to an IoT controller.
Click this link for full documentation of each field in the request.
Data Formats Sent and Received
Input format(s)
HTTPS POST - REST/XML
API XML/REST INPUT Fields (Parameters)
arghonid required
The accountid used in authenticating the request as coming from arghon.com by your web-service.
argapitusid
arghonpassword required
The arghonpassword used in authenticating the request as coming from arghon.com by your web-service.
$ver@4988buf
useraccountid optional
The optional user's account id that allows your web-service to authenticate the request as coming from a legitimate user.
jsmith738
useraccountpwd optional
The optional user's account password that allows your web-service to authenticate the request as coming from a legitimate user.
w$trimaster92
device_serialnumber optional
optional device serial number.
N93884-499AK094-U43
deviceid required
This value in this field is determined by you the device manufacturer.
infiniti-qx384
controlfeaturecoderequired
The controlfeaturecode specifies the device feature the user is targeting for change.
exstatus
actioncoderequired
An actioncode specifies the action that should be taken for the feature code.
status
API Response XML Fields
message required
A text message that explains the error.
success
featurestatus required
A single featurestatus is returned for all each feature being returned.
See XSD documentation See documentation of "exstatus" feature.
.
controlfeaturecode (featurestatus)required
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.
value (featurestatus)required
The actual current numeric value of the feature.
valuetype (featurestatus)required
A code that tells Arghon how to interpret the value field.
See XSD documentation See documentation of "valueFormatTypes" codes.
.
REST command to get vehicle status command:
https://yourwebsite.com/services/devicecontroller/ HTTP POST
arghonid=argapitusid&arghonpassword=$ver@4988buf&deviceid=infiniti-qx384&device_serialnumber=N93884-499AK094-U43&controlfeaturecode=exstatus&actioncode=status&useraccountid=jsmith738&useraccountpwd=w$trimaster92
XML command to get vehicle status command:
<controlRequest>
<xmlversion>1</xmlversion>
<arghonid>argapitusid</arghonid>
<arghonpassword>$ver@4988buf</arghonpassword>
<deviceid>infiniti-qx384</deviceid>
<device_serialnumber>N93884-499AK094-U43</device_serialnumber>
<controlfeaturecode>exstatus</controlfeaturecode>
<actioncode>status</actioncode>
<useraccountid>jsmith738</useraccountid>
<useraccountpwd>w$trimaster92</useraccountpwd>
</controlRequest>
XML response to get vehicle status command:
<controlResponse>
<errorcode>0</errorcode>
<message>success</message>
<controlfeaturecode>exstatus</controlfeaturecode>
<featurestatus>
<controlfeaturecode>power</controlfeaturecode>
<featurename>Vehicle</featurename>
<value>off</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>door</controlfeaturecode>
<featurename>Doors</featurename>
<value>lock</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>location</controlfeaturecode>
<featurename>Vehicle Location</featurename>
<value>38.39488,-81.30409</value>
<valuetype>geopoint</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>radio</controlfeaturecode>
<featurename>Radio</featurename>
<value>off</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>trunk</controlfeaturecode>
<featurename>Trunk</featurename>
<value>lock</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>headlight</controlfeaturecode>
<featurename>head light</featurename>
<value>off</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>oil_pressure</controlfeaturecode>
<featurename>oil pressure</featurename>
<value>0</value>
<valuetype>psi</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>coolant_level</controlfeaturecode>
<featurename>Engine coolant level</featurename>
<value>95</value>
<valuetype>percent</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>fuel_level</controlfeaturecode>
<featurename>Fuel</featurename>
<value>50</value>
<valuetype>percent</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>coolant_temperature_level</controlfeaturecode>
<featurename>Coolant temperature</featurename>
<value>70</value>
<valuetype>temperature</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>alarm</controlfeaturecode>
<featurename>Alarm</featurename>
<value>on</value>
<valuetype>code</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>tire_pressure</controlfeaturecode>
<featurename>Tire pressure</featurename>
<value>35</value>
<valuetype>psi</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>rpm</controlfeaturecode>
<featurename>Tachometer</featurename>
<value>0</value>
<valuetype>rpm</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>airconditioner</controlfeaturecode>
<featurename>Air conditioning</featurename>
<value>off</value>
<valuetype>code</valuetype>
</featurestatus>
<controlfeaturecode>speed</controlfeaturecode>
<featurename>speed</featurename>
<value>0</value>
<valuetype>mph</valuetype>
</featurestatus>
<featurestatus>
<controlfeaturecode>window</controlfeaturecode>
<featurename>windows</featurename>
<value>close</value>
<valuetype>code</valuetype>
</featurestatus>
<latitude>38.39488</latitude>
<longitude>-81.30409</longitude>
</controlResponse>