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

Update the comment against an enrolled unit. 

Use this function to set or change the comment recorded against an Enrolment Unit. The new comment replaces any existing comment that may be already against the enrolled unit.  

An Enrolment ID (enrolmentId) is passed as a parameter. enrolmentId must specify a valid Enrolment, otherwise, the Result is not updated.  

A Unit Code (unitCode) is passed as a parameter. unitCode must specify a valid Unit Code which is a linked to the Enrolment (enrolmentId), otherwise, the comment is not updated.  

The comment (comment) is passed as a parameter. This is a string of the comment to record against the enrolled unit. It replaces any existing comment. It can be empty to remove any existing comment. 

A token is passed for authentication. If the authentication fails, or other errors occur, no update is performed. 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 = "Updates the enrolled unit comment for the specified enrolment ID and unit code")]
public TAuthenticate UpdateResultComment(string token, int enrolmentId, string unitCode, string comment);
Parameters 
Description 
string token 
String containing a token. 
int enrolmentId 
Integer ID of Enrolment. 
string unitCode 
String Unit Code. Maximum length 12 characters. 
string comment 
String of the comment to record against the enrolled unit. 

TAuthenticate : a TAuthenticate object containing the status of the update. This contains properties Status and StatusMessage which will indicate if the update is successful.

Copyright (c) VETtrak 2022. All rights reserved.