Real Time Automation, Inc.
44
1-800-249-1612
The format is the same if you are filtering within a specific device. For instance, to request the same
points encoded as XML within a single Device named “Breaker1”, the URL to use would be:
http://192.168.0.1/gateway/xml/device/Breaker1?Temperature&Tripped_State
S
PECIAL
C
ONSIDERATIONS WHEN
F
ILTERING BY
P
OINT
N
AMES
Normally if you make a request for a group or device name that does not exist, the
gateway returns an HTTP 404 “Not Found” error status code. When you are
requesting data with a data points filtering list, you will only get an HTTP 404 status
code if
none
of the points in the list are found. This is important if you are generating
your request strings programmatically, as the only way to determine if a data point
was not found in such a case would be to examine the encoded output for the
existence of the data point names you requested in the encoded data.
Advanced (Optional XML Data Direction Annotation)
An additional option when requesting all the data from the gateway in XML format is to include the
“annotateio=true” option in the request URL. This option may only be used when requesting the entire
dataset from the gateway in XML. This does not apply to requesting JSON data.
http://192.168.0.1/gateway/xml?annotateio=true
This will include an XML attribute in the XML that indicates whether a given data point is an
input
or
output
. Note that an “input” is a
write data point
in the 460WI’s configuration, and an “output” is a
read
data point
. Refer the following example for reference:
This will typically only be used for custom programmatic access to initially determine the nature of the
460WI’s data such as can be seen in the included Excel example code. Please refer to the 460 Encoder
XML Data Retrieval Format section for a more detailed explanation of the XML data format generated by
the encoder.
…
<DataPointOne iotype="output">4</DataPointOne>
<DataPointTwo iotype="input">3</DataPointTwo>
…
Figure 1: Example of XML segment with IO type annotation.
