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

Handshake with the API. 

This function is used to test the connection from a web application to the API. 

If the connection is established, a call to this function will return the String (without the quotes): 'You are connected to the API.' If the connection is not established, a call to this function will return an error.

C#
[WebMethod(Description = "Checks the connection to the API")]
public string API_Handshake();

String.

Connection Status 
String Returned 
Successful 
You are connected to the API. 
Unsuccessful 
Error Message * 

  • Error Message may vary according to circumstances.
 

This function has security level "Public", and can be accessed by anyone without authentication.  

string : a message.

Copyright (c) VETtrak 2022. All rights reserved.