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

Update a Client Event. 

Returns a TAuthenticate object. 

The new Client Event details are represented by a TEven parameter (eEvent). Ensure any required properties, which are to remain unchanged, are populated with current values. 

The following properties of the eEvent parameter, and restrictions on their values, are used for the update:

  • EventID must be the ID of a valid client event.
  • EventName must be a valid event name.
  • EventStart must be a valid date.
  • EventFinish can be null. If not null, it cannot be before EventStart.
  • Complete must be a valid event completed flag, 0 = Not Completed, 1 = Completed.
  • StaffCode can be null. If not null, it must be the code of a valid staff member.
  • EventType must be CLIENT_EVENT (= 0).
  • EnrolmentId or ContractId can optionally be used to link the event to an enrolment or contract. They can both be null or 0, or one of them set, but not both set. If one of them is set, that enrolment or contract must belong to the client that the event is being attached to. If you specify null or 0, and the event already has an enrolment or contract linked, that enrolment or contract will be unlinked from the event.
 

The Identifier property of the eEvent parameter is ignored, since it is not possible to change the client to whom the event is linked. 

A token is passed for authentication. If the authentication fails, or other errors occur, no event details are updated. The result of the authentication and update is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Event Management feature.

C#
[WebMethod(Description = "Updates a client event")]
public TAuthenticate UpdateClientEvent(string sToken, TEven eEvent);
Parameters 
Description 
string sToken 
String Token. 
TEven eEvent 
TEven object containing event details to update. 

TAuthenticate : an authenticate object containing the results of the update.

Copyright (c) OzSoft Solutions 2016. All rights reserved.