ASP.NET VETtrak API web services
ContentsIndexHome
PreviousUpNext
Classes

The following table lists classes in this documentation.

 
Name 
Description 
 
The definition of a field within an entity. Has the name and type of the field.  
 
Represents a criteria to use to filter data  
 
Represents the results of a query  
 
Class for a list of reference data. Classes that use a list of the generic TUtil should be derived from this class. Holds a TAuthenticate and a List of some type, as well as a method for populating the list from the database. 
 
Represents a field to return in the query results  
 
Specifies how the return data should be sorted  
 
This class represents an address.
It is an AVETMISS 7 format address, used for clients, employers and locations. Can represent either a physical (client usual/residential and business) or postal addresses.  
 
ANZSIC Class
Each TAnzs identifies an ANZSIC item. This class is used to record a Employer's industry or principle activitity according to the Australian and New Zealand Standard Industrial Classifacation.
A TAnzs object has properties:
 

  • Anzs_Name = Name of ANZSIC item,
  • Anzs_Code = ANZSIC Code.


GetANZSICList displays a listing of all ANZSIC Names and Codes. 

 
This object contains the various version numbers related to this API.
This has different properties for the different version numbers, so that they are easy for software to read and use.  
 
Models a Client Attendance at a class.
Properties include the name of the Attendance type, dates and times associated with the Attendance, and the an indicator of positive, neutral or negative attendance. 
 
Attendance Type Class
Each TAtty indentifies a Attendance Type.
A TAtty object has properties:
 

  • Atty_Name = Name of Attendance Type,
  • Atty_Code = Attendance Type Code,
  • Atty_Desc = Attendance Type Description,
  • Atty_Type = Attendance Type Type Flag.
  • Atty_Default = Attendance Type Default Flag.
  • Active = Attendance Type Active Flag.


GetAttendanceTypeList displays a listing of all Attendance Types. 

 
Contains information about a newly-created award.  
 
Authenticated ANZSIC List Class.
A class containing a TAuthenticate object and an ANZSIC List (List of TAnzs). 
 
Authenticated Attendance Class.
A class containing a TAuthenticate object and an Attendance (TAtte). 
 
Authenticated Attendance List Class.
A class containing a TAuthenticate object and an Attendance List (List of TAtte). 
 
Authenticated Attendance Type List Class.
A class containing a TAuthenticate object and an Attendance Type List (List of TAtty). 
 
An authenticated list of award types.  
 
Authenticated Booking Class.
A class containing a TAuthenticate object and a Booking (TBooking). 
 
Authenticated Booking List Class.
A class containing a TAuthenticate object and a Booking List (List of TBooking).  
 
Represents the results of a boolean check.  
 
Authenticated Client.
A class containing a TAuthenticate object and a basic Client (TClie). Used to pass information about a Client back to a user. 
 
Authenticated Client AVETMISS Details Class.
A class containing a TAuthenticate object and a Client AVETMISS Details (TClieAVETMISS). 
 
Authenticated Client Detail Class.
A class containing a TAuthenticate object and a Client Detail Object (TClieDetail). 
 
Authenticated Client Enrolment Class.
A class containing a TAuthenticate object and a Client Enrolment (TClieEnro). 
 
Authenticated Client Enrolment List Class.
A class containing a TAuthenticate object and an Client Enrolment List (List of TClieEnro). 
 
Authenticated Extended Client.
A class containing a TAuthenticate object and an extended Client (TClieExtended). Used to pass extended information about a Client back to a user. 
 
Authenticated Client List Class.
A class containing a TAuthenticate object and a basic Client List (List of TClie). 
 
Authenticated Client Staff Links List Class.
A class containing a TAuthenticate object and a list of Client Staff Member Links (List of TClieStaffLinks). 
 
Authenticated results of completing a web reservation.
If the occurrence is configured to automatically process web reservations, WasAutoProcessed will be true, and ProcessedWebEnrol will contain the details of the processed web enrolment.
A class containing a TAuthenticate object, a flag indicating whether the web enrolment was automatically processed, and if it was automatically processed, details of a processed web enrolment (TProcessedWebEnrol).  
 
