Включить страницу | ||||
---|---|---|---|---|
|
Метод:
...
GetActiveUsersByPeriodRequest
Права для выполнения запроса
...
Администратор подразделения и пользователь с ролью с индивидуальными настройками могут получат списки активных пользователей только тех подразделений, которыми управляют, и вложенных в них подразделений.
Параметры запроса
Параметр | Тип | Описание |
---|---|---|
token (обязательный) | string | Токен доступа. Вы можете получить токен с помощью запроса |
activityDate[startDate] (необязательный) | string | Начало расчётного периода. Если не передавать параметр activityDate, берется значение расчётного периода из подписки. |
activityDate[endDate] (необязательный) | string | Конец расчётного периода. Если не передавать параметр activityDate, берется значение расчётного периода из подписки. |
Возможные ошибки
Ошибка | Описание |
---|---|
Permission denied | У пользователя недостаточно прав для выполнения запроса Например, администратор подразделения не может получить список пользователей подразделения, которым не управляет |
Пример запроса
Блок кода | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <soapenv:Envelope xmlns:soapenv="httpshttp://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="httpshttp://ispringlearn.comru/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:ListUsersRequest>GetActiveUsersByPeriodRequest> <soap:credentials> <soap:token>p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE< <soap:token>XxPm9-CtfLemV_EJfYb-gESxBsiq_OUu0W_Vpg2RhBg</soap:token> <</soap:credentials> <soap:groupIds> <!--Optional:--> <soap:id>string</soap:id>activityDate> </soap:groupIds> <soap:departmentIds> <!--Optional:--> <soap:id>string<startDate>2020-1-1</soap:id>startDate> </soap:departmentIds> <!--Optional:--> <soap:pageToken>string<endDate>2026-1-1</soap:pageToken>endDate> <soap:pageSize>1000<</soap:pageSize>activityDate> </soap:ListUsersRequest>GetActiveUsersByPeriodRequest> </soapenv:Body> </soapenv:Envelope> |
Пример ответа
Блок кода | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="httpshttp://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="httpshttp://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <ns1:ListUsersResult>GetActiveUsersByPeriodResult> <ns1:userProfiles>activeUsersByPeriod> <ns1:userProfile>ids> <ns1:userId>string<id>998415dc-2192-11ef-9b9c-0242ac130078</ns1:userId> ...id> </ns1:userProfile>ids> <ns1:userProfile> <ns1:userId>string</ns1:userId> ... </ns1:userProfile>:activityStartDate>2020-01-01T00:00:00+00:00</ns1:activityStartDate> <ns1:userProfile> <ns1:userId>string</ns1:userId> ... </ns1:userProfile>activityEndDate>2026-01-01T00:00:00+00:00</ns1:activityEndDate> </ns1:userProfiles> <ns1:nextPageToken>string</ns1:nextPageToken>activeUsersByPeriod> </ns1:ListUsersResult>GetActiveUsersByPeriodResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...