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

Get the Client for a given Client Surname, Given Name and Date of Birth. 

This returns the basic client details (Surname, Given Name and Code) which match the given client parameters (Surname, Given Name and Date of Birth). Will return the client regardless of whether the client has been web published. If there is no match for the given client parameters, each of the properties of the returned client is empty (= ''). 

To check if the given code represents a valid client, compare the given (non-empty) surname (say) with the Clie_Surname property of the returned client. 

ie.

  • If sClie_Surname = GetClientByName(sToken, sClie_Surname, sClie_Given, xsdClie_DOB).Clie.Clie_Surname
  • then " (sClie_Surname, sClie_Given, xsdClie_DOB) is a VALID Client"
  • else " (sClie_Surname, sClie_Given, xsdClie_DOB) is an INVALID Client"
 

Such a check could be used to determine if a person exists in VETtrak as a client. If he/she did not exist, then he/she could be created in VETtrak before proceeding with other functions. The function AddClientAfterCheck does this (Integrate API only). 

The Client is represented by a TClie

A token is passed for authentication. If the authentication fails, or other errors occur, an 'empty' client is 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 client with the specified surname, given name and date of birth")]
public TAuthClie GetClientByName(string sToken, string sClie_Surname, string sClie_Given, DateTime xsdClie_DOB);
Parameters 
Description 
string sToken 
String Token. 
string sClie_Surname 
String containing the Surname of the Client. 
string sClie_Given 
String containing the Given Name of the Client. 
DateTime xsdClie_DOB 
DateTime containing the Date of Birth of the Client. Cannot be Null. 

TAuthClie : an Authenticated Client. If the Client parameters (sClie_Surname, sClie_Given, xsdClie_DOB) do not represent a valid client, the Auth property shows an error and the properties of the returned Client are empty. ( = '')

Copyright (c) VETtrak 2022. All rights reserved.