AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: getSmartGroupRules
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object |
groupId (required) | string | The ID of a smart group whose rule you want to get. |
Return Value
After the request has been successfully processed, the system returns an object with the following properties:
Parameter | Type | Description |
---|
rule | array | An array containing the following values: ’attributeType’, ’attributeId’, ’operator’, 'value'. |
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>
<GetSmartGroupRulesRequest>
<credentials>
<accountUrl>https://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<groupId>2bbc2ed0-8841-11e9-93c1-0242c0a85016</groupId>
</GetSmartGroupRulesRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
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>
<GetSmartGroupRulesResult>
<rule>
<groupId>e7fa2c2a-5c39-11e9-a000-0e1426fbe81a</groupId>
<attributeType>1</attributeType>
<operator>2</operator>
<value>d48bd4fa-5b70-11e9-b12b-22e9fbac4a59</value>
</rule>
</GetSmartGroupRulesResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML