Метод
listContent
Параметры
Параметр | Тип | Описание |
---|---|---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
contentItemId (обязательный) | string | ID материала. |
pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | string | Токен для перехода на следующую страницу. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор, Администратор подразделения, Автор.
Администратор подразделения и Автор могут получить данные только по пользователям подразделения, которым управляют, и его дочерних подразделений.
Возвращаемые значения
Возвращает массив данных со следующими свойствами:
Параметр | Тип | Описание |
---|---|---|
userId | string | ID выбранного пользователя. |
status | string | Текстовый статус по курсу для данного пользователя. |
progress | float | Прогресс выполнения курса пользователем. |
Возможные ошибки
Ошибка | Описание |
---|---|
Unknown content item | Не найден курс с указанным ID. |
Permission denied | У пользователя недостаточно прав для выполнения запроса. |
Пример запроса
Блок кода | ||
---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap"> <soapenv:Header/> <soapenv:Body> <soap:ListContentRequest> <soap:credentials> <soap:accountUrl>http://myaccount.ispringlearn.ru</soap:accountUrl> <soap:email>http://myaccount.ispringlearn.ru</soap:email> <soap:password>password</soap:password> </soap:credentials> <soap:pageToken>string</soap:pageToken> <soap:pageSize>1000</soap:pageSize> </soap:ListContentRequest> </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:ListContentResult> <ns1:contentItems> <ns1:contentItem> <ns1:contentItemId>string</ns1:contentItemId> <ns1:title>string</ns1:title> <ns1:description/> <ns1:userId>string</ns1:userId> <ns1:addedDate>2019-11-13T06:30:49+00:00</ns1:addedDate> <ns1:viewUrl>string</ns1:viewUrl> <ns1:type>string</ns1:type> </ns1:contentItem> <ns1:contentItem> ... </ns1:contentItem> </ns1:contentItems> <ns1:nextPageToken>string</ns1:nextPageToken> </ns1:ListContentResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
...