1 fault messages (application layer) – Echelon i.LON SmartServer 2.0 User Manual
Page 21
i.LON SmartServer 2.0 Programmer’s Reference
2-7
<soap:Body>
<MessageName xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<xSelect>xSelectStatement</xSelect>
<Item
xsi:type=“type”>
<UCPTname>networkName/channelName/deviceName/functionBlockName/pointName<UCPTname>
<Parameter1>Parameter1Value</Parameter1>
<Parameter2>Parameter2Value</Parameter2>
...
</Item>
...
</iLonItem>
</MessageName>
</soap:Body>
<SOAP-ENV:Body>
<MessageNameResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<UCPTfaultCount>0</UCPTfaultCount>
<Item
xsi:type=“type”>
<UCPTindex>0</UCPTindex>
<UCPTname>networkName/channelName/deviceName/functionBlockName/pointName<UCPTname>
<Parameter1>Parameter1Value</Parameter1>
<Parameter2>Parameter2Value</Parameter2>
...
</Item>
...
</iLonItem>
</MessageNameResponse>
</SOAP-ENV:Body>
2.5.3.1 Fault Messages (Application Layer)
The SOAP body in the response for every function in the SOAP/XML interface contains information
indicating whether any errors occurred while processing the request. Each item instance can contain a
fault object. An item instance without a fault object indicates an item that was successfully processed.
The following examples demonstrate instances that succeeded (no fault objects), an instance that was
applied but is not valid (faultType="_warning"), and an instance that was rejected
(faultType="_error"). The <UCPTfaultCount> tag informs the client about the number of warnings
and errors that have occurred. If <UCPTfaultCount> is 0, then no faults occurred.
Example 1 (warning occurs at the item level):
<SetResponse
xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<UCPTfaultCount>1</UCPTfaultCount>
<Item>
<fault>
<faultcode
faultType="_warning">4</faultcode>
<faultstring
xml:lang="en-US">fault
string</faultstring>
</fault>
<UCPTname>networkName/channelName/deviceName/myAG</UCPTname>
</Item>
<Item>
<UCPTname>networkName/channelName/deviceName/yourAG</UCPTname>
</Item>
</iLonItem>
</SetResponse>
Although an item instance has a warning fault code, it can still be processed. All other item instances
with a fault object can be processed.
Example 2 (error occurs at the item level):
<SetResponse xmlns="http://wsdl.echelon.com/web_services_ns/ilon100/v4.0/message/">
<iLonItem>
<UCPTfaultCount>1</UCPTfaultCount>
<Item>