Services / user / forcevariables.xml? id = device – CIRCUTOR PowerStudio Series User Manual

Page 25

Advertising
background image

PowerStudio

User Manual 25

3.1.5 / services / user / forceVariables.xml? id = device

With this request we may send the order to force variables to PowerStudio. The request must

include the name of the device we want to force so that, if necessary, authentication can be checked
(see ¡Error! No se encuentra el origen de la referencia. ¡Error! No se encuentra el origen de la
referencia.
). Only variables belonging to the device indicated in the request will be forced.

<forceVariables>

<forceVar>

<forceName>… </ forceName>

<forceValue>… </ forceValue>

</ forceVar>

</forceVariables>

Where:

forceVariables: Main field that will identify the XML as a request to force variables.

forceVar: Information on each of the variables to be forced:

forceName: Name of the variable in device.variable format (Refer to the

variable appendix in the ‘Devices Manual’).Only variables that can be forced,
for example digital output variables.

forceValue: Value to which we wish to force the variable.


3.1.6 /services/user/records.xml?begin=…?end=…?var=…?period=900

Returns information on one or more variables between the dates “begin” and “end”. Each of

the variables that the information is required from should be included in the request as:

?var=device.variable

?var = device.variable The format of ”begin” and ”end” will be DDMMYYYY when you wish only

to indicate the date (in this case the hour will 00:00:00) or DDMMYYYYHHMMSS when both the date
and the hour are specified. Both "begin" as "end" must be expressed in UTC (Universal Coordinated
Time).

Finally, we may specify the period of data grouping using the “period” parameter. This value may be:

FILE

 data not grouped, returning the register as they have saved in the log.

AUTO

 Grouping will take place automatically depending on the specified dates ”begin” and

”end”

ALL

Data is grouped into a single value

> 0

Value in seconds in which the data is grouped.


If the “period” parameter does not appear on the request it shall be considered as value 0 and the data
will not be grouped.

<recordGroup>

<period>… </ period>

<record>

<dateTime> … </dateTime>

<field>… </ field>

<fieldComplex>… </ fieldComplex>

<fieldARM>… </ fieldARM>

<fieldFO> … </fieldFO>

<fieldEVQ>… </ fieldEVQ>

</record>

</recordGroup>

Where:

Advertising