Hc_tc_system_options - Управление настройками Телеконференции на уровне системы
Hc_tc_system_options_clean
Команда сброса системных настроек телеконференции.
Аналог команды в CoCon:
system/tc/properties/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_system_options_clean
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Clean system tc options.
Usage: http://server:9999/commands/tc_system_options_clean.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- tcSystemOptionsType -->
<xs:complexType name="tcSystemOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="rest_host" type="stringType"/>
<xs:attribute name="rest_port" type="inetPortType"/>
<xs:attribute name="session_lifetime" type="integerType"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsCleanInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsCleanOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_system_options_clean
<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_system_options_clean.xsd">
<request>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<option name="session_lifetime"/>
<option name="rest_port"/>
<option name="rest_host"/>
</node>
</ns_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_system_options_clean.xsd">
<result>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<success option="rest_host"/>
<success option="rest_port"/>
<success option="session_lifetime"/>
</node>
</ns_options>
</result>
</out>
CODE
Hc_tc_system_options_info
Команда просмотра системных настроек телеконференции.
Аналог команды в CoCon:
system/tc/properties/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_system_options_info
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Show system tc options.
Usage: http://server:9999/commands/tc_system_options_info.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- tcSystemOptionsType -->
<xs:complexType name="tcSystemOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="rest_host" type="stringType"/>
<xs:attribute name="rest_port" type="inetPortType"/>
<xs:attribute name="session_lifetime" type="integerType"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsInfoInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsInfoOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
XML
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_system_options_info
<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="sorm_system_options_info.xsd">
<request>
<system_options/>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_system_options_info.xsd">
<result>
<ns_options>
<system>
<options xs:type="tcSystemOptionsType"/>
</system>
<node name="core1@Artem-Work-PC">
<options xs:type="tcSystemOptionsType" session_lifetime="1800" rest_port="9999" rest_host="ecss1"/>
</node>
</ns_options>
</result>
CODE
Hc_tc_system_options_set
Команда изменения системных настроек телеконференции.
Аналог команды в CoCon:
system/tc/properties/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/tc_system_options_set
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Set system tc options.
Usage: http://server:9999/commands/tc_system_options_set.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- tcSystemOptionsType -->
<xs:complexType name="tcSystemOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="rest_host" type="stringType"/>
<xs:attribute name="rest_port" type="inetPortType"/>
<xs:attribute name="session_lifetime" type="integerType"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- in -->
<xs:element name="in">
<xs:complexType>
<xs:all>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="ns_options" type="nsSetInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result">
<xs:complexType>
<xs:sequence>
<xs:element name="ns_options" type="nsSetOutType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/tc_system_options_set
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_system_options_set.xsd">
<request>
<ns_options>
<system>
<options xs:type="tcSystemOptionsType" />
</system>
<node name="core1@Artem-Work-PC">
<options xs:type="tcSystemOptionsType" session_lifetime="1800" rest_port="9999" rest_host="ecss1"/>
</node>
</ns_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_system_options_set.xsd">
<result>
<ns_options>
<system/>
<node name="core1@Artem-Work-PC">
<success option="rest_host"/>
<success option="rest_port"/>
<success option="session_lifetime"/>
</node>
</ns_options>
</result>
</out>
CODE