Method: getGroups
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. |
Return Value
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
group | array | An array containing the following values: 'groupId', 'name'. |
Sample Request
<?xml version="1.0" encoding="utf-8"?> <SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <GetGroupsRequest> <credentials> <accountUrl>https://myaccount.ispringlearn.com</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> </GetGroupsRequest> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/" xmlns="https://ispringlearn.com/go/services/api/soap"> <SOAP-ENV:Body> <GetGroupsResult> <group> <groupId>e7fa2c2a-5c39-11e9-a000-0e1426fbe81a</groupId> <name>Sales Department</name> </group> <group> ... </group> </GetGroupsResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope>