Collapse All
ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
VT_API.AddSkillToClient Method

Adds a skill to a client.

C#
[WebMethod(Description = "Adds a skill to a client")]
public TAuthID AddSkillToClient(string token, TClieSkill clieSkill);
Parameters
Parameters 
Description 
string token 
String containing an authentication token. 
TClieSkill clieSkill 
TClieSkill object containing the client skill details to add. 
Returns

TAuthID indicating whether the update was successful and, if so, the ID of the new client skill.

Remarks

Pass a TClieSkill object containing the details of the client skill to create: 

  • SkillCode is mandatory and must be the code of the skill to add. Call GetSkills to get a list of all skill codes.
  • ClieCode must be the code of the client to add the skill to.
  • AcquiredDate is mandatory and must be the date that the skill was acquired.
  • ExpiryDate is optional. You can specify the date the skill expires. If specified, it cannot be before the AcquiredDate. If not specified, and the skill has an ExpiryMonths, the expiry date will be calculated automatically.
  • IsActive is mandatory, true or false.
  • Description is optional, and can be notes to record against the client skill.
 

All other TClieSkill properties are not used for the create. 

If successful, the returned TAuthID contains an ID property indicating the ID of the new client skill record (which is required if you want to later update the client skill using UpdateClientSkill). 

A token is passed for authentication. If the authentication fails, or other errors occur, no record is created. 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.

Group
Copyright (c) VETtrak 2022. All rights reserved.

Made with Doc-O-Matic® Express

Doc-O-Matic