Authenticated Contract/Enrolment List.
A class containing a TAuthenticate object and a Contract/Enrolment List (List of TContEnro). 
 
Authenticated Contract List Class.
A class containing a TAuthenticate object and a Contract List (List of TCont). 
 
Authenticated Contract Staff List.
A class containing a TAuthenticate object and a Contract Staff List (List of TContStaff). 
 
Authenticated Country List Class.
A class containing a TAuthenticate object and a Country List (List of TCoun). 
 
Authenticated Disability List Class.
A class containing a TAuthenticate object and a Disability List (List of TDisa). 
 
Authenticated division class.
A class containing a TAuthenticate object and a division object (TDivision).  
 
Authenticated division list class.
A class containing a TAuthenticate object and a list of division objects (TDivision).  
 
Authenticated division tree class.
A class containing a TAuthenticate object and a division tree object (TDivisionTree).  
 
Authenticated division tree list class.
A class containing a TAuthenticate object and a list of division tree objects (TDivisionTree).  
 
Authenticated Education History List Class.
A class containing a TAuthenticate object and an Education History List (List of TEducationHistory).  
 
Authenticated Employment Category List Class.
A class containing a TAuthenticate object and a Employment Category List (List of TEmca). 
 
Authenticated Employer Contact List Class.
A class containing a TAuthenticate object and an Employer Contact List object (List of TEmco). 
 
Authenticated Employer Class.
A class containing a TAuthenticate object and an Employer (TEmpl). 
 
Authenticated Employer List Class.
A class containing a TAuthenticate object and an Employer List object (List of TEmpl). 
 
Authenticated Employer Tree Class.
A class containing a TAuthenticate object and an Employer Tree (TEmployerTree).  
 
Authenticated Employer Tree List Class.
A class containing a TAuthenticate object and a list of Employer Tree objects (TEmployerTree).  
 
Authenticated Employer Type List Class.
A class containing a TAuthenticate object and a Employer Type List (List of TEmty). 
 
Authenticated Enrolment Class.
A class containing a TAuthenticate object and an Enrolment (TEnro). 
 
