VT_API
The following operations are supported. For a formal definition, please review the Service Description.
-
API_Handshake
Checks the connection to the API -
AddAward
Creates a new award for a client's enrolment -
AddClassesToWebEnrolment
Records the specified classes against the existing web enrolment ID -
AddClient
Creates a new client with the specified surname and given name -
AddClientAfterCheck
Checks whether a client with the specified surname, given name and date of birth exists, and adds it if it doesn't exist -
AddClientEvent
Adds a new client event -
AddClientRelationship
Adds a relationship for a client -
AddClientWebEnrolment
Enrols a client with the specified details into a new web enrolment linked to the specified occurrence ID -
AddClientWebReservation
Reserves a client with the specified details into the specified occurrence ID -
AddClientWebWaitlist
Adds a client to a waitlist for a programme -
AddContactToEmployer
Attaches an existing client as a new contact for an employer -
AddEmployeeEnrolmentToBooking
Enrols the employee with the specified code into the booking or employer enrolment with the specified ID -
AddEmployer
Creates a new employer with the specified name -
AddEmployerEvent
Adds a new employer event -
AddEmployerWebEnrolment
Enrols an employer with the specified details into a new web enrolment linked to the specified occurrence ID. Employees could then be added to this web enrolment -
AddEmployerWebReservation
Reserves an employer with the specified details into the specified occurrence ID. Employees could then be added to this web reservation -
AddLMSClientEnrolmentToOccurrence
Enrols the client with the specified code into the LMS-enabled occurrence with the specified ID -
AddLooseWebEmployer
Creates a 'Loose' employer with the specified details for further use -
AddPosition
Creates a new position -
AddPriceTypesToWebEnrolment
Records the specified pricing items and amounts against the existing web enrolment ID -
AddSkillToClient
Adds a skill to a client -
AddUnitsToEnrolment
Adds the specified units to the existing occurrence enrolment ID -
AddUnitsToWebEnrolment
Records the specified units against the existing web enrolment ID -
AddWebClientRelationship
Adds a relationship for a web client -
AddWebEmployee
Enrols an employee with the specified details into an existing employer web enrolment with the specified web enrolment ID -
AddWebEmployerContact
Adds an employer contact with the specified details to an existing employer web enrolment with the specified web enrolment ID -
AddWebInvoice
Records an invoice against the existing web enrolment ID -
AddWebPayment
Records the specified payment data against the existing web enrolment ID -
AddWebPaymentPlan
Records the specified payment plan data against the existing web enrolment ID -
AssignWebEmployerToWebClient
Assigns a web employer as the employer for a client in a web enrolment -
AssignWebEmployerToWebWaitlist
Assigns a web employer as the employer for a client in a web waitlist entry -
CheckPasswordValidity
Checks whether a proposed new password meets VETtrak's password policy requirements -
CompleteWebReservation
Completes a client or employer reservation to make it available for processing, and automatically processes it if the occurrence is configured to do so -
DB_Handshake
Checks the connection to the VETtrak database via the API -
DeleteClientWebWaitlist
Deletes the web waitlist with the specified ID -
DeleteLooseWebEmployer
Deletes a 'Loose' employer with the specified ID -
DeleteUnitsFromEnrolment
Deletes the specified units from the existing enrolment ID -
DeleteWebEnrolment
Deletes the web enrolment with the specified ID -
DoesUsernamePasswordExist
Checks whether the specified username and password is valid -
ExtensionGenerateClientFromWebClient
Used by the web enrolment processing extension only. Use ProcessWebEnrolment instead -
ExtensionGenerateEmployerFromWebCompany
Used by the web enrolment processing extension only. Use ProcessWebEnrolment instead -
ExtensionUpdateClientFromWebClient
Used by the web enrolment processing extension only. Use ProcessWebEnrolment instead -
ExtensionUpdateEmployerFromWebCompany
Used by the web enrolment processing extension only. Use ProcessWebEnrolment instead -
GetAPIVersion
Gets the version of the API -
GetAPIVersionComponents
Gets the versions of the API in separate properties -
GetAccessibleClients
Gets a list of clients that a user can access -
GetAccessibleDivisionsTree
Gets the division tree structure that a user can access -
GetAdditionalDataEntityNames
Gets a list of all entities currently supported by the additional data functions -
GetAdditionalDataFieldsForEntity
Gets a list of all fields available to be set for an entity -
GetAdditionalDataForWebRecord
Retrieves the additional data field for a web client, employer, employee, contact or waitlisted client -
GetAnzsicList
Gets a list of active ANZSIC codes -
GetAttendanceForClientClass
Gets the attendance details for a client in a class (instance) -
GetAttendanceTypes
Gets a list of all attendence types -
GetAwardTypes
Gets a list of all active award types -
GetAwardsForClient
Gets a list of awards for the client with the specified code -
GetAwardsModifiedSince
Gets a list of awards created or modified since the specified date -
GetBookingDetails
Gets the booking details for an occurrence with the specified ID -
GetBookingsForEmployer
Gets a list of private corporate bookings for an employer overlapping a date range -
GetClassesForClient
Gets a list of classes (instances) for the client with the specified code in the specified date range -
GetClassesForOccurrence
Gets a list of classes (instances) within the occurrence with the specified ID -
GetClassesForStaff
Gets a list of classes (instances) assigned to the staff member with the specified client code in a date range -
GetClientAVDetails
Gets the AVETMISS details for the client with the specified code -
GetClientByCode
Gets the client with the specified code -
GetClientByEmail
Gets the client with the specified email address -
GetClientByName
Gets the client with the specified surname, given name and date of birth -
GetClientDetails
Gets the details for the client with the specified code -
GetClientEmploymentHistory
Gets a list of employers associated with a client -
GetClientExtendedDetails
Gets the extended details for a client with the specified code -
GetClientRelationships
Gets a list of relationships for a client -
GetClientStaffTypes
Gets a list of staff types of a particular client -
GetClientsForClass
Gets a list of clients enrolled in the class (instance) with the specified ID -
GetClientsForDivision
Gets a list of clients that are assigned to a division -
GetClientsForHostEmployer
Gets a list of clients whose latest placement is with the employer with the specified ID -
GetClientsForStaff
Gets a list of clients associated with a staff member in various ways -
GetContractsForClient
Gets a list of contracts for the client with the specified code -
GetContractsForStaff
Gets a list of trainees and their contracts assigned to the staff member with the specified client code -
GetContractsOrEnrolmentsForClient
Gets a list of contracts and enrolments for the client with the specified code -
GetCountryList
Gets a list of active countries -
GetCourses
Gets a list of all courses -
GetDeletedRecordsSince
Gets a list of the identifiers of all records deleted from a table since a date -
GetDisabilityList
Gets a list of all disabilities -
GetDivision
Gets a single division by ID -
GetDivisionAncestors
Gets the ancestors of a division by ID -
GetDivisionTree
Gets the division tree structure starting from the specified division ID -
GetDivisions
Gets a list of all divisions -
GetEducationHistory
Gets the education history recorded for a client -
GetEmployeeEnrolmentsForEmployerEnrolment
Gets a list of client enrolments for employees enrolled for an employer in an occurrence or booking -
GetEmployeesForEmployer
Gets a list of employees (active and/or inactive) for the employer with the specified ID -
GetEmployerAncestors
Gets the ancestors of an employer by ID -
GetEmployerContactDetails
Gets a list of all contacts for the employer with the specified ID -
GetEmployerDetails
Gets the details for the employer with the specified ID -
GetEmployerTree
Gets the employer tree structure starting from the specified employer identifier -
GetEmployerTypeList
Gets a list of all employer types -
GetEmployersForClient
Gets a list of employers associated with a client -
GetEmployersForParentEmployer
Gets a list of employers attached to the parent employer with the specified ID -
GetEmploymentCategoryList
Gets a list of all employment categories -
GetEnrolledTasksForClient
Retrieves a list of enrolled tasks for a client from all their enrolments -
GetEnrolledTasksForEnrolledUnit
Retrieves a list of enrolled tasks linked to an enrolled unit -
GetEnrolledTasksForEnrolment
Retrieves a list of task enrolments for an enrolment -
GetEnrolledTasksForOccurrence
Retrieves a list of enrolled tasks for all enrolments in an occurrence -
GetEnrolledUnitsForEnrolledTask
Retrieves a list of enrolled units linked to an enrolled task -
GetEnrolmentsForClient
Gets a list of non-contract enrolments for the client with the specified code -
GetEnrolmentsForOccurrence
Gets a list of client enrolments in the occurrence with the specified ID -
GetEnrolmentsForStaff
Gets a list of enrolments linked to the staff member with the specified client code in a date range -
GetEventTypes
Gets a list of all event types -
GetEventsForClient
Gets a list of events for the client with the specified code in a date range -
GetEventsForEmployer
Gets a list of events for the employer with the specified ID in a date range -
GetEventsForStaff
Gets a list of client and employer events where the staff member with the specified client code has a role in a date range -
GetInvoice
Retrieves a single invoice by ID -
GetInvoices
Retrieves a list of invoices matching specified criteria -
GetInvoicesForClient
Retrieves a list of invoices made out to a client -
GetInvoicesForEmployer
Retrieves a list of invoices made out to an employer -
GetInvoicesModifiedSince
Retrieves a list of invoices that have been modified since a date -
GetLMSNewEnrolmentsForOccurrence
Gets a list of enrolments for the LMS-enabled occurrence with the specified ID that have not yet been sent to the LMS -
GetLMSNewOccurrences
Gets a list of occurrences that have been flagged for LMS but have not yet been sent to the LMS -
GetLMSOccurrencesInDateRange
Gets a list of occurrences that have been flagged for LMS within the specified date range -
GetLMSOccurrencesSince
Gets a list of occurrences that have been flagged for LMS that have been added or modified since a date -
GetLanguageList
Gets a list of active languages -
GetLocations
Gets a list of all locations -
GetLooseWebEmployer
Retrieves a 'Loose' employer with the specified ID -
GetOccurrenceDetails
Gets the details for an occurrence with the specified ID -
GetOccurrenceExtendedDetails
Gets the extended details for an occurrence with the specified ID -
GetOccurrencesForEmployer
Gets a list of occurrences overlapping a date range that an employer is enrolled in -
GetOccurrencesForStaff
Gets a list of occurrences that a staff member is associated with in various ways -
GetOrganisations
Gets a list of all Organisations -
GetPasswordPolicy
Gets the password policy settings configured in VETtrak -
GetPaymentTypes
Gets a list of Payment Types valid for online payment -
GetPaymentsForInvoice
Gets the payments that have been recorded against an invoice -
GetPositions
Gets a list of all positions -
GetPricingForOccurrence
Gets a list of prices in the occurrence with the specified ID -
GetPriorEducationList
Gets a list of all prior education items -
GetPriorEducationRecognitionList
Gets a list of all prior education achievement recognition identifier items -
GetProgrammeTypeList
Gets a list of all programme types -
GetProgrammes
Gets a list of all programmes -
GetQualificationAndCourses
Gets a list of all qualifications and courses -
GetQualificationStateDetails
Gets the state-based details for a qualification or course -
GetQualifications
Gets a list of all qualifications -
GetReferralSources
Gets a list of all referral sources -
GetRegions
Gets a list of all regions -
GetRelationshipTypes
Gets a list of relationship types -
GetResultTypes
Gets a list of all result types -
GetRooms
Gets a list of all rooms -
GetSMSStatus
Gets the status of the SMS service - whether the SMS service has been activated for this business, and if so, the current message balance -
GetSchoolLevelList
Gets a list of all school levels -
GetSkills
Gets a list of all skill definitions -
GetSkillsForClient
Gets a list of skills for a client -
GetStaff
Gets a list of all staff members -
GetStaffExtendedDetails
Gets the extended details for a staff member with the specified code -
GetStaffForClient
Gets a list of staff members associated with a client in various ways -
GetStaffForOccurrence
Gets a list of staff members associated with an occurrence in various ways -
GetStaffForType
Gets a list of staff members of a particular type -
GetStaffTypes
Gets a list of all staff types -
GetStateList
Gets a list of all Australian states -
GetStudyReasonsForOccurrence
Gets a list of study reasons applicable to an occurrence -
GetStudyReasonsForState
Gets a list of study reasons applicable to an Australian state -
GetSuburbList
Gets a list of suburbs, optionally for a state and/or that have been modified since a date -
GetTaskStatuses
Retrieves a list of all task statuses -
GetTasks
Retrieves a list of all task definitions -
GetTasksForClient
Retrieves a list of tasks for a client from all their active enrolments -
GetTasksForOccurrence
Retrieves a list of tasks for an occurrence -
GetTraineeEventsForStaff
Gets a list of events against any trainees assigned to the staff member with the specified client code in a date range -
GetTraineesAndEmployeesForEmployer
Gets a list of trainees (optionally with only active contracts) and employees (active and/or inactive) for the employer with the specified ID -
GetTraineesForEmployer
Gets a list of trainees (optionally with only active contracts) for the employer with the specified ID -
GetUnitDetails
Gets the details of a single unit by code -
GetUnitStateDetails
Gets the state-based details for a unit or module -
GetUnitsForClass
Gets a list of units within a class (instance) -
GetUnitsForContract
Gets a list of units for the contract with the specified ID -
GetUnitsForEnrolment
Gets a list of units for the enrolment with the specified ID -
GetUnitsForEnrolmentIncludingLinked
Gets a list of units for the enrolment with the specified ID, including linked units -
GetUnitsForOccurrence
Gets a list of units within the occurrence with the specified ID -
GetUnitsForQualification
Gets a list of units for the qualification or course with the specified code -
GetVicCommencingProgramCohortList
Gets a list of all VIC Commencing Program Cohort Identifiers -
GetVisaTypeList
Gets a list of all Visa Types -
GetWaitlistProgrammeTypes
Gets a list of all programme types that contain at least one waitlistable programme -
GetWaitlistProgrammes
Gets a list of all waitlistable programmes -
GetWaitlistProgrammesForType
Gets a list of waitlistable programmes of a particular programme type -
GetWebClientsForOccurrence
Gets a list of web clients enrolled in all web enrolments against the specified occurrence ID -
GetWebEmployeesForEmployerEnrolment
Gets a list of employees enrolled in an employer web enrolments with the specified web enrolment ID -
GetWebEmployeesForOccurrence
Gets a list of web employees enrolled in all employer web enrolments against the specified occurrence ID -
GetWebEmployersForOccurrence
Gets a list of employers enrolled in all web enrolments against the specified occurrence ID -
GetWebEnrolment
Gets the details of the web enrolment with the specified ID -
GetWebEnrolmentsSince
Gets a list of web enrolments since the specified Date -
GetWebLocationsForProgrammeAndDates
Gets a list of locations with a web-enabled occurrence in the specified programme and/or date range that has available places -
GetWebOccurrences
Gets a list of all web-enabled occurrences that have available places -
GetWebOccurrencesForDates
Gets a list of web-enabled occurrences within the specified date range that have available places -
GetWebOccurrencesForProgramme
Gets a list of web-enabled occurrences with the programme ID specified that have available places -
GetWebOccurrencesForProgrammeAndDates
Gets a list of web-enabled occurrences within the specified date range and with the specified programme ID that have available places -
GetWebOccurrencesForProgrammeAndDatesSince
Gets a list of web-enabled occurrences within the specified date range and with the specified programme ID that have available places -
GetWebOccurrencesOverlappingDateRange
Gets a list of web-enabled occurrences within the specified date range -
GetWebOccurrencesOverlappingDateRangeForProgramme
Gets a list of web-enabled occurrences within the specified date range for the specified programme -
GetWebProgrammeTypes
Gets a list of programme types with a web-enabled occurrence that has available places -
GetWebProgrammeTypesForDates
Gets a list of programme types with a web-enabled occurrence in the specified date range that has available places -
GetWebProgrammes
Gets a list of programmes with a web-enabled occurrence that has available places -
GetWebProgrammesForDates
Gets a list of programmes with a web-enabled occurrence in the specified date range that has available places -
GetWebProgrammesForDatesSince
Gets a list of programmes that have been created or modified since a date and have a web-enabled occurrence in the specified date range that has available places -
GetWebProgrammesForProgType
Gets a list of programmes of the specified programme type with a web-enabled occurrence that has available places -
GetWebProgrammesForProgTypeAndDates
Gets a list of programmes of the specified programme type with a web-enabled occurrence in the specified date range that has available places -
GetWebRegionsForProgrammeAndDates
Gets a list of regions with a web-enabled occurrence in the specified programme and/or date range that has available places -
GetWebWaitlist
Retrieves a web waitlist entry with the specified ID -
IsEnrolmentComplete
Checks whether an enrolment is complete -
ProcessWebEnrolment
Processes a web enrolment with the specified ID, to turn it into a real enrolment -
ProcessWebWaitlist
Processes a web waitlist with the specified ID, to turn it into a real waitlist entry -
QueryAdditionalData
Generic function for getting VETtrak data -
RecordPaymentForInvoice
Records a payment against an existing invoice -
RemoveContactFromEmployer
Removes a contact from an employer -
ResetUnitResult
Resets an enrolment unit result -
SearchForEmployer
Gets a list of employers with a name matching the specified search string, optionally since a date -
SearchForSurname
Gets a list of clients with a surname containing the specified search string, up to the specified maximum number of clients -
SearchWebOccurrences
Searches for web-published occurrences with available places -
SendSMSMessageToNumber
Sends an SMS text message to a mobile number, using the VETtrak SMS service -
SendSMSMessages
Sends an SMS text message to a number of clients or mobile numbers, using the VETtrak SMS service -
TriggerPortalPasswordReset
Triggers a password reset for a user via a VETtrak web portal -
UpdateAdditionalDataForWebRecord
Updates the additional data field for a web client, employer, employee, contact or waitlisted client -
UpdateAttendanceForClientClass
Adds or updates the attendance details for a client in a class (instance) -
UpdateClientAVDetails
Updates the AVETMISS data for a client to that specified -
UpdateClientAdditionalFields
Updates additional fields for a client -
UpdateClientDetails
Updates a client with the information specified -
UpdateClientEvent
Updates a client event -
UpdateClientRelationship
Updates a relationship for a client -
UpdateClientSkill
Updates a skill for a client -
UpdateClientStaffTypes
Update a client's staff types -
UpdateClientTasks
Updates all enrolments that a client has in a task -
UpdateClientUsernamePassword
Updates the username and password of the client with the specified code to the username and password specified -
UpdateClientWebWaitlist
Records the specified additional data against the client linked to the specified web waitlist ID -
UpdateClientWebWaitlistAVETMISS
Records the specified AVETMISS data against the client linked to the specified web waitlist ID -
UpdateConfig
Updates a configuration setting -
UpdateEmployerAdditionalFields
Updates additional fields for an employer -
UpdateEmployerContactPrimary
Updates the primary contact flag for the contact with the specified client code and employer ID to that specified -
UpdateEmployerDetails
Updates an employer with the information specified -
UpdateEmployerEvent
Updates an employer event -
UpdateEnrolledTask
Records a result for a single enrolled task -
UpdateEnrolment
Updates certain parameters on an enrolment -
UpdateLMSEnrolmentStatus
Updates whether or not the enrolment with the specified ID, in a LMS-enabled occurrence, has been sent to the LMS -
UpdateLMSOccurrenceStatus
Updates whether or not the LMS occurrence with the specified ID has been sent to the LMS -
UpdateLooseWebEmployer
Records the specified additional data against a loose employer -
UpdateResult
Updates the result for the specified enrolment ID and unit code to the result details specified -
UpdateResultComment
Updates the enrolled unit comment for the specified enrolment ID and unit code -
UpdateResultIncludingLinked
Updates the result for the specified enrolment ID and unit code to the result details specified, including linked units -
UpdateWebClient
Records the specified additional data against the client linked to the specified web enrolment ID -
UpdateWebClientAVETMISS
Records the specified AVETMISS data against the client linked to the specified web enrolment ID -
UpdateWebEmployee
Records the specified additional data against the existing enrolled employee specified by the web client ID -
UpdateWebEmployeeAVETMISS
Records the specified additional AVETMISS data against the existing enrolled employee specified by the web client ID -
UpdateWebEmployer
Records the specified additional data against the employer linked to the specified web enrolment ID -
UpdateWebEmployerContact
Records the specified additional data against the existing employer contact specified by the web client ID -
UpdateWebEnrolment
Updates the details of the specified web enrolment ID -
VETenrolDirectLogin
For use by VETenrol only -
VETenrolLogin
For use by VETenrol only -
ValidateClient
Validates an client's login and returns a token -
ValidateUSI
Validates a USI -
ValidateUser
Validates a login and returns a token -
VerifyAward
Verifies the existence of an award and returns its details