VETtrak Integrate API Features
Here are the features currently available in the Integrate 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 Integrate API Service Description from OzSoft.
- API_Handshake: Checks the connection to the API
- AddClientAfterCheck: Checks whether a client with the specified surname, given name and date of birth exists, and adds it if it doesn't exist
- AddLMSClientEnrolmentToOccurrence: Enrols the client with the specified code into the LMS-enabled occurrence with the specified ID
- DB_Handshake: Checks the connection to the VETtrak database via the API
- DoesUsernamePasswordExist: Checks whether the specified username and password is valid
- GetAPIVersion: Gets the version of the API
- 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
- GetCourses: Gets a list of all courses
- 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
- 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
- GetLanguageList: Gets a list of all languages
- GetLocations: 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 types
- GetProgrammes: Gets a list of all programmes
- GetQualificationAndCourses: Gets a list of all qualifications and courses
- GetQualifications: Gets a list of all qualifications
- GetResultTypes: Gets a list of all result types
- GetRooms: Gets a list of all rooms
- GetSchoolLevelList: Gets a list of all school levels
- GetStateList: Gets a list of all Australian states
- GetUnitsForEnrolment: Gets a list of units for the enrolment with the specified ID
- 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
- SearchForSurname: Gets a list of clients with the a surname containing the specified search string, up to the specified maximum number of clients
- UpdateClientUsernamePassword: Updates the username and password of the client with the specified code to the username and password specified
- 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
- UpdateResult: Updates the result for the specified client enrolment ID and unit code to the result details specified
- ValidateClient: Validates an client's login and returns a token
- ValidateEmployer: Validates an employer's login and returns a token
- ValidateUser: Validates a login and returns a token