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

Gets a list of employers that are associated with a client. 

  • The clientCode parameter is the code of the client to retrieve the list of employers for.
  • Pass includeAsContact as true to include the employers that the client is a current contact for in the returned list.
  • Pass includeAsEmployee as true to include the employers that the client is a current employee of in the returned list.
 

The includeAsContact and includeAsEmployee parameters cannot both be false. 

Returns a TAuthEmplList object containing a list of employers associated with the client. 

A token is passed for authentication. If the authentication fails, or other errors occur, no event details are updated. The result of the authentication and update 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 employers associated with a client")]
public TAuthEmplList GetEmployersForClient(string token, string clientCode, bool includeAsContact, bool includeAsEmployee);
Parameters 
Description 
string token 
String Token. 
string clientCode 
String code of client to retrieve employers for. 
bool includeAsContact 
True to include employers that the client is a current contact for, false to not. 
bool includeAsEmployee 
True to include employers that the client is a current employee of, false to not. 

TAuthEmplList : an authenticated list of employers that are associated with the client.

Copyright (c) VETtrak 2022. All rights reserved.