ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.GetDivisionTree Method

Get the division tree structure starting from a specified division. 

Specify an integer ID of the division to start the tree from. Specify null or 0 to start at the Root Division and retrieve the entire division tree. 

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 root TDivisionTree that is returned will contain the starting division that you specified. 

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 "Protected", and can only be accessed by users that have explicitly been granted permission to the API.

C#
[WebMethod(Description = "Gets the division tree structure starting from the specified division ID")]
public TAuthDivisionTree GetDivisionTree(string token, int? divisionId);
Parameters 
Description 
string token 
String containing a token. 
int? divisionId 
Integer ID of division to start the tree at. Specify null or 0 to start at the Root Division and retrieve the entire division tree. 

TAuthDivisionTree : an Authenticated division tree.

Copyright (c) VETtrak 2022. All rights reserved.