Get the division tree structure that a user can access.
Specify the client code of a VETtrak user (staff member). The tree structure of divisions that the user can access will be returned. A VETtrak user can be granted access to one or more divisions, and being granted access to a division also grants access to all descendant divisions of that division.
Each level of the tree is represented by a TDivisionTree object. Each object in turn has a ChildDivisions property which is a List of TDivisionTree, specifying the children of that division. This allows you to recursively traverse the tree. The returned list of TDivisionTree objects represents each top-level division that the user can access.
A token is passed for authentication. If the authentication fails, or other errors occur, no divisions are returned. The result of the authentication is represented by a TAuthenticate object.
This function has security level "Restricted". Users that have explicitly been granted permission to the API can use it with any parameters, otherwise, the logged-in client can only access their own data.
[WebMethod(Description = "Gets the division tree structure that a user can access")] public TAuthDivisionTreeList GetAccessibleDivisionsTree(string token, string clientCode);
Parameters |
Description |
string token |
String containing a token. |
string clientCode |
String client code of a VETtrak user (staff member) to retrieve accessible clients for. |
TAuthDivisionTree : an Authenticated division tree list.
Copyright (c) VETtrak 2022. All rights reserved.
|