Hc_domain_cc_options_clean

Команда подчистки настроек ограничений Call-центра домена.

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

/domain/<DOMAIN>/cc/properties/clean

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

POST

Шаблон HTTP-запроса:

http://host:port/commands/domain_cc_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>
CODE

Пример:

Запрос:
http://192.168.1.21:9999/commands/domain_cc_options_clean

<?xml version="1.0" encoding="UTF-8"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_cc_options_clean.xsd">
    <request>
        <domain_options>
            <system>
                <option name="ldap_server_id" />
            </system>
            <domain name="biysk.local">
                <option name="ldap_server_id" />
            </domain>
        </domain_options>
    </request>
</in>

CODE

Ответ: 200

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

Hc_domain_cc_options_info

Команда просмотра настроек ограничений Call-центра домена.

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

/domain/<DOMAIN>/cc/properties/info

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

POST

Шаблон HTTP-запроса:

http://host:port/commands/domain_cc_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 domain properties.
            Usage: http://server:9999/commands/domain_cc_options_info.
            Implementation: hc_domain_cc_options_info.erl.
            Git: git@git.eltex.loc:httpTerminal.git.
            Copyright (c) 2014, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>
    <!-- capabilitiesType -->
    <xs:simpleType name="capabilitiesType">
        <xs:restriction base="unionType">
            <xs:enumeration value="all"/>
            <xs:enumeration value="[operator_queue_calls, true]"/>
            <xs:enumeration value="[operator_queue_calls, false]"/>
            <xs:enumeration value="[operator_intervention, true]"/>
            <xs:enumeration value="[operator_intervention, false]"/>
        </xs:restriction>
    </xs:simpleType>
    <!-- domainPropertiesOptionsType -->
    <xs:complexType name="domainCcPropertiesOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="capabilities" type="capabilitiesType" use="optional"/>
                <xs:attribute name="cc_pubsub_user" type="stringType" use="optional"/>
                <xs:attribute name="cc_pubsub_password" type="stringType" use="optional"/>
                <xs:attribute name="generate_workitem_id_by_queue" type="booleanType" use="optional"/>
                <xs:attribute name="ldap_authentication_enabled" type="booleanType" use="optional"/>
                <xs:attribute name="ldap_server_id" type="stringType" use="optional"/>
                <xs:attribute name="relative_rating_0_1" type="stringType" use="optional"/>
                <xs:attribute name="relative_rating_0_9" type="stringType" use="optional"/>
                <xs:attribute name="relative_rating_1_5" type="stringType" use="optional"/>
                <xs:attribute name="workitem_isup_key" type="binaryType" use="optional"/>
                <xs:annotation>
                    <xs:documentation xml:lang="en">
                            The list of domain's call center public names splitted by comma.
                        </xs:documentation>
                </xs:annotation>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <!-- resultType-->
    <xs:complexType name="resultType">
        <xs:all>
            <xs:element name="domain_options" type="domainInfoOutType" 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="domainInfoInType" minOccurs="1"/>
                        </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/domain_cc_options_info

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

CODE

Ответ: 200

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_cc_options_info.xsd">
    <result>
        <domain_options>
            <system>
                <options xs:type="domainCcPropertiesOptionsType"/>
            </system>
            <domain name="biysk.local">
                <options xs:type="domainCcPropertiesOptionsType" workitem_isup_key="" relative_rating_1_5="negative: 1 - 2 neutral: 3 - 4 positive: 5" relative_rating_0_9="negative: 0 - 4 neutral: 5 - 6 positive: 7 - 9" relative_rating_0_1="negative: 0 positive: 1" ldap_server_id="undefined" ldap_authentication_enabled="false" generate_workitem_id_by_queue="false" cc_pubsub_user="pubsub" cc_pubsub_password="pubsub" capabilities="all"/>
            </domain>
        </domain_options>
    </result>
</out>
CODE

Hc_domain_cc_options_set

Команда изменения настроек ограничений Call-центра домена.

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

/domain/<DOMAIN>/cc/properties/set

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

POST

Шаблон HTTP-запроса:

http://host:port/commands/domain_cc_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 domain limits.
            Usage: http://server:9999/commands/domain_cc_options_set.
            Implementation: hc_domain_cc_options_set.erl.
            Git: git@git.eltex.loc:httpTerminal.git.
            Copyright (c) 2016, Eltex. All rights reserved.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>
    <!-- domainPropertiesOptionsType -->
    <xs:complexType name="domainCcPropertiesOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="generate_workitem_id_by_queue" type="booleanType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="ldap_authentication_enabled" type="booleanType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="cc_pubsub_user" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="cc_pubsub_password" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="capabilities" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="ldap_server_id" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="workitem_isup_key" type="binaryType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="relative_rating_0_1" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="relative_rating_0_9" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
                <xs:attribute name="relative_rating_1_5" type="stringType" use="optional">
                    <xs:annotation>
                        <xs:documentation xml:lang="en">
                            .
                        </xs:documentation>
                    </xs:annotation>
                </xs:attribute>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>
    <!-- resultType-->
    <xs:complexType name="resultType">
        <xs:all>
            <xs:element name="domain_options" type="domainSetOutType" 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="domainSetInType"/>
                        </xs:all>
                        <xs:attribute name="force" type="xs:boolean"/>
                    </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>
CODE

Пример:

Запрос:
http://192.168.1.21:9999/commands/domain_cc_options_set

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_cc_options_set.xsd">
    <request>
        <domain_options>
            <system>
                <options xs:type="domainCcPropertiesOptionsType" />
            </system>
            <domain name="biysk.local">
                <options xs:type="domainCcPropertiesOptionsType" ldap_authentication_enabled="false" generate_workitem_id_by_queue="false" cc_pubsub_user="pubsub" cc_pubsub_password="pubsub" capabilities="all" ldap_server_id="undefined" workitem_isup_key="" relative_rating_0_1="0 1" relative_rating_0_9="4 7" relative_rating_1_5="2 5"/>
            </domain>
        </domain_options>
    </request>
</in>

CODE

Ответ: 200

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_cc_options_set.xsd">
    <result>
        <domain_options>
            <system/>
            <domain name="biysk.local">
                <success option="capabilities"/>
                <success option="cc_pubsub_password"/>
                <success option="cc_pubsub_user"/>
                <success option="generate_workitem_id_by_queue"/>
                <success option="ldap_authentication_enabled"/>
                <success option="ldap_server_id"/>
                <success option="relative_rating_0_1"/>
                <success option="relative_rating_0_9"/>
                <success option="relative_rating_1_5"/>
                <success option="workitem_isup_key"/>
            </domain>
        </domain_options>
    </result>
</out>
CODE