VETtrak Enrolment API Features
Here are the features currently available in the Enrolment API. These may change without notice. This information is provided as a guide only and should not be relied upon when purchasing an API or a VETtrak Online product.
The following operations are supported. For a formal definition, please review the Enrolment API Service Description from OzSoft.
- API_Handshake: Checks the connection to the API
- AddClientWebEnrolment: Enrols a client with the specified details into a new web enrolment linked to the specified occurrence ID
- 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
- 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
- AddWebPayment: Records the specified payment data against the existing web enrolment ID
- DB_Handshake: Checks the connection to the VETtrak database via the API
- DeleteWebEnrolment: Deletes the web enrolment with the specified ID
- DoesUsernamePasswordExist: Checks whether the specified username and password is valid
- GetAPIVersion: Gets the version of the API
- GetBookingsForOccurrence: Gets a list of bookings in the occurrence with the specified ID
- GetClassesForOccurrence: Gets a list of classes (instances) within the occurrence with the specified ID
- GetClientByCode: Gets the client with the specified code
- 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
- GetCountryList: Gets a list of all countries
- GetDisabilityList: Gets a list of all disabilities
- GetEmploymentCategoryList: Gets a list of all employment categories
- GetEnrolmentsForOccurrence: Gets a list of client enrolments in the occurrence with the specified ID
- GetLanguageList: Gets a list of all languagesGetLocations: Gets a list of all locations
- GetOccurrenceDetails: Gets the details for an occurrence with the specified ID
- GetPricingForOccurrence: Gets a list of prices in the occurrence with the specified ID
- GetPriorEducationList: Gets a list of all prior education items
- GetProgrammeTypeList: Gets a list of all programme typesGetProgrammes: Gets a list of all programmes
- GetRooms: Gets a list of all rooms
- GetSchoolLevelList: Gets a list of all school levels
- GetStateList: Gets a list of all Australian states
- GetUnitsForClass: Gets a list of units within a class (instance)
- GetUnitsForOccurrence: Gets a list of units within the occurrence with the specified ID
- 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
- 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
- GetWebOccurrencesOverlappingDateRange: Gets a list of web-enabled occurrences within the specified date range
- 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
- 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
- SearchForSurname: Gets a list of clients with the a surname containing the specified search string, up to the specified maximum number of clients
- 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: Records the specified additional data against an existing web enrolment ID
- ValidateClient: Validates an client's login and returns a tokenValidateEmployer: Validates an employer's login and returns a tokenValidateUser: Validates a login and returns a token
- ValidateEmployer: Validates an employer's login and returns a token
- ValidateUser: Validates a login and returns a token