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

Update the AVETMISS details of a Web Client attached to a waitlist entry. 

A Client Web Waitlist must have previously been created, see AddClientWebWaitlist. This function records AVETMISS details for the Client in the given Web Waitlist. Any existing AVETMISS details for the Web Client are replaced. 

A Web Waitlist ID (webWaitlistId) is passed as a parameter. This should be the ID returned by the AddClientWebWaitlist function. 

This function should not be used to update details of clients who are part of a Client Web Enrolment. In these cases, use UpdateWebClientAVETMISS. 

A token is passed for authentication. If the authentication fails, or other errors occur, nothing is updated . The result of the authentication is represented by a TAuthenticate object. 

Requires a valid registration key entry for the Short Courses feature. 

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 = "Records the specified AVETMISS data against the client linked to the specified web waitlist ID")]
public TAuthenticate UpdateClientWebWaitlistAVETMISS(string token, int webWaitlistId, string countryCode, string employmentCategoryCode, string languageCode, string schoolLevelCode, string priorEdFlag, string disabilityFlag, string atSchoolFlag, int yearCompleted, string whereCompleted, string profSpokEngFlag, string aboriginalFlag, List<TDisa> disabilityList, List<TPred> priorEdList);
Parameters
Parameters 
Description 
string token 
String containing a token. 
int webWaitlistId 
Integer ID of Web Waitlist. 
string countryCode 
String - Code for Country where Client was born. See GetCountryList for Valid Country Codes. 
string employmentCategoryCode 
String - Code for Client's Employment Category. See GetEmploymentCategoryList for Valid Employment Category Codes. 
string languageCode 
String - Code for Language spoken by Client at home. See GetLanguageList for Valid Language Codes. 
string schoolLevelCode 
String - Code for School Level attained by Client. See GetSchoolLevelList for Valid School Level Codes. 
string priorEdFlag 
String - Prior Education Achievement Flag.
Valid Prior Education Flags are:
  • PriorEdFlag = @ ....... Not Stated,
  • PriorEdFlag = Y ....... Yes, a prior education achievement has been successfully completed,
  • PriorEdFlag = N ....... No, a prior education achievement has NOT been successfully completed. 
string disabilityFlag 
String - Disability Flag.
Valid Disability Flags are:
  • DisabilityFlag = @ ....... Not Stated,
  • DisabilityFlag = Y ....... Yes, has Disability,
  • DisabilityFlag = N ....... No, does not have Disability. 
string atSchoolFlag 
String - At (Secondary) School Flag.
Valid At School Flags are:
  • @ => Not Stated,
  • Y => Yes,
  • N => No. 
int yearCompleted 
Integer - Year Client's Highest School Level was attained. 
string whereCompleted 
String - Where Client's Highest School Level was attained. Maximum length 50 characters. 
string profSpokEngFlag 
String - Proficiency in Spoken English Flag.
Valid Flags are:
  • @ => Not Stated,
  • 1 => Very Well,
  • 2 => Well,
  • 3 => Not Well,
  • 4 => Not at all. 
string aboriginalFlag 
String - Aboriginal Flag.
Valid Flags are:
  • @ => Not Stated,
  • 1 => Aboriginal,
  • 2 => Torres Strait Islander,
  • 3 => Both,
  • 4 => Neither. 
List<TDisa> disabilityList 
List of TDisa - List of Disability items relating to Client. 
List<TPred> priorEdList 
List of TPred - List of Prior Education items relating to Client. 
Returns

TAuthenticate : an Authenticate Object containing the result of the update.

Description

 

 

 

 

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

Made with Doc-O-Matic® Express

Doc-O-Matic