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

Gets a list of relationships for a client.

C#
[WebMethod(Description = "Gets a list of relationships for a client")]
public TAuthClieRelationshipList GetClientRelationships(string token, string clientCode);
Parameters 
Description 
string token 
String containing an authentication token. 
string clientCode 
String containing the code of the client to retrieve relationships for. 

TAuthClieRelationshipList containing a list of relationships for the client.

This is a listing of relationships that the specified client has, ie. where the client is on the "from" end of the relationship. Past/inactive relationships are included. 

Each relationship type is represented in a TClieRelationship object. The list of relationship types is in the returned TAuthClieRelationshipList object. 

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

Copyright (c) VETtrak 2022. All rights reserved.