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

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

ДОСТУПНО В BUSINESS ПОДПИСКЕ

Запрос: GET /user/profile/fields

Права пользователя для выполнения запроса 

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

Администратор подразделения, Автор и пользователь с ролью с индивидуальными настройками могут получать список полей профиля пользователей только подразделений, которыми управляют, и вложенных в них подразделений.

Заголовки и параметры запроса

Заголовок

Описание

Authorization (обязательный)Токен доступа. Вы можете получить токен с помощью запроса

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

Параметр

Описание

userFieldInfoМассив с данными о поле профиля пользователя
userFieldInfoIdID поля профиля
labelНазвание поля профиля
type

Тип поля.

Возможные значения:

  • login,
  • email,
  • first_name,
  • last_name,
  • job_title,
  • string,
  • country,
  • phone,
  • birthdate
isUnique

Является ли поле уникальным.

Возможные значения:

  • 0 — не является уникальным (false),
  • 1 — является уникальным (true)
isRequired

Является ли поле обязательным.

Возможные значения:

  • 0 — не является обязательным (false),
  • 1 — является обязательным (true)
orderPriorityПорядковый номер поля. Счет начинается с 0. 
То есть, для первого поля в списке параметр orderPriority=0 и т.д.
values [] (необязательное)

Массив с данными о полях списка. Например, для типа country будет список стран 

fieldЭлемент выпадающего списка. Каждый field содержит поля name и value

Коды ответов

Код

Текст

Описание

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

Пример запроса

GET /user/profile/fields https/1.1
Host: api-learn.ispringlearn.ru 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

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

https/1.1 200 OK
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<userFieldInfo>
		<userFieldInfoId>USER_DEFINED_FIELD3</userFieldInfoId>
		<name>string</name>
		<label>string</label>
		<type>string</type>
		<isUnique>true</isUnique>
		<isRequired>true</isRequired>
		<orderPriority>0</orderPriority>
		<values>
			<field>
				<name>string</name>
				<value>string</value>
			</field>
		</values>
	</userFieldInfo>
</response>