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

Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 6 Следующий »

Метод: listGroups

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

ПараметрТипОписание
credentials (обязательный)credentialsСмотрите описание объекта Credentials.
pageSize (необязательный)stringКоличество записей на 1 страницу. Если не указан, то 1000.
pageToken (необязательный)stringТокен для перехода на следующую страницу. 

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

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

Возвращаемые значения

После того как запрос был успешно обработан, система отправляет объект со следующими свойствами:

ПараметрТипОписание
grouparrayМассив, содержащий значения ’groupId’, ’name’ — ID группы и ее название.
nextPageTokenstringТокен для перехода на следующую страницу

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
   <soapenv:Header/>
   <soapenv:Body>
      <soap:ListGroupsRequest>
         <soap:credentials>
            <soap:accountUrl>http://myaccount.ispringlearn.ru</soap:accountUrl>
            <soap:email>email@email.com</soap:email>
            <soap:password>password</soap:password>
         </soap:credentials>
         <soap:pageToken>string</soap:pageToken>
         <soap:pageSize>1000</soap:pageSize>
      </soap:ListGroupsRequest>
   </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:ListGroupsResult>
         <ns1:groups>
            <ns1:group>
               <ns1:groupId>string</ns1:groupId>
               <ns1:name>string</ns1:name>
               <ns1:isSmart>0</ns1:isSmart>
            </ns1:group>
            <ns1:group>
               ...
            </ns1:group>
         </ns1:groups>
         <ns1:nextPageToken>string</ns1:nextPageToken>
      </ns1:ListGroupsResult>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • Нет меток