Hc_cc_csta_server_options_clean
Команда сброса настроек подключения по протоколу CSTA.
Аналог команды в CoCon:
api/csta/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cc_csta_server_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:include schemaLocation="error.xsd"/> <xs:include schemaLocation="ecm_common.xsd"/> <!-- in --> <xs:element name="in"> <xs:complexType> <xs:all> <xs:element name="request"> <xs:complexType> <xs:all> <xs:element name="system_options" type="systemCleanInType"/> </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:all> <xs:element name="system_options" type="systemCleanOutType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="error" type="errorType" /> </xs:choice> </xs:complexType> </xs:element> </xs:schema>
Пример:
Запрос:
http://192.168.1.21:9999/commands/cc_csta_server_options_clean
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_clean.xsd"> <request> <system_options> <system> <option name="use_tcp"/> <option name="use_ssl"/> <option name="tcp_port"/> <option name="tcp_ip"/> <option name="ssl_port"/> <option name="ssl_ip"/> <option name="enabled"/> <option name="auth"/> </system> </system_options> </request> </in>
Код ответа:
200
Ответ:
<?xml version="1.0"?> <out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="cc_csta_server_options_clean.xsd"> <result> <system_options> <system> <success option="auth"/> <success option="enabled"/> <success option="ssl_ip"/> <success option="ssl_port"/> <success option="tcp_ip"/> <success option="tcp_port"/> <success option="use_ssl"/> <success option="use_tcp"/> </system> </system_options> </result> </out>
Hc_cc_csta_server_options_info
Команда просмотра настроек подключения по протоколу CSTA.
Аналог команды в CoCon:
api/csta/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cc_csta_server_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:include schemaLocation="error.xsd"/> <xs:include schemaLocation="ecm_common.xsd"/> <!-- cstaServerOptions --> <xs:complexType name="cstaServerOptions"> <xs:complexContent> <xs:extension base="baseOptionsType"> <xs:attribute name="enabled" type="booleanType"/> <xs:attribute name="use_tcp" type="booleanType"/> <xs:attribute name="use_ssl" type="booleanType"/> <xs:attribute name="tcp_ip" type="ipAddressType"/> <xs:attribute name="ssl_ip" type="ipAddressType"/> <xs:attribute name="tcp_port" type="inetPortType"/> <xs:attribute name="ssl_port" type="inetPortType"/> <xs:attribute name="auth" type="stringType"> <xs:annotation> <xs:documentation xml:lang="en"> usage: Login:Password;Login2:Password2 In case of strong security restrictions password may be shown as ******** </xs:documentation> </xs:annotation> </xs:attribute> </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="system_options" type="systemInfoInType"/> </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:all> <xs:element name="system_options" type="systemInfoOutType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="error" type="errorType"/> </xs:choice> </xs:complexType> </xs:element> </xs:schema>
Пример:
Запрос:
http://192.168.1.21:9999/commands/cc_csta_server_options_info
<?xml version="1.0"?> <in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="cc_csta_server_options_info.xsd"> <request> <system_options/> </request> </in>
Код ответа:
200
Ответ:
<?xml version="1.0"?> <out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="cc_csta_server_options_info.xsd"> <result> <system_options> <system> <options xs:type="cstaServerOptions" auth="ct.office:********" enabled="true" ssl_ip="0.0.0.0" ssl_port="4722" tcp_ip="0.0.0.0" tcp_port="4721" use_ssl="true" use_tcp="true"/> </system> </system_options> </result> </out>
Hc_cc_csta_server_options_set
Команда изменения настроек подключения по протоколу CSTA
Аналог команды в CoCon:
api/csta/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/cc_csta_server_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:include schemaLocation="error.xsd"/> <xs:include schemaLocation="ecm_common.xsd"/> <!-- cstaServerOptions --> <xs:complexType name="cstaServerOptions"> <xs:complexContent> <xs:extension base="baseOptionsType"> <xs:attribute name="enabled" type="booleanType"/> <xs:attribute name="use_tcp" type="booleanType"/> <xs:attribute name="use_ssl" type="booleanType"/> <xs:attribute name="tcp_ip" type="ipAddressType"/> <xs:attribute name="ssl_ip" type="ipAddressType"/> <xs:attribute name="tcp_port" type="inetPortType"/> <xs:attribute name="ssl_port" type="inetPortType"/> <xs:attribute name="auth" type="stringType"> <xs:annotation> <xs:documentation xml:lang="en"> usage: Login:Password;Login2:Password2 </xs:documentation> </xs:annotation> </xs:attribute> </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="system_options" type="systemSetInType"/> </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:all> <xs:element name="system_options" type="systemSetOutType"/> </xs:all> </xs:complexType> </xs:element> <xs:element name="error" type="errorType" /> </xs:choice> </xs:complexType> </xs:element> </xs:schema>
Пример:
Запрос:
http://192.168.1.21:9999/commands/cc_csta_server_options_set
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="cc_csta_server_options_set.xsd"> <request> <system_options> <system> <options auth="test.ats:123456;domain.second:1234567" enabled="false" ssl_ip="0.0.0.0" ssl_port="4722" tcp_ip="0.0.0.0" tcp_port="4721" use_ssl="true" use_tcp="true" xs:type="cstaServerOptions"/> </system> </system_options> </request> </in>
Код ответа:
200
Ответ:
<?xml version="1.0"?> <out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="cc_csta_server_options_set.xsd"> <result> <system_options> <system> <success option="use_tcp"/> <success option="use_ssl"/> <success option="tcp_port"/> <success option="tcp_ip"/> <success option="ssl_port"/> <success option="ssl_ip"/> <success option="enabled"/> <success option="auth"/> </system> </system_options> </result> </out>
Добавить комментарий