|
ASP.NET VETtrak API web services
|
   |
   |
VT_API.UpdateEmployerAdditionalFields Method
|
ASP.NET VETtrak API web services
|
|
|
Updates various additional data fields for an employer.
[WebMethod(Description = "Updates additional fields for an employer")] public TAuthenticate UpdateEmployerAdditionalFields(string token, string employerIdentifier, string additionalFieldData);
|
Parameters |
Description |
|
string token |
String containing a token. |
|
string employerIdentifier |
String of the employer identifier to update the additional fields for. |
|
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 employer.
The employerIdentifier parameter must be the identifier of an existing employer 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 Employer entity. Use the GetAdditionalDataFieldsForEntity function with an entityName of "Employer" 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 <, > 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.
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.
|
