Документация по iSpring Learn

Дерево страниц

Сравнение версий

Старая версия 8

changes.mady.by.user Irina Chumanova

Сохранено

по сравнению с

Новая версия 9

changes.mady.by.user Irina Chumanova

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Заголовок

Описание

X-Auth-Account-Url (обязательный)Базовый URL аккаунта, например, http://myaccount.ispringlearn.ru
X-Auth-Email (обязательный)Логин Владельца аккаунта, Администратора аккаунта, Администратора подразделения или пользователя с ролью с индивидуальными настройками, которые позволяют редактировать смарт-группы.
X-Auth-Password (обязательный)

Пароль Владельца аккаунта, Администратора аккаунта, Администратора подразделения или пользователя с ролью с индивидуальными настройками, которые позволяют редактировать смарт-группы.

ПараметрОписание
group_id (обязательный)ID смарт-группы, которую вы хотите отредактировать.
name (обязательный)Название смарт-группы.
attributeType (обязательный)

Может принимать значения:

  • 1- подразделение

  • 2 - группа

  • 3 - поля профиля

attributeId (необязательный)

Идентификатор поля профиля. Заполняется только для полей профиля.

operator (обязательный)

Для подразделений:

  • 1 - одно подразделение без его дочерних подразделений
  • 2 - подразделение и все его дочерние подразделения

Для групп и полей профиля:

  • всегда 1
value (обязательный)

Для подразделений:

  • ID подразделения

Для групп:

  • ID группы

Для поля профиля:

  • значение поля профиля (например, для поля Фамилия значение — Соколов)

Внимание: для поля Страна нужно использовать ID страны, а не название. ID страны можно узнать при помощи метода Получение списка полей профиля пользователя.

Примеры правил

Правило для подразделения

Блок кода
languagexml
<rule>				
  <attributeType>1</attributeType>
  <attributeId></attributeId>
  <operator>2</operator>
  <value>d48bd4fa-5b70-11e9-b12b-22e9fbac4a59</value>			
</rule>

Правило для группы

Блок кода
languagexml
<rule>				
  <attributeType>2</attributeType>
  <attributeId></attributeId>
  <operator>1</operator>
  <value>eb53de1e-dea4-11e9-8de4-0a580af40738</value>			
</rule>

Правило для поля профиля

Блок кода
languagexml
<rule>				
  <attributeType>3</attributeType>
  <attributeId>LAST_NAME</attributeId>
  <operator>1</operator>
  <value>Соколов</value>			
</rule>

Коды ответов

Код

Текст

Описание

200Successful operationПараметр успешно изменен.
400Bad RequestОшибка в запросе.
401UnauthorizedОшибка авторизации.
403Permission deniedУ пользователя недостаточно прав для выполнения запроса.

...

Блок кода
languagexml
POST /group/smart/b1496214-acab-11e9-8db0-120a62f268a9/ HTTP/1.1
Host: api-learn.ispringlearn.ru
X-Auth-Account-Url: http://myaccount.ispringlearn.ru
X-Auth-Email: email@email.com
X-Auth-Password: password
Content-Type:application/xml
  
<?xml version="1.0" encoding="UTF-8"?>
<request>
	<name>Стажеры<    <name>New Group</name>
	    <rules>
		<and>
			<or>
				<rule>
					<attributeType>1</attributeType>
					<attributeId>3fa85f64-5717-4562-b3fc-2c963f66afa6</attributeId>
					<operator>1</operator>
					<value>string</value>
				</rule>
			</or>
		</and>
	        <and>
            <or>
                <rule>
                    <attributeType>1</attributeType>
                    <attributeId></attributeId>
                    <operator>1</operator>
                    <value>6f774f46-de00-11e9-bb11-0a580af40984</value>
                </rule>
            </or>
            <or>
                 <rule>
                    <attributeType>2</attributeType>
                    <attributeId></attributeId>
                    <operator>1</operator>
                    <value>eb53de1e-dea4-11e9-8de4-0a580af40738</value>
                </rule>
            </or>
            <or>
                <rule>
                     <attributeType>3</attributeType>
                     <attributeId>14072df2-d54f-11e9-a7ce-0a580af40973</attributeId>
                     <operator>1</operator>
                     <value>Менеджер</value>
                </rule>
            </or>
        </and>
    </rules>
</request>

Пример ответа

Блок кода
languagexml
HTTP/1.1 200 Successful operation
Connection: close

...