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

Get a list of clients that a user can access. 

Specify the client code of a VETtrak user. You can also optionally specify a since date, so that only clients added or modified since that date are returned. 

This function returns a list of clients that the user can access - that is a list of clients that are assigned to any of the divisions, or any descendants of those divisions, that the user is assigned to. 

Each client is represented by a TClie object. 

A token is passed for authentication. If the authentication fails, or other errors occur, no clients 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.

C#
[WebMethod(Description = "Gets a list of clients that a user can access")]
public TAuthClieList GetAccessibleClients(string token, string clientCode, DateTime? sinceDate);
Parameters 
Description 
string token 
String containing a token. 
string clientCode 
String client code of a VETtrak user (staff member) to retrieve accessible clients for. 
DateTime? sinceDate 
Optional DateTime. If specified, only clients added or modified since this date are returned. 

TAuthClieList : an Authenticated list of Client items.

Copyright (c) VETtrak 2022. All rights reserved.