Table 98. clockset api command response – Campbell Scientific CR1000 Measurement and Control System User Manual
Page 388
Section 8. Operation
388
ClockSet Response
The ClockSet
format
parameter determines the format of the response. If a format
is not specified, the format defaults to HTML. For more detail concerning data
response formats, see the Data File Formats
section.
Responses contain three fields as described in the following table:
Table 98. ClockSet API Command Response
outcome
1 — The clock was set
5 — Communication with the CR1000 failed
6 — Communication with the CR1000 is disabled
8 — An invalid URI was specified.
time
Specifies the value of the CR1000 clock before it was changed.
description
A string that describes the outcome code.
HTML Response
When
html
is entered in the ClockSet
format
parameter, the response will be
HTML. Following are example responses.
HTML tabular response:
HTML page source:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"><html>
<head><title>ClockSet Response</title></head>
<body>
<h1>ClockSet Response</h1>
<table border="1">
<tr><td>outcome</td><td>1</td>
</tr><td>time</td>
<td>2011-12-01 11:42:02.75</td>
</tr><tr><td>description</td><td>The clock was set</td></tr>
</table> </body> </html>
XML Response
When
xml
is entered in the ClockSet
format
parameter, the response will be
formated as CSIXML
(p. 68)
with a ClockSetResponse root element name.
Following is an example response.
<ClockSetResponse outcome="1" time="2011-12-01T11:41:21.17"
description="The clock was set"/>