tc_web_options_clean

Очистить веб свойства телеконференции.

Аналог команды в CoCon:

domain/<DOMAIN>/tc/properties/web/clean

Метод HTTP-запроса:

POST

Шаблон http запроса

http://host:port/commands/tc_web_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 tc web options.
            Usage: http://server:9999/commands/tc_web_options_clean.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>
    <!-- resultType-->
    <xs:complexType name="resultType">
        <xs:all>
            <xs:element name="domain_options" type="domainCleanOutType" minOccurs="1"/>
        </xs:all>
    </xs:complexType>
    <!-- in-->
    <xs:element name="in">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainCleanInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result" type="resultType"/>
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>
XML

Пример:

Запрос:

http://192.168.1.21:9999/commands/tc_web_options_clean

<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_web_options_clean.xsd">
    <request>
        <domain_options>
            <system />
            <domain name="biysk.local">
                <option name="notification_timeout"/>
                <option name="member_adittional_fields"/>
            </domain>
        </domain_options>
    </request>
</in>
XML

Ответ: 200

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_web_options_clean.xsd">
	<result>
		<domain_options>
			<system/>
			<domain name="biysk.local">
				<success option="member_adittional_fields"/>
				<success option="notification_timeout"/>
			</domain>
		</domain_options>
	</result>
</out>
XML

tc_web_options_info

Показать веб свойства телеконференции.

Аналог команды в CoCon:

domain/<DOMAIN>/tc/properties/web/info

Метод HTTP-запроса:

POST

Шаблон http запроса

http://host:port/commands/tc_web_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 tc web options.
            Usage: http://server:9999/commands/tc_web_options_info.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>
    <!-- tcWebOptionsType -->
    <xs:complexType name="tcWebOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="member_adittional_fields" type="stringType">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            usage: field1;field2;field3;
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="notification_timeout" 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="domain_options" type="domainInfoInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- in -->

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainInfoOutType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" />
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <!-- out -->
</xs:schema>
XML

Пример:

Запрос:

http://192.168.1.21:9999/commands/tc_web_options_info

<?xml version="1.0"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="tc_web_options_info.xsd">
    <request>
        <domain_options domain="biysk.local"/>
    </request>
</in>
XML

Ответ: 200

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_web_options_info.xsd">
	<result>
		<domain_options>
			<system>
				<options xs:type="tcWebOptionsType" notification_timeout="10" member_adittional_fields="departament_code;departament_name;position"/>
			</system>
		</domain_options>
	</result>
</out>
XML

tc_web_options_set

Изменить веб свойства телеконференции.

Аналог команды в CoCon:

domain/<DOMAIN>/tc/properties/web/set

Метод HTTP-запроса:

POST

Шаблон http запроса

http://host:port/commands/tc_web_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 tc web options.
            Usage: http://server:9999/commands/tc_web_options_set.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>
    <!-- tcWebOptionsType -->
    <xs:complexType name="tcWebOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="member_adittional_fields" type="stringType">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            usage: field1;field2;field3;
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="notification_timeout" 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="domain_options" type="domainSetInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- in -->

    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="domain_options" type="domainSetOutType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType" />
            </xs:choice>
        </xs:complexType>
    </xs:element>
    <!-- out -->
</xs:schema>

XML

Пример:

Запрос:

http://192.168.1.21:9999/commands/tc_web_options_set

<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_web_options_set.xsd">
    <request>
        <domain_options>
            <system>
                <options xs:type="tcWebOptionsType"/>
            </system>
            <domain name="biysk.local">
                <options notification_timeout="15" member_adittional_fields="departament_code;departament_name;position" xs:type="tcWebOptionsType"/>
            </domain>
        </domain_options>
    </request>
</in>
XML

Ответ: 200

<?xml version="1.0"?>
<out
	xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="tc_web_options_set.xsd">
	<result>
		<domain_options>
			<system/>
			<domain name="biysk.local">
				<success option="member_adittional_fields"/>
				<success option="notification_timeout"/>
			</domain>
		</domain_options>
	</result>
</out>
XML