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

Retrieves a list of the identifiers of all records deleted from a particular table since a specified date. 

The tableName parameter must be one of the following:

  • CLIENT (the result will be a list of deleted client codes, since upgrading to VETtrak 4.3.9)
  • EMPLOYER (the result will be a list of deleted employer identifiers, since upgrading to VETtrak 4.3.9)
  • ENROLMENT (the result will be a list of deleted enrolment and occurrence IDs, since upgrading to VETtrak 4.3.9)
  • PROGRAMME (the result will be a list of deleted programme IDs, since upgrading to VETtrak 4.3.9)
  • ENROUNIT (the result will be a list of deleted enrolled unit IDs, since upgrading to VETtrak 4.3.10)
  • QUALCLIE (the result will be a list of deleted client award IDs, since upgrading to VETtrak 4.3.11)
  • SUBURB (the result will be a list of deleted suburb IDs, since upgrading to VETtrak 4.3.11)
  • INVOICE (the result will be a list of deleted invoice IDs, since upgrading to VETtrak 4.4.0)
  • PAYMENT (the result will be a list of deleted payment IDs, since upgrading to VETtrak 4.4.0)
 

Only the identifiers of records that have been deleted after the specified sinceDate parameter are returned. 

The result is a TAuthStringList. The TextList property contains an array of strings, each one an identifier for a deleted record. If no records in the specified table were deleted since the specified date, the TextList will be empty. 

A token is passed for authentication. If the authentication fails, or other errors occur, no data will be 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 a list of the identifiers of all records deleted from a table since a date")]
public TAuthStringList GetDeletedRecordsSince(string token, string tableName, DateTime sinceDate);
Parameters 
Description 
string token 
Mandatory string containing a token. 
string tableName 
Mandatory string containing the name of the table to get deleted records of. 
DateTime sinceDate 
Mandatory DateTime, only records deleted after this date are returned 

TAuthStringList, containing the identifiers of records deleted from the table since the date

Copyright (c) VETtrak 2022. All rights reserved.