Getting Group Info

Method: getGroup

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles.

Parameters

Parameter	Type	Description
credentials (required)	credentials	Read the description of the Credentials object
groupId (required)	string	The ID of a group you want to get info on.

Return Values

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

Parameter	Type	Description
group	array	An array containing the groupId and name values (the ID of the group and its name).

Sample Request

<?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>
    <GetGroupRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
     <groupId>cfe9248a-deb4-11e9-979c-0a580af40764</groupId>
    </GetGroupRequest>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns="http://ispringlearn.com/go/services/api/soap">
  <SOAP-ENV:Body>
    <GetGroupResult>
      <group>
        <groupId>e7fa2c2a-5c39-11e9-a000-0e1426fbe81a</groupId>
        <name>Sales Department</name>
      </group>
    </GetGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page tree