Authenticated Enrolment List Class.
A class containing a TAuthenticate object and an Enrolment List (List of TEnro
 
Authenticated Enrolment Staff List.
A class containing a TAuthenticate object and a Enrolment Staff List (List of TEnroStaff). 
 
Authenticate Class.
Models an attempt to Authenticate a user. A user may attempt to authenticate by passing a username and password, or by passing a token previously obtained.
The user can be an Employer, a Client or a Staff Member.
A Token is generated when a user calls a Validate function (ValidateClient, ValidateEmployer or ValidateUser) and passes a valid username and password.
Both Clients and Staff generate Client Tokens (TokenType = CLIE_TOKEN = '02'), while Employers generate Employer Tokens (TokenType = EMPL_TOKEN = '01').
If an Authentication attempt is successful, a 'good' TAuthenticate is returned, containing:

  • Token property : a... more 
 
Contains details of all entities supported for custom queries or custom data  
 
Authenticated EnroUnit List Class.
A class containing a TAuthenticate object and an EnroUnit List (List of TEnun). 
 
Authenticated Event List Class.
A class containing a TAuthenticate object and an Event List (List of TEven). 
 
Authenticated Event Type List Class.
A class containing a TAuthenticate object and an Event Type List (List of TEventType). 
 
Contains details of all fields supported by an entity for custom queries or custom data  
 
Authenticated ID.
A class containing a TAuthenticate object and an Integer. 
 
Authenticated Instances List.
A class containing a TAuthenticate object and an Instance List (List of TInst). 
 
Authenticated Invoice Class.
A class containing a TAuthenticate object and an Invoice (TInvoice). 
 
Authenticated Invoice List Class.
A class containing a TAuthenticate object and a list of Invoices (List of TInvoice). 
 
Authenticated Language List Class.
A class containing a TAuthenticate object and a Language List (List of TLang). 
 
Authenticated Location List Class.
A class containing a TAuthenticate object and a Location List (TLocaList). 
 
Authenticated Occurrence Class.
A class containing a TAuthenticate object and an Occurrence (TOccu). 
 
Authenticated Extended Occurrence.
A class containing a TAuthenticate object and an extended Occurrence (TOccuExtended). Used to pass extended information about an Occurrence back to a user. 
 
Authenticated Extended Occurrence Details List Class.
A class containing a TAuthenticate object and an Occurrence Extended Details List (List of TOccuExtended). 
 
Authenticated Occurrence List Class.
A class containing a TAuthenticate object and an Occurrence List (List of TOccu). 
 
Authenticated Occurrence Staff Links List Class.
A class containing a TAuthenticate object and a list of Occurrence Staff Member Links (List of TOccuStaffLinks). 
 
Authenticated Organisations List.
A class containing a TAuthenticate object and an Organisation List (List of TOrga). 
 
Authenticated Payment List Class.
A class containing a TAuthenticate object and a list of Payments (List of TPayment).  
 
Authenticated Payment Type List Class.
A class containing a TAuthenticate object and a Payment Type List (List of TPaymentType). 
 
Authenticated Prior Education List Class.
A class containing a TAuthenticate object and a Prior Education List (List of TPred). 
 
Authenticated prior education achievement recognition identifier list class.
A class containing a TAuthenticate object and a prior education achievement recognition identifier list (List of TPredRecognition). 
 
Authenticated Programme Type List Class.
A class containing a TAuthenticate object and a Programme Type List (List of TPrgt). 
 
Authenticated Price List Class.
A class containing a TAuthenticate object and a Price List (List of TPric). 
 
Authenticated results of processing a web enrolment.
A class containing a TAuthenticate object and details of a processed web enrolment (TProcessedWebEnrol).  
 
Authenticated results of processing a web waitlist entry.
A class containing a TAuthenticate object and details of a processed web waitlist entry (TProcessedWebWaitlist).  
 
Authenticated Programme List Class.
A class containing a TAuthenticate object and a list of Programmes (TProg). 
 
Authenticated Qualification List.
A class containing an TAuthenticate object and a List of TQual
 
Authenticated Qualification State List.
A class containing an TAuthenticate object and a list of Qualification States (List of TQualState).  
 
Authenticated Award List.
A class containing an TAuthenticate object and a List of TQucl
 
Authenticated Qualification Unit List.
A class containing a TAuthenticate object and a Qualification Unit List (List of TQuun). 
 
Authenticated Referral Source List Class.
A class containing a TAuthenticate object and a Referral Source List (List TReferral). 
 
Authenticated Result Type List.
A class containing an TAuthenticate object and a Result Type List (List of TRety). 
 
Authenticated Rooms List.
A class containing a TAuthenticate object and a Room List (List of TRoom). 
 
Authenticated School Level List Class.
A class containing a TAuthenticate object and a School Level List (List of TScle). 
 
This class contains the results of sending a single SMS message to a mobile number. The TAuthenticate indicates whether the sending was successful. If successful, SmsSent will contain the number of messages that were sent (should be 1), and SmsBalance contains the new SMS balance for the business.  
 
Authenticated list of SMS message results.
A class containing a TAuthenticate object, a list of sent SMS results (List of TSMSResult), and some other information about the sent SMS.
If successful, SmsSent will contain the number of messages that were sent successfully, SmsBalance contains the new SMS balance for the business, and the list of TSMSResult contains the individual status for each sent message.  
 
This class contains the status of a business' VETtrak SMS service. The TAuthenticate indicates whether the SMS status could be determined. SmsStatus will indicate the status of the business' SMS service, and SmsBalance will contain the business' SMS balance.  
 
Authenticated Extended Staff.
A class containing a TAuthenticate object and an extended Staff (TStaffExtended). Used to pass extended information about a Staff member, back to a user. 
 
Authenticated Staff Type List Class.
A class containing a TAuthenticate object and an Staff Type List (List of TStaffType). 
 
Authenticated State List Class.
A class containing a TAuthenticate object and a State List (List of TStat). 
 
Authenticated string.
A class containing a TAuthenticate object and a String. 
 
Authenticated list of Strings.
A class containing a TAuthenticate object and a list of Strings. 
 
Authenticated Study Reasons List Class.
A class containing a TAuthenticate object and a Study Reasons List (List of TStudyReason). 
 
Authenticated Suburb List Class.
A class containing a TAuthenticate object and a Suburb List (List of TSuburb).  
 
Authenticated Task Enrolment List Class.
A class containing a TAuthenticate object and a Task Definition List (List of TTaskEnrolment
 
Authenticated Task List Class.
A class containing a TAuthenticate object and a Task Definition List (List of TTask
 
This class represents an authenticated unit.
A class containing an TAuthenticate object and a TUnit.  
 
Authenticated Unit List.
A class containing a TAuthenticate object and a Unit List (List of TUnit). 
 
Authenticated Unit State List.
A class containing a TAuthenticate object and a Unit State List (List of TUnitState).  
 
Authenticated Visa Type List Class.
A class containing a TAuthenticate object and a Visa Type List (List TVity). 
 
Authenticated Web Enrolment Class.
A class containing a TAuthenticate object and a Web Enrolment (TWebe). 
 
Authenticated Web Waitlist entry class.
A class containing a TAuthenticate object and a web waitlist entry (TWebWaitlist).  
 
Authenticated Web Client List Class.
A class containing a TAuthenticate object and a Web Client List (List of TWecl). 
 
Authenticated Web Employer Class.
A class containing a TAuthenticate object and a Web Employer (TWeco). 
 
Authenticated Web Company List Class.
A class containing a TAuthenticate object and an Web Company List (List of TWeco). 
 
This class contains details of the transfer of an enrolment to an LMS for online learning.  
 
Contains details of an award type.  
 
Employer Corporate Booking.
A booking is a private occurrence for an employer. It requires the Bookings feature.
This class is descended from a TOccu (an occurrence). In addition to the inherited TOccu properties, it contains booking details.  
 
Basic Client Class.
A Client represents a person in the training system. This can be a person undertaking training (a student) or a person involved in delivering training (a staff member).
This basic client class contains only three properties representing the Client's Surname, Given Name and Code.
More detailed information about a client is contained in the class TClieDetail. TClieAVETMISS, contains AVETMISS Details about a Client (Portals API only). 
 
Client AVETMISS Details Class.
Inherits from TClie. Describes information relating to a Client that is essentially used ONLY for AVETMISS reporting.
Properties relate to Language, Country of Birth, Prior Education, Disabilies, Indiginous Status and so on.
The gender of the client, for example, is not a property of this class, because while it is included in AVETMISS reports, it is a more generally useful piece of information. Therefore, Clie_Gender is a property of the TClieDetail class rather than this class. 
 
Client Detail Class.
Inherits from TClie. Describes a Client in more detail than the basic TClie class. Mostly the added properties describe Contact Details (addresses and phone numbers).
Does not include AVETMISS information. This is described in TClieAVETMISS
 
Models a Client Enrolment.
Inherits from Enrolment Class (TEnro), with the addition of Clie_Code, GivenName and Surname properties which holds the code and name of the student involved in the enrolment. 
 
Extended Client Details Class.
An Extended Client represents a client with properties which detail their training activity.
The properties are mostly lists 
 
This class represents a staff member (or client) along with multiple ways it is linked to other entities via staff (such as occurrences, classes, enrolments, contracts or events).  
 
Models a Contract (for a Client)
Properties include the start and end date of the Contract, the Qualification Code and Name (if applicable) to which the contract is linked, the contract status name, the Employer Identifier and Name. 
 
Contract/Enrolment Class
A TContEnro descends from a TCont (Contract), with the addition of a Record Type (Rec_Type) property.
The Rec_Type property takes:
  • 'C' for a Contract,
  • 'E' for an Enrolment.
 
 
Contract Staff Class.
This class describes the role of a staff member in a contract.
A TContStaff has properties of a contract (TCont), the client (TClie) linked to the contract and a staff role (TStaffRole) to identify the staff member and their role in the contract. 
 
Country Class
Each TCoun identifies a Country. This class is used to record a Client's country of birth.
A TCoun object has properties:
  • Coun_Name = Name of Country,
  • Coun_Code = Country Code.

GetCountryList displays a listing of all Country Names and Codes. 
 
Disability Class
Each TDisa identifies a seperate Disability suffered by the Client. A Client may have none, one or more Disabilities.
A TDisa object has properties:
  • Disa_Name = Description of Disability Type,
  • Disa_Code = Disability Code.

GetDisabilityList displays all valid Disabilty Codes and Descriptions. 
 
This class represents a division. Divisions are used to segregate data in the database and control what data users can access, they are often used to represent a corporate structure. Divisions are arranged into a tree structure, with each division having only one parent. Every VETtrak database has at least one division - the Root Division. The Root Division is the only root of the tree (the only division without a parent) and cannot be changed. The Security feature is required in order to create more divisions. Each client and enrolment is assigned to a division. VETtrak users can be... more 
 
Represents a division tree. Same as TDivision, but adds a recursive list of child divisions.  
 
Contains details of an education history entry. All fields are free-text.  
 
Employment Category Class
Each TEmca identifies an Employment Category. This class is used to record a Client's category of Employment or Labout Force Status.
A TEmca object has properties:
  • Emca_Name = Name of Employment Category,
  • Emca_Code = Employment Category Code.

GetEmploymentCategoryList displays a listing of all Employment Category Names and Codes. 
 
Employer Contact Class.
Contains details of a Contact Person for the Employer.
There may be more than one contact person for an employer. An employer contact is now (since v4.3.6) a client.
The Primary Contact property (Emco_Primary) may be set for a contact. However, for a given Employer, at most one contact can be a Primary Contact. 
 
Employer Class.
Describes an Employer. 
 
Represents an employer tree. Same as TEmpl, but adds a recursive list of child employers.  
 
Employer Type Class
Each TEmty identifies an Employer Type.
A TEmty object has properties:
  • Emty_Name = Name of Employer Type,
  • Emty_Code = Employer Type Code,
  • Emty_Desc = Employer Type Description.

GetEmployerTypeList displays a listing of all Employer Type Names and Codes. 
 
Models an Enrolment.
Properties include the start and end date of the enrolment, and the Qualification Code and Name (if applicable) to which the enrolment is linked. 
 
Enrolment Staff Class.
This class describes the role of a staff member in an enrolment.
A TEnroStaff has properties of an enrolment (TEnro), the client (TClie) linked to the enrolment and a staff role (TStaffRole) to identify the staff member and their role in the enrolment. 
 
EnroUnit Class.
Describes a Unit for an Enrolment or for a Contract.
Properties include information about the Qualification, the enrolment/contract, the unit and the result. 
 
Models an Event.
Properties include the event name and dates associated with the event.
If the event is for a client, the EventType will be 0. If the event is for an employer, EventType will be 1. 
 
Event Type Class
Each TEventType indentifies a type of event. The Name is used when creating or updating an event.
A TEventType object has properties:
  • Name = Name of Event Type,
  • Code = Event Type Code,
  • Description = Event Type Description,
  • Active = Event Type Active Flag.

GetEventTypes returns a listing of all Event Types. 
 
Training Instance (or Class).
Describes an Instance of a training class. The terminology - Instance, is used in preference to the ambiguous term - class.
An Instance has properties which describe its: Programme, Occurrence, Timetable, Room Location and Trainer. 
 
This class represents an invoice for payment  
 
This class represents a line item on an invoice  
 
Language Class.
Each TLang identifies a Language. This class is used to record the main Language spoken at home by a Client.
A TLang object has properties:
  • Lang_Name = Name of Language,
  • Lang_Code = Language Code.

GetLanguageList displays a listing of all Language Names and Codes. 
 
Location Class
Each TLoca identifies a Location used by the Training Provider for Training Delivery.
A TLoca object has properties:
  • Loca_Name = Name of Location,
  • Loca_Code = Location Code,
  • Address properties,
  • Loca_Loading = Loading applying to funding for Location,
  • Loca_Active = Flag to indicate Active Status.
 
 
Occurrence Class.
An Occurrence (or Programme Occurrence) is an instance of delivery of a Programme.
This class is descended from a TEnro (an enrolment) and models an Occurrence. In addition to the inherited TEnro properties, it contains programme information, location information and the number of vacancies for the Occurrence.
There is also an uploaded property. This is only relevant when the occurrence is an LMS occurrence. It indicates if the occurrence has been uploaded to the LMS. 
 
Extended Occurrence Details Class.
An Extended Occurrence represents an occurrence with properties which detail all its related data.
The properties are mostly lists 
 
This class represents an occurrence along with multiple ways it is linked to a staff member  
 
Organisation class.
This class contains details about an organisation in VETtrak. Most VETtrak databases will contain only one organisation, to represent the RTO that is using VETtrak, delivering training, and reporting to the government. If the Multi-RTO extension is being used, there can be multiple organisations.  
 
This class represents a payment against an invoice.  
 
Represents a payment type, such as "Cash", "Credit Card" etc.  
 
Prior Education Class
Each TPred identifies a seperate Prior Education achievement successfully completed by the Client. A Client may have none, one or more Prior Education achievements.
A TPred object has properties:
  • Pred_Name = Name of Prior Education achievement,
  • Pred_Code = Prior Education Code.
  • Recognition = Prior education achievement recognition identifier. Only used in Victoria.

GetPriorEducationList displays all valid Prior Education Codes, Names and Descriptions. 
 
Represents a prior education achievement recognition identifier  
 
Programme Type Class
Each TPrgt indentifies a Programme Type.
A TPrgt object has properties:
  • Prgt_Name = Name of Programme Type,
  • Prgt_Code = Programme Type Code,
  • Prgt_Desc = Programme Type Description,
  • Prgt_Active = Programme Type Active Flag.

GetProgrammeTypeList displays a listing of all Programme Types. 
 
Price Class.
This class holds the pricing information which applies to an occurrence. The properties of the class hold information like Pricing Item Name, Pricing Item Code, Amount & GST.
An Example: The Full Fee paying rate for an Occurrence is $44 (incl GST of $4).
Then:
  • Enpr_Amount = 44,
  • Enpr_GST = 4,
  • Pric_Code = 'FF',
  • Pric_Name = 'Full Fee'.
 
 
This class represents an employee or contact in an employer web enrolment that was processed. It contains details for a single processed employee or contact.  
 
Class containing details of a processed web enrolment.  
 
Class containing details of a processed web waitlist entry.  
 
Programme Class
Each TProg indentifies a Programme. A Programme is a training offering. This is the content delivered during a (Programme) Occurrence.
A TProg object has properties:
  • Prog_ID = Programme ID,
  • Prog_Name = Name of Programme,
  • Prog_Code = Programme Code,
  • Prog_Desc = Programme Description,
  • Prog_Active = Programme Active Flag,
  • Prgt_Name = Programme Type Name.
  • WaitlistFlag = Waitlistable Flag.

GetProgrammes displays a listing of all Programmes. 
 
Qualification Class:
Models a single qualification or a single course or a single position. A qualification is a component of a (Nationally Recognised) Training Package, while a Course is a programme of learning that is not from a Training Package.
A qualification is composed of 'Units of Competency', while a course is composed of Modules, see TUnit. For a given qualification or course, each Unit or Module may be core or elective, see TQuun (Integrate API only).
A position refers to a role in a company, and is linked to an Employer Contact.
As of version 4.3.8 and later of VETtrak... more 
 
Qualification State class.
Represents the state-specific information for a qualification. Hours, amounts and points can vary for the same qualification for different Australian states, this object represents this data for one qualification and one state.  
 
Award Class.
Models a single Award. An Award is the certification of the completion of a Qualification or Course by a Client. The name of this class, TQucl, is derived from Qualification Client.
Use the functions GetQualifications, GetCourses or GetQualificationAndCourses to see a listing of available Qualifications and/or Courses.
Some of the Properties of this class are:
  • Qual_Code : Qualification Code
  • Clie_Code : Client Code
 
 
Qualification Unit Class.
Models a single Unit of Competency ('Unit') for a Qualification (from a Training Package) or a single Module ('Module') for a course (not from a Training Package), see TQual.
This class descends from the TUnit class, and includes a 'Type' property (Quun_Type) which identifies whether a Unit is 'Core' or 'Elective' in a Qualification or Course:
  • For a Core Unit (or Module) : Quun_Type = 0.
  • For an Elective Unit (or Module) : Quun_Type = 1.
 
 
Referral Source Class
Each TReferral indentifies a source of referral, a possible answer to the question "how did you find out about us".
A TReferral object has properties:
  • Name = Name of Referral Source,
  • Code = Referral Source Code,
  • Description = Referral Source Description,
  • Active = Referral Source Active Flag.

GetReferralSources returns a listing of all Referral Sources. 
 
Result Type Class.
Models a single Result Type. A user of VETtrak can define the set of Result Types to be used by their organisation. On the other hand, Outcomes are specified by Training authorities.
Each Result Type must link to an Outcome.
Use the function GetResultTypes to see a listing of available Result Types.
Properties of this class are:
  • Result Type Name
  • Outcome Name
  • Outcome Code
  • Active flag
 
 
Room Class.
Describes a Room.
A Room has properties which describe its: Code, Name, Location. 
 
School Level Class
Each TScle indentifies a School Level. This class is used to record a Client's highest School Level completed.
A TScle object has properties:
  • Scle_Name = Name of School Level,
  • Scle_Code = School Level Code.

GetSchoolLevelList displays a listing of all School Level Names and Codes. 
 
Specifies an SMS Message to send. This is the code of the client to send the SMS message to, and/or the mobile phone number to use.
The behaviour will depend on which properties are set:
  • ClientCode set and MobilePhone not set: The SMS will be sent to the mobile phone number set for the client in VETtrak, and sent SMS history will be recorded against the client in VETtrak. If the client does not have a mobile number in VETtrak, the message will not be sent and the resulting TSMSResult Status will be -1. If the client code cannot be found... more 
 
This class represents the status of a single sent SMS message within a batch. The ClientCode and MobilePhone properties are as per the passed in TSMSRecipient, while the Status property indicates the status of the SMS message.  
 
Extended Staff Class.
An Extended Staff represents a staff member (who is a client - TClieDetail) with properties which detail training activity in which they are involved as a staff member.
The properties are mostly lists. 
 
This class represents how a staff member is linked to an entity (such as occurrence, class, enrolment, contract or event).  
 
Staff Role Class.
This class describes the role of a staff member. It is used in association with some training (an enrolment or a contract), to describe the role of a staff member in that training.
A TStaffRole has properties of:
  • Staff Code to identify the staff member,
  • Staff Type
  • Primary Staff Flag to indicates whether Staff member is the Primary Staff member for this training.
 
 
Staff Type Class
Each TStaffType indentifies a type of staff member that can be assigned to an employer or enrolment. Possible staff types could include "supervisor", "trainer" etc.
A TStaffType object has properties:
  • Name = Name of Staff Type,
  • Code = Staff Type Code,
  • Description = Staff Type Description,
  • Active = Staff Type Active Flag.

GetStaffTypes returns a listing of all Staff Types. 
 
State Class
Each TStat indentifies a State. This class is used to record the State or Territory component of an address or location.
A TStat object has properties:
  • Stat_Name = Name of State,
  • Stat_Code = State Code,
  • Stat_ShortName = Short Name of State.

GetStateList displays a listing of all State Names, Codes and Short Names. 
 
This class represents a study reason. This is from an AVETMISS list. Each state has its own list, and there's an additional list for national reporting. Each enrolment may have a reason for study.  
 
This class represents a suburb/city/town.  
 
This class represents a definition of a task.  
 
This class represents an enrolment in a task.
It is an intersection between a TTask (task definition), TEnro (enrolment) and TClie (client), and has a result of either incomplete or complete.  
 
Unit Class.
Models a single Unit of Competency ('Unit') from a Training Package, which could be a component of a qualification, or a single Module ('Module') from outside a Training Package, which could be a component of a course (see TQual, Integrate API only).
Units and Modules are distinguished by the value of the Unit_Type property.
  • For a Unit : Unit_Type = 0.
  • For a Module : Unit_Type = 1.

As of version 4.3.8 and later of VETtrak and the API, the hours, points and amounts are now state-based, and have been moved to TUnitState
 
Unit State class.
Represents the state-specific information for a unit. Hours, amounts and points can vary for the same unit for different Australian states, this object represents this data for one unit and one state.  
 
Visa Type Class
Each TVity indentifies a Visa Type.
A TVity object has properties:
  • Vity_Name = Name of Visa Type,
  • Vity_Code = Visa Type Code,
  • Vity_Desc = Visa Type Description,
  • Vity_Active = Visa Type Active Flag.

GetVisaTypeList displays a listing of all Visa Types. 
 
Models a Web Enrolment.
A web enrolment is an enrolment that is instigated by someone accessing a web page. There is a distinction between this and a normal enrolment to allow various checks to be made before data is integrated with that of normal enrolments in the VETtrak database.
Assuming it passes the checks, data in the web enrolment table will eventually find its way into the enrolment table.
So effectively, the Web Enrolment class accepts data from a web user and quarantines it until it is validated.
The properties of the Web Enrolment include:
  • Occu_ID, a reference to the... more 
 
Class containing the results of a web waitlist entry.  
 
Models a Web Client.
A web client is a client involved in a web enrolment. There is a distinction between this and a normal client to allow various checks to be made before data is integrated with that of normal clients in the VETtrak database.
Clients, who enrol via a Client Web Enrolment, and employees, who enrol via an Employer Web Enrolment, are both modelled by this class.
The properties of the web client class mainly relate to various contact details.
If the TWecl models a client linked to a client web enrolment, the Webe_ID property is non zero, and... more 
 
Models a Web Company (Web Employer).
A web company is a company or employer involved in a web enrolment. There is a distinction between this and a normal enrolment to allow various checks to be made before data is integrated with that of normal enrolments in the VETtrak database.
Assuming it passes the checks, data in the web company table will eventually find its way into the employer table.
So effectively, the Web Company class accepts data from a web user and quarantines it until it is validated.
The properties of the Web Company include:
  • Webe_ID, a reference to the... more 
 
Represents one valid value for a field. Also contains a description of what the value means.  
 
VETtrak API Web Services.
This ASP.NET (ASMX) web service exposes all available VETtrak API methods. It combines the previously separate Enrol (VT_API_Enrol.asmx), Portals (VT_API_Portals.asmx) and Integrate (VT_API_Integrate.asmx) API web services into a single web service, VT_API.asmx. This API requires a registration for the "API Functions" feature to operate.
This API can be used to integrate online enrolment systems, online student/employer/staff portals, and online learning systems, with VETtrak.
Before using the API for the first time:
  • Change the settings in the web.config file to configure the API to connect to your VETtrak database.
  • Ensure the registration key in your database contains... more 
Copyright (c) OzSoft Solutions 2016. All rights reserved.