Instruction Manual

i.LON 100 Internet Server Programmer’s Reference 2-5
standards mentioned in the previous section. Every element in a SOAP Header, and all
immediate child elements must be namespace qualified. Therefore, each user defined
element contains a namespace prefix and a path to the unique Echelon Namespace.
The SOAP Header consists of a complex type with four fields describing different properties
of the message:
• <UCPTtimeStamp> This field contains a time stamp indicating when the message was
sent.
• <UCPTuniqueId> This field contains the Neuron ID of the i.LON 100, which is the third
Neuron ID in the i.LON 100s block of addresses.
• <UCPTipAddress> This field contains the IP address of the i.LON 100 that sent the
SOAP message.
• <UCPTport> This field contains the HTTP port specifier for the i.LON 100 web server.
2.3.2.2 <Result> Parameter
Another difference between response messages sent by the i.LON 100, and input messages
sent to the i.LON 100, is the <Result> element contained within the SOAP body. The above
example shows the string “Result” included in the <Result> parameter. This represents the
information that will be returned you invoke any of the functions described in this
manual.
The information that will be returned varies, depending on the function you are using. The
description of each function included in this document includes a sample <Result> parameter
that could be returned by the function, and information to help you interpret the contents of
the <Result> parameter.
2.3.3 SOAP Error Responses
The following represents the basic format of the SOAP message returned by the i.LON 100
when the input you supply to the function causes an error.
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<SOAP-ENV:Envelope
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<SOAP-ENV:faultcode>ErrorCode</SOAP-ENV:faultcode>
<SOAP-ENV:faultstring>ErrorMessage</SOAP-ENV:faultstring>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
You will notice that the SOAP envelope of an error response contains an attribute called
<SOAP-ENV:faultcode>. This contains the error code returned by the function. The next
attribute is the <SOAP-ENV:faultstring> attribute. This represents the description of the
error code returned by the function. The rest of the SOAP envelope and body is the same as
those inlcuded in the input and response SOAP messages sent to and from the i.LON 100
(excluding the <Data> and <Result> parameters).
Table 2 lists the error codes and messages that the i.LON 100 SOAP interface may return.
Table 2 SOAP Error Codes
Error Code Error Message