SOAP and REST Web Services Enhancements in 2024.08
The following enhancement was added to the SOAP and REST Web Services module in the 2024.08 release.
Returning Users from All Related Accounts
In the UserAcctHierarchyService web service (version 6), producers can use the new optional field usersFromLinkedAccount to provide one account ID to return all users belonging to that account and to any of its direct sub-accounts.
The field usersFromLinkedAccount is available for the getUsersQuery and getUsersCount operations.
The following example describes the behavior. Assume an organization has the following accounts:
| • | Account A1 is the parent of sub-accounts a1 and a1.1 |
| • | Account a1.1 is the parent of sub-account a1.2 |
A query for account ID or account name A1 with usersFromLinkedAccount = true would return users from all three accounts—A1, a1, and a1.1—that are directly linked to A1:
When searching for account ID or account name a1.1, users from accounts a1.1 and a1.2 will be listed in the response, but no users from A1:
When usersFromLinkedAccount is set to true, only one account ID and/or account name can be provided as search parameter. A search using more than one account ID returns the following error: “Multiple Account Ids cannot be provided in the request when usersFromLinkedAccount is set to true.”
For a list of files that have been changed for this functionality, see Change Log for 2024.08.