Hc_domain_group_list

Команда позволяет просмотреть список групп доступа, задекларированных в данной виртуальной АТС.

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

/domain/<DOMAIN>/access-group/ls-groups

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

POST

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

http://host:port/commands/domain_group_list

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

200 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла c ответом:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    
    <xs:complexType name="domainType">
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="groupType">
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="description" type="xs:string" use="required"/>
    </xs:complexType>
    
	<xs:element name="in">
    	<xs:complexType>
            <xs:all>
                <xs:element name="domain" type="domainType" minOccurs="1" maxOccurs="1"/>
            </xs:all>
		</xs:complexType>
	</xs:element>

	  <xs:element name="out">
	      <xs:complexType>
	          <xs:sequence>
                <xs:element name="group"  type="groupType" minOccurs="0" maxOccurs="unbounded"/> 
            </xs:sequence>
        </xs:complexType>
	  </xs:element>
</xs:schema>

Пример:

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

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_group_list.xsd">
    <group name="all" description="Default access group"/>
</out>

Hc_domain_group_add

Команда позволяет создать новую группу доступа в виртуальной АТС.

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

/domain/<DOMAIN>/access-group/add

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

POST

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

http://host:port/commands/domain_group_add

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

201 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла запроса/ответа:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    

    <xs:complexType name="groupType">
        <xs:attribute name="group_a" type="xs:string" use="required"/>
        <xs:attribute name="group_b" type="xs:string" use="required"/>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>
    
    <xs:element name="in">
        <xs:complexType>
              <xs:sequence>
                  <xs:element name="group" type="groupType" minOccurs="1" maxOccurs="unbounded"/>
              </xs:sequence>
      </xs:complexType>
    </xs:element> 
</xs:schema>

Пример:

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

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_group_add.xsd">
    <group domain="ct.office" name="group3" description="Group3"/>
    <group domain="ct.office" name="group4" description="Group4"/>
</in>

Hc_domain_group_remove

Команда позволяет удалить группу доступа из виртуальной АТС.

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

/domain/<DOMAIN>/access-group/remove

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

POST

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

http://host:port/commands/domain_group_remove

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

204 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла запроса/ответа:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    

    <xs:complexType name="groupType">
        <xs:attribute name="name" type="xs:string" use="required"/>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>
    
    <xs:element name="in">
        <xs:complexType>
              <xs:sequence>
                  <xs:element name="group" type="groupType" minOccurs="1" maxOccurs="unbounded"/>
              </xs:sequence>
      </xs:complexType>
    </xs:element> 
</xs:schema>

Пример:

Запрос: http://192.168.23.34:9999/commands/domain_group_remove

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_group_remove.xsd">
    <group domain="d.city" name="group3" />
</in>

Hc_domain_group_add_access

Команда позволяет добавить возможность доступа из группы доступа X в группу доступа Y.

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

/domain/<DOMAIN>/access-group/add-access

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

POST

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

http://host:port/commands/domain_group_add_access

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

201 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла запроса/ответа:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    

    <xs:complexType name="groupType">
        <xs:attribute name="group_a" type="xs:string" use="required"/>
        <xs:attribute name="group_b" type="xs:string" use="required"/>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>
    
    <xs:element name="in">
        <xs:complexType>
              <xs:sequence>
                  <xs:element name="group" type="groupType" minOccurs="1" maxOccurs="unbounded"/>
              </xs:sequence>
      </xs:complexType>
    </xs:element> 
</xs:schema>

Пример:

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

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_group_add_access.xsd">
    <group domain="biysk.local" group_a = "group1" group_b = "group2" />
</in>

Hc_domain_group_remove_access

Команда позволяет удалить возможность доступа из группы доступа X в группу доступа Y.

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

/domain/<DOMAIN>/access-group/remove-access

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

POST

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

http://host:port/commands/domain_group_remove_access

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

201 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла запроса/ответа:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    

    <xs:complexType name="groupType">
        <xs:attribute name="group_a" type="xs:string" use="required"/>
        <xs:attribute name="group_b" type="xs:string" use="required"/>
        <xs:attribute name="domain" type="xs:string" use="required"/>
    </xs:complexType>
    
    <xs:element name="in">
        <xs:complexType>
              <xs:sequence>
                  <xs:element name="group" type="groupType" minOccurs="1" maxOccurs="unbounded"/>
              </xs:sequence>
      </xs:complexType>
    </xs:element> 
</xs:schema>

Пример:

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

<?xml version='1.0' encoding="UTF-8"?>
<in
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance">
    <group group_a="group2" domain="biysk.local" group_b="group3"/>
</in>

Hc_domain_group_access_matrix

Команда позволяет просмотреть матрицу доступа группы.

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

/domain/<DOMAIN>/access-group/access-matrix

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

POST

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

http://host:port/commands/domain_group_access_matrix

Код HTTP-ответа:

При выполнении команды HTTP-терминал может ответить следующими сообщениями:

200 – в случае успеха;
404 – в случае ошибки.

XSD-схема XML-файла запроса/ответа:

<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">    
    <xs:complexType name="domainType">
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>
    
    <xs:complexType name="toType">
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>

    <xs:complexType name="groupType">
        <xs:sequence>
            <xs:element name="to" type="toType" minOccurs="0" maxOccurs="unbounded"/>
        </xs:sequence>
        <xs:attribute name="name" type="xs:string" use="required"/>
    </xs:complexType>
    
	<xs:element name="in">
    	<xs:complexType>
            <xs:all>
                <xs:element name="domain" type="domainType" minOccurs="1" maxOccurs="1"/>
            </xs:all>
		</xs:complexType>
	</xs:element>

	  <xs:element name="out">
	      <xs:complexType>
	          <xs:sequence>
                <xs:element name="group"  type="groupType" minOccurs="0" maxOccurs="unbounded"/> 
            </xs:sequence>
        </xs:complexType>
	  </xs:element>
</xs:schema>

Пример:

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

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

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="domain_group_access_matrix.xsd">
    <group name="all">
        <to name="all"/>
        <to name="group1"/>
        <to name="group2"/>
        <to name="group3"/>
        <to name="group4"/>
    </group>
    <group name="group1">
        <to name="all"/>
        <to name="group2"/>
    </group>
    <group name="group2">
        <to name="all"/>
        <to name="group2"/>
    </group>
    <group name="group3">
        <to name="all"/>
        <to name="group3"/>
        <to name="group4"/>
    </group>
    <group name="group4">
        <to name="all"/>
        <to name="group3"/>
        <to name="group4"/>
    </group>
</out>