You can get information about a group with the getGroupInformation method.
Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher.
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object. |
groupId (required) | string | ID of the group you want to get information of. |
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|
groupId | string | ID of the group. |
name | string | Name of the group. |
description | string | Description of the group. |
users | string[] | An array with IDs of the users who belong to the group. |
organizationId | int | ID of the organization. |
Error | Description |
---|
Unknown group | The group was not found or the user doesnt't have enough permissions to get info on the group (for example, organization administrators and publishers can't get info on the group if it is not within their organization). |
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetGroupInformationRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<groupId>string</groupId>
</GetGroupInformationRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<GetGroupInformationResult>
<group>
<groupId>1</groupId>
<name>Name</name>
<description>Description</description>
<organizationId>1</organizationId>
<users>
<id>1</id>
<id>2</id>
</users>
</group>
</GetGroupInformationResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML