iseg CC23, Техническая документация инструкция

Страница: 29 / 44

11.5.1. HTTP interface
This interface gives quick access to iCSservice by simple HTTP queries.
iCSservice HTTP functions
URL, Parameters with leading $, params not mandatory [$param] Response Description
http://<IP-of-iCSmini>/api/lgetItemsInfo XML XML with item object
information
http://<IP-of-iCSmini>/api/login/$username/$password API Key Returns API Key to be identified
for session
http://<IP-of-iCSmini>/api/logout/$session-ID TRUE / FALSE
http://<IP-of-iCSmini>/api/getItem/$apikey/$line/$address/$channel/$item JSON Object Returns state of a specific item
of a hardware path
$line, $address, $channel and
$item can be set by wildcard '*'
http://<IP-of-iCSmini>/api/setItem/$apikey/$line/$address/$channel/$item/
$value/[$unit] TRUE / FALSE Sets state of a specific item of a
hardware path
$line, $address, $channel can
be set by wildcard '*'
http://<IP-of-iCSmini>/api/getUpdate/$apikey/ JSON Object returns all changes collected by
iCSservice since last getUpdate
call for this client session
Use “*” as wildcard, e.g. to set or get items on multiple channels at once.
Use “null” as empty set identifier, e.g. to obtain module specific objects without channel declaration.
EXAMPLES
http://192.168.1.1/api/getItem/123456-321/0/ 1/0/Status.voltageMeasure Returns voltage value, unit and timestamp of
channel 0 of module with address 1 of line 0
http://192.168.1.1/api/ s etItem/123456-321/0/ 1/*/Control.voltageSet/1/kV Set set voltages of all channels of module 1 in
line 0 to 1,000 Volt
http://192.168.1.1/api/ s etItem/123456-321/0/ null/null/Control.power/1 Switch controller of line 0 (master) on
Crate Controller CC24/CC23 | Last change on: 14.04.2020 |
www.iseg-hv.com
29/44