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

Updates various additional data fields for a client.

C#
[WebMethod(Description = "Updates additional fields for a client")]
public TAuthenticate UpdateClientAdditionalFields(string token, string clientCode, string additionalFieldData);
Parameters 
Description 
string token 
String containing a token. 
string clientCode 
String of the client code to update the additional fields for. Maximum length 10 characters. 
string additionalFieldData 
XML string to update the additional fields from. 

TAuthenticate indicating whether the update was successful

This function can be used to update a range of additional data fields on an existing client. 

The clientCode parameter must be the code of an existing client to update the data for. 

The additionalFieldData parameter must be a valid XML string in the format: 

 

<AdditionalData>
    <fieldname>fieldvalue</fieldname>
    <fieldname>fieldvalue</fieldname> ... etc
</AdditionalData>

 

The available fieldnames are those that are valid for the Client entity. Use the GetAdditionalDataFieldsForEntity function with an entityName of "Client" to get a list of fields that are valid to use for this function, or refer to the additional data documentation at http://www.vettrak.com.au/api 

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 &lt;, &gt; or &amp;, 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. 

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 access their own data.

Copyright (c) VETtrak 2022. All rights reserved.