Включить страницу |
---|
L3:Лэйблы с указанием тарифа | L3:Лэйблы с указанием тарифа | Метод: listGroups
Параметры запроса
Параметр | Тип | Описание |
---|
credentials (обязательный) | credentials | Смотрите описание объекта Credentials. |
pageSize (необязательный) | string | Количество записей на 1 страницу. Если не указан, то 1000. |
pageToken (необязательный) | string | Токен для перехода на следующую страницу. |
Права пользователя для выполнения запроса
Владелец аккаунта, Администратор аккаунта, Администратор подразделения, Автор или роль с индивидуальными настройками.
Возвращаемые значения
После того как запрос был успешно обработан, система отправляет объект со следующими свойствами:
Параметр | Тип | Описание |
---|
group | array | Массив, содержащий значения ’groupId’, ’name’ — ID группы и ее название. |
nextPageToken | string | Токен для перехода на следующую страницу |
Пример запроса
Блок кода |
---|
|
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="https://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListGroupsRequest>
<soap:credentials>
<soap:accountUrl>https://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="https://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://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> |