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

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

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

Метод: GetActiveUsersByPeriodRequest

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

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

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

Параметры запроса

ПараметрТипОписание
token (обязательный)stringТокен доступа. Вы можете получить токен с помощью запроса
activityDate[startDate] (необязательный)string

Начало расчётного периода.

Если не передавать параметр activityDate, берется значение расчётного периода из подписки.

activityDate[endDate] (необязательный)string

Конец расчётного периода.

Если не передавать параметр activityDate, берется значение расчётного периода из подписки.

Возможные ошибки

ОшибкаОписание
Permission denied

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

Например, администратор подразделения не может получить список пользователей подразделения, которым не управляет

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.ru/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:GetActiveUsersByPeriodRequest>
         <soap:credentials>
            <soap:token>XxPm9-CtfLemV_EJfYb-gESxBsiq_OUu0W_Vpg2RhBg</soap:token>
         </soap:credentials>
         <!--Optional:-->
         <soap:activityDate>
            <!--Optional:-->
            <soap:startDate>2020-1-1</soap:startDate>
            <!--Optional:-->
            <soap:endDate>2026-1-1</soap:endDate>
         </soap:activityDate>
      </soap:GetActiveUsersByPeriodRequest>
   </soapenv:Body>
</soapenv:Envelope>

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

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
   <SOAP-ENV:Body>
      <ns1:GetActiveUsersByPeriodResult>
         <ns1:activeUsersByPeriod>
            <ns1:ids>
               <ns1:id>998415dc-2192-11ef-9b9c-0242ac130078</ns1:id>
            </ns1:ids>
            <ns1:activityStartDate>2020-01-01T00:00:00+00:00</ns1:activityStartDate>
            <ns1:activityEndDate>2026-01-01T00:00:00+00:00</ns1:activityEndDate>
         </ns1:activeUsersByPeriod>
      </ns1:GetActiveUsersByPeriodResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • Нет меток