Page tree
Skip to end of metadata
Go to start of metadata

You can get information about a group with the getGroupInformation method.

Permission to run the request: Account Owner, Administrator, Organization Administrator, Publisher.


Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringID of the group you want to get information of.

Return Value

After the request has been completed, the system returns an object with the following properties:

ParameterTypeDescription
groupIdstringID of the group.
namestringName of the group.
descriptionstringDescription of the group.
usersstring[]An array with IDs of the users who belong to the group.
organizationIdintID of the organization.

Possible Errors

ErrorDescription
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).

Sample Call

<?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>

Sample Response

<?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>
  •