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

Get the employer tree structure starting from a specified employer. 

Specify the identifier of the employer to start the tree from. This field is mandatory. 

Each level of the tree is represented by a TEmployerTree object. Each object in turn has a ChildEmployers property which is a List of TEmployerTree, specifying the children of that employer. This allows you to recursively traverse the tree. The root TEmployerTree that is returned will contain the starting employer that you specified. 

A token is passed for authentication. If the authentication fails, or other errors occur, no employers 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 employer tree structure starting from the specified employer identifier")]
public TAuthEmployerTree GetEmployerTree(string token, string employerIdentifier);
Parameters 
Description 
string token 
String containing a token. 
string employerIdentifier 
String identifier of employer to start the tree at. 

TAuthEmployerTree : an Authenticated employer tree.

Copyright (c) VETtrak 2022. All rights reserved.