VETtrak Portal API Features
Here are the features currently available in the Portal 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 Portal API Service Description from OzSoft.
- API_Handshake: Checks the connection to the API
- AddClient: Creates a new client with the specified surname and given name
- 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
- GetAnzsicList: Gets a list of all ANZSIC codes
- GetAttendanceForClientClass: Gets the attendance details for a client in a class (instance)
- GetAttendanceTypes: Gets a list of all attendence types
- GetAwardsForClient: Gets a list of awards for the client with the specified code
- GetClassesForClient: Gets a list of classes (instances) for the client with the specified code in the specified date range
- 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
- GetClientDetails: Gets the details for the client with the specified code
- GetClientExtendedDetails: Gets the extended details for a client with the specified code
- GetClientsForClass: Gets a list of clients enrolled in the class (instance) with the specified ID
- GetClientsForHostEmployer: Gets a list of clients whose latest placement is with the employer with the specified ID
- 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 all countries
- GetDisabilityList: Gets a list of all disabilities
- GetEmployeesForEmployer: Gets a list of employees (active and/or inactive) for the employer with the specified 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
- GetEmployerTypeList: Gets a list of all employer types
- GetEmployersForParentEmployer: Gets a list of employers attached to the parent employer with the specified ID
- GetEmploymentCategoryList: Gets a list of all employment categories
- GetEnrolmentsForClient: Gets a list of enrolments for the client with the specified code
- GetEnrolmentsForStaff: Gets a list of enrolments linked to the staff member with the specified client code in a date range
- 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
- 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
- GetPositions: Gets a list of all positions
- GetPriorEducationList: Gets a list of all prior education items
- GetProgrammeTypeList: Gets a list of all programme types
- GetProgrammes: Gets a list of all programmes
- GetResultTypes: Gets a list of all result types
- GetRooms: Gets a list of all rooms
- GetSchoolLevelList: Gets a list of all school levels
- GetStaff: Gets a list of all staff members
- GetStaffExtendedDetails: Gets the extended details for a staff member with the specified code
- GetStateList: Gets a list of all Australian states
- 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
- 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
- GetVisaTypeList: Gets a list of all Visa Types
- 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
- UpdateClientAVFields: Updates the AVETMISS data for a client to that specified in individual fields
- UpdateClientDetails: Updates a client with the information specified
- UpdateClientEvent: Updates a client event
- UpdateClientFields: Updates a client with the information specified as individual fields
- UpdateClientUsernamePassword: Updates the username and password of the client with the specified code to the username and password specified
- 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
- UpdateEmployerFields: Updates an employer with the information specified as individual fields
- UpdateEmployerUsernamePassword: Updates the username and password of the employer with the specified ID to the username and password specified
- 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