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

Retrieves the previously-recorded additional data field against an unprocessed web client, employer, employee or contact. 

This is used to set other non-standard fields in a processed web enrolment. The format of the data is to be an XML string. This contains essentially name-value pairs, mapping additional data field names to values. 

The recordType parameter is an indentifier of what type of record to update (web client, employer, employee or contact). The recordId parameter is the ID of the record of that type to update. The additional data can be set by calling UpdateAdditionalDataForWebRecord

A token is passed for authentication. If the authentication fails, or other errors occur, the additional data field is not retrieved. The result of the authentication is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Short Courses feature. 

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 = "Retrieves the additional data field for a web client, employer, employee, contact or waitlisted client")]
public TAuthString GetAdditionalDataForWebRecord(string token, int recordType, int recordId);
Parameters 
Description 
string token 
String containing a token. 
int recordType 
Integer identifying the type of record to retrieve the additional data for. Valid values are:
  • 0: Web client
  • 1: Web employer
  • 2: Web employee in a web employer enrolment
  • 3: Web contact in a web employer enrolment
  • 4: Loose web employer
  • 5: Waitlisted client
 
int recordId 
The ID of the record to retrieve the additional data for. The meaning of this will depend on the value of recordType:  

TAuthString indicating whether it was successful, and if so, Text property contains the additional data string for the identified record

Copyright (c) VETtrak 2022. All rights reserved.