GetUserGroups Function
The GetUserGroups function returns a list of groups for which a specified user is a member. Only groups with permission to access the API are included.
Syntax
The following is the syntax for an HTTP request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/GetUserGroups HTTP/1.1
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=string&Password=string
Parameters
The
GetUserGroups function uses only the login parameters for
Windchill Risk and Reliability user accounts. For more information, see
Login Parameters for User Accounts.
The following is an example of an HTTP POST request:
POST /WindchillRiskandReliability12.0/DataEngine.asmx/GetUserGroups HTTP/1.1
Host: vm-test
Content-Type: application/x-www-form-urlencoded
Content-Length: length
UserName=Bill&Password=passwd
Returns
If the user is authenticated, a list of groups in which this user is a member is returned.
<?xml version="1.0" encoding="utf-8"?>
<DataEngineGroupListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://www.ptc.com/WindchillRiskandReliability/12.0/">
<Success>true</Success>
<Groups>
<string>Administrators</string>
</Groups>
</DataEngineGroupListResponse>
If the call fails, the AdditionalData tag provides the reason for the failure.