ReadSamples response message
- Last UpdatedAug 29, 2023
- 1 minute read
This is an example of the structure of a ReadSamples response message.
<ReadSamplesResponseMessage xmlns="http://www.citect.com/Ampla/RuntimeData/2008/04">
<Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<SampleCollections>
<SampleCollections>
<End>2018-08-18T00:33:39Z</End>
<IsDefined>True</IsDefined>
<SampleTypeCode>Event</SampleTypeCode>
<Samples>
<Sample>
<Quality>GoodNonspecific</Quality>
<TimeStamp>2018-08-18T00:31:22.9234284Z</TimeStamp>
<Value i:nil="true" />
</Sample>
</Samples>
<Start>2018-08-18T00:31:22.9234284Z</Start>
</SampleCollections>
</SampleCollections>
</Response>
</ReadSamplesResponseMessage>
Response parameters
|
Parameter |
Description |
|---|---|
|
SampleCollections |
Contains the details of a sample collection. |
|
End |
The end date time of the data stream query. A valid datetime stamp. For example, 2018-06-24T18:00:00Z. |
|
IsDefined |
Specifies whether the stream is initialized and contains values. Can be True or False. |
|
SampleTypeCode |
The data type of the stream. For example, Unspecified, Boolean, Int32, Int64, Single, Double, String, DateTime, Event. |
|
Samples |
Contains the set of returned samples. |
|
Sample |
Contains the details of a single sample. |
|
Quality |
The data quality of the sample data. For more info, see Quality states. Value can be any of the possible Quality/Substatus values: GoodNonspecific, BadNotConnected, UncertainNonspecific. |
|
TimeStamp |
The timestamp of the sample data. For example, 2018-08-18T00:31:22.9234284Z. |
|
Value |
The data value of the sample. Some streams allow null values, depending on the data type. |
|
Start |
The start date time of the data stream query. This must be a valid datetime stamp. For example, 2018-08-24T12:00:00Z. |