|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.UpdateAdditionalDataForWebRecord Method
|
ASP.NET VETtrak API web services
|
|
|
Sets or updates additional data fields against a web client, employer, employee or contact.
[WebMethod(Description = "Updates the additional data field for a web client, employer, employee, contact or waitlisted client")] public TAuthenticate UpdateAdditionalDataForWebRecord(string token, int recordType, int recordId, string additionalData);
|
Parameters |
Description |
|
string token |
String containing a token. |
|
int recordType |
Integer identifying the type of record to update. Valid values are:
|
|
int recordId |
The ID of the record to update the additional data for. The meaning of this will depend on the value of recordType:
|
|
string additionalData |
The string to store as the additional data for this record |
TAuthenticate indicating the success of the update
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:
<AdditionalData>
<fieldname>fieldvalue</fieldname>
<fieldname>fieldvalue</fieldname> ... etc
</AdditionalData>
The available fieldnames depend on the entity that the additional data is being set for (client or employer). Use the GetAdditionalDataFieldsForEntity function to get a list of fields that are valid for one of these entities, or refer to the additional data documentation at http://www.vettrak.com.au/api
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 additionalData parameter is a string to save as the custom data for that record.
Calling this function multiple times for the same recordType and recordId will overwrite the additionalData from the previous call. The current additional value can be retrieved by calling GetAdditionalDataForWebRecord.
Please ensure that you use standard XML entities if you wish to use special XML characters in any field value - for example, instead of <, > or &, use <, > or &, respectively.
A token is passed for authentication. If the authentication fails, or other errors occur, the custom data field is not updated. 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.
|
Copyright (c) VETtrak 2022. All rights reserved.
|
