Contacts
JWGecko02 8596 7600
Ozsoft03 6333 0166
Websitewww.ozsoft.com.au
Quick Enquiry




Facebook Twitter

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.

  1. API_Handshake: Checks the connection to the API
  2. AddClientWebEnrolment: Enrols a client with the specified details into a new web enrolment linked to the specified occurrence ID
  3. 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
  4. AddWebEmployee: Enrols an employee with the specified details into an existing employer web enrolment with the specified web enrolment ID
  5. AddWebEmployerContact: Adds an employer contact with the specified details to an existing employer web enrolment with the specified web enrolment ID
  6. AddWebPayment: Records the specified payment data against the existing web enrolment ID
  7. DB_Handshake: Checks the connection to the VETtrak database via the API
  8. DeleteWebEnrolment: Deletes the web enrolment with the specified ID
  9. DoesUsernamePasswordExist: Checks whether the specified username and password is valid
  10. GetAPIVersion: Gets the version of the API
  11. GetBookingsForOccurrence: Gets a list of bookings in the occurrence with the specified ID
  12. GetClassesForOccurrence: Gets a list of classes (instances) within the occurrence with the specified ID
  13. GetClientByCode: Gets the client with the specified code
  14. GetClientByName: Gets the client with the specified surname, given name and date of birth
  15. GetClientDetails: Gets the details for the client with the specified code
  16. GetCountryList: Gets a list of all countries
  17. GetDisabilityList: Gets a list of all disabilities
  18. GetEmploymentCategoryList: Gets a list of all employment categories
  19. GetEnrolmentsForOccurrence: Gets a list of client enrolments in the occurrence with the specified ID
  20. GetLanguageList: Gets a list of all languagesGetLocations: Gets a list of all locations
  21. GetOccurrenceDetails: Gets the details for an occurrence with the specified ID
  22. GetPricingForOccurrence: Gets a list of prices in the occurrence with the specified ID
  23. GetPriorEducationList: Gets a list of all prior education items
  24. GetProgrammeTypeList: Gets a list of all programme typesGetProgrammes: Gets a list of all programmes
  25. GetRooms: Gets a list of all rooms
  26. GetSchoolLevelList: Gets a list of all school levels
  27. GetStateList: Gets a list of all Australian states
  28. GetUnitsForClass: Gets a list of units within a class (instance)
  29. GetUnitsForOccurrence: Gets a list of units within the occurrence with the specified ID
  30. GetWebClientsForOccurrence: Gets a list of web clients enrolled in all web enrolments against the specified occurrence ID
  31. GetWebEmployeesForEmployerEnrolment: Gets a list of employees enrolled in an employer web enrolments with the specified web enrolment ID
  32. GetWebEmployeesForOccurrence: Gets a list of web employees enrolled in all employer web enrolments against the specified occurrence ID
  33. GetWebEmployersForOccurrence: Gets a list of employers enrolled in all web enrolments against the specified occurrence ID
  34. GetWebEnrolment: Gets the details of the web enrolment with the specified ID
  35. GetWebOccurrences: Gets a list of all web-enabled occurrences that have available places
  36. GetWebOccurrencesForDates: Gets a list of web-enabled occurrences within the specified date range that have available places
  37. GetWebOccurrencesForProgramme: Gets a list of web-enabled occurrences with the programme ID specified that have available places
  38. GetWebOccurrencesForProgrammeAndDates: Gets a list of web-enabled occurrences within the specified date range and with the specified programme ID that have available places
  39. GetWebOccurrencesOverlappingDateRange: Gets a list of web-enabled occurrences within the specified date range
  40. GetWebProgrammeTypes: Gets a list of programme types with a web-enabled occurrence that has available places
  41. GetWebProgrammeTypesForDates: Gets a list of programme types with a web-enabled occurrence in the specified date range that has available places
  42. GetWebProgrammes: Gets a list of programmes with a web-enabled occurrence that has available places
  43. GetWebProgrammesForDates: Gets a list of programmes with a web-enabled occurrence in the specified date range that has available places
  44. GetWebProgrammesForProgType: Gets a list of programmes of the specified programme type with a web-enabled occurrence that has available places
  45. 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
  46. SearchForSurname: Gets a list of clients with the a surname containing the specified search string, up to the specified maximum number of clients
  47. UpdateWebClient: Records the specified additional data against the client linked to the specified web enrolment ID
  48. UpdateWebClientAVETMISS: Records the specified AVETMISS data against the client linked to the specified web enrolment ID
  49. UpdateWebEmployee: Records the specified additional data against the existing enrolled employee specified by the web client ID
  50. UpdateWebEmployeeAVETMISS: Records the specified additional AVETMISS data against the existing enrolled employee specified by the web client ID
  51. UpdateWebEmployer: Records the specified additional data against the employer linked to the specified web enrolment ID
  52. UpdateWebEmployerContact: Records the specified additional data against the existing employer contact specified by the web client ID
  53. UpdateWebEnrolment: Records the specified additional data against an existing web enrolment ID
  54. 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
  55. ValidateEmployer: Validates an employer's login and returns a token
  56. ValidateUser: Validates a login and returns a token