Bulk User and User Group Extract API
  • 1 Minute to read
  • Dark
    Light
  • PDF

Bulk User and User Group Extract API

  • Dark
    Light
  • PDF

Article summary

Syntax

List<Planful.EPM.WebServices.UserInformation.UserAndUserGrroups> Get_AllUserGroups(Boolean hasMore, int startIndiex, string LogingName, string Password, string TenantCode)

Usage

This API is available for bulk user and user group extraction.

Samples

List<Planful.EPM.WebServices.UserInformation.UserAndUserGrroups> Get_AllUserGroups(True, 0, "test@planful.com", QAEnviornment", "HACPM867")
<soapenv:Header/>
<soapenv:Body>
<ns:Get_AllUserGroups>
			ns:hasMore>True</ns:hasMore>
			ns:startIndex>0</ns:StartIndex
	</ns:Get_AllUserGroups>
</soapenv:Body>
Get_AllUserGroupsResult>
<UserAndUserGroups>
<UserLogin>benbradley@planful.com</UserLogin>
<UserGroups/>
</UserAndUserGroups>
Get_AllUserGroupsResult>
<UserAndUserGroups>
<UserLogin>benbradley@planful.com</UserLogin>
<UserGroups>
<string>G1</string>
<string>G2</string>
<UserGroups/>
</UserAndUserGroups>

Output

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soap:Body>
 	<Get_BulkUserGroupsResponse
xmlns="http://www.Planful.com/API/SOAP/StateFree/Common/2009/03/19">
<Get_BulkUserGroupsResult>
		 <BulkUserGroups>
		 	<UserLogin>benbradley@Planful.com</UserLogin>
		 	<UserGroups/>
		 </BulkUserGroups>
		 <BulkUserGroups>
		 	<UserLogin>smith@Planful.com</UserLogin>
		 	<UserGroups/>
		 </BulkUserGroups>
		 <BulkUserGroups>
		 	<UserLogin>benparker@Planful.com</UserLogin>
		 	<UserGroups/>
		 </BulkUserGroups>
		 <BulkUserGroups>
		 	<UserLogin>ben@Planful.com</UserLogin>
		 	<string>G1</string>
		 	<string>G2</string>
		 	<UserGroups/>
		 </BulkUserGroups>
</Get_BulkUserGroupsResult>
<hasMore>false</hasMore>
    <Get_BulkUserGroupsResponset>
 </soap:Body>
</soap:Envelope> 

Was this article helpful?