TAuthenticate indicating the result.

This function allows you to trigger the password reset process for a user. This process will cause a VETtrak Web Portal to send a password reset email to the user with a button that takes the user to the web portal to set a new VETtrak password on their account. This can be useful in particular if you are creating new students who need to be able to access the VETtrak Student Portal immediately. 

To use this function, all of the following must be in place: 

• The client must have security access to at least one VETtrak web portal (Student Portal, Trainer Portal, Progress Portal or VTDocs). Note that by default VETtrak is configured to automatically grant new clients access to the Student Portal, so this should normally be available (this is configured in File menu -> General Preferences -> Client tab -> Default web portal role for new clients)
• The VETtrak registration key must have a valid registration for that VETtrak web portal
• That VETtrak web portal must be installed
• VETtrak must be configured with that VETtrak web portal's base URL (in File menu -> Global Preferences -> specific portal -> specific portal URL)
• VETtrak must be configured with an email address to send password reset emails from (in File menu -> Security Settings -> page 3 -> Staff Member or Email Address to send user-initiated password reset emails from)
• VETtrak, or that web portal, must have valid email server settings configured to allow it to send emails from the above email address
• The client must have an email address to send the password reset email to

A token is passed for authentication. If the authentication fails, or other errors occur, the error is returned in the 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 reset their own password.

VT_API Methods