URL Querystring Parameters for VETenrol

These parameters are added to the end of a VETenrol link to control various style options. The first parameter must be preceded by a question mark (?) and all subsequent parameters with an ampersand (&).

For example:

 

The following querystring parameters are applicable to your VETenrol:

 

ClientID
Indicates which organisation's VETenrol settings should be used.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO

IMPORTANT: The ClientID parameter is required for ALL links

 

altCSS
Applies an alternative style sheet (if it exists) changing the site layout. Typical branding during setup includes one alternative style that hides the Available courses list, with a second available by request. 

altCSSResult
(No altCSS paramter or altCSS= without a value.) Default style applied.
1Course specific branding. This style hides the Available Courses list.
2iFrame branding. This style hides almost all branding elements and leaves only the main content area.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&altCSS=1

 

uiSettings
Hides various design elements for the standard VETenrol main page and standard registration process according to the following table:

uiSettingResult
1Hide the company logo
2Hide the programme list
4Hide the Contact details
8Hide the Footer
16Hide the Navigation Bar
32Hide the Course description
64Hide the classes link for occurrences
128Hide the Units link for occurrences
256Hide the Vacancies for occurrences
512Hide the Start Date
1024Hide the breadcrumbs
2048Hide the enquiry form
4096Hide the Cost
8192Enable the Prior Enrol feature
16384Hide the Location (also requires OccuID to be specified)
32768Hide the Start Date (also requires OccuID to be specified)

Adding values together will hide multiple elements:

31Hides each of the uiSettings 1, 2, 4, 8, and 16.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&uiSettings=1

NOTE: Including uiSettings in your link will not automatically alter your existing VETenrol styling to account for the effects of the settings used. Some combinations may have unexpected results, including negatively impacting visual display, overall design and/or usability, particularly if key element(s) utilised by the existing branding are removed.
Please discuss issues with Support to see if your design can be adjusted to suit or consider requesting an altCSS to achieve your needs instead (fees may apply).

 

sap
Show all programmes. Requires either true or false, which is case-sensitive. Overrides the Administration setting.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&sap=false

 

sao
Show all occurrences. Requires either true or false, which is case-sensitive. Overrides the Administration setting.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&progID=13&sao=true

 

ProgID
Selects the programme(s) to display. Multiple IDs must be comma separated. Programme IDs are obtained through the Programmes menu item in the Client Administration.

If you would like to experiment with our demo site, the following progIDs are applicable:

progIDCourse Name
13Basic Computers
17Cert III Aged Care
84Cert II Open Cut
96First Aid Training
107Cert III Pathology

Example usage:

 

OccuID
Selects an Occurrence to display. Only a single Occurrence can be passed, and it cannot be used together with progID parameter. Occurrence IDs are obtained from VETtrak, or through the Programmes menu item in the Client Administration.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&occuID=2078

NOTE: The example link will not function since the OccuID is invalid. As our demo occurrences expire regularly it is not possible to provide an OccuID that will remain valid indefinitely.

 

PriceID
Selects the price type to use when registering in a specific occurrence. Price IDs are obtained through the Programmes menu item in the Client Administration.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&occuID=2078&priceID=16

NOTE: The example link will not function since the OccuID is invalid. As our demo occurrences expire regularly it is not possible to provide an OccuID that will remain valid indefinitely.

 

Group
Indicates if the registration should be for a group booking. Requires any value to be enabled (use of 1 or true recommended).

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&occuID=3398&group=1

NOTE: The occurrence must be published in VETtrak with employers allowed to enrol.

 

Bypass
This parameter is for use with the Close Dates feature and allows direct registration into an occurrence between the Registrations Close date and the course start date. The Bypass value must be the occurrence ID to register into.
Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&altCSS=1&bypass=3850 

NOTE: Bypass will function like the OccuID parameter for occurrences that have not yet closed.


Location
This parameter will limit the returned occurences to the specified location based on the location code. It can also be used in combination with a progID.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&location=ltn and https://enrol.vetenrol.com.au/?clientID=VT-DEMO&progID=96&location=ltn

NOTE: If your location code is numerical, you must include all leading zeros.


page
Redirects to non-standard page.

PageResult
calendar.aspxOpens the original calendar with the category view.
categoryview.aspxLists programmes grouped by their VETtrak programme type.
completeregistration.aspxAllow client data collection against an existing VETtrak enrolment. The eID parameter must also be supplied.
courses.aspxCourse list intended for iFrame implementations (also utilised by Rapid Registrations).
eligibility.aspxOpens an Eligibility form, but requires additional parameters to work.
enquiry.aspxOpens the Enquiry form.
history.aspxPresents a user's education history, if a match is found in VETtrak.
kalendar.aspxOpens the modern calendar with the course list.
register.aspxAlternative for registering in individual classes, rather than the default occurrence level registration.
registerRapid.aspxInvokes the Rapid Registration process. Requires the OccuID parameter.
schedule.aspxLists courses grouped by location (state/territory).
search.aspxOpens the Search page.


Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&page=calendar.aspx

NOTE: Rapid Registrations must be activated by VETtrak Pty Ltd for registerRapid.aspx to be available.

 

eID
This parameter is used in combination with the page parameter and is for passing a numerical value that may represent an Enrolment ID or an Eligibility Form ID, depending on the page.

If it is used with completeregistration.aspx, the numerical value is an Enrolment ID for a client's occurrence enrolment in VETtrak.

When used with eligibility.aspx, the parameter must specify an Eligibility Form ID, such as follows:

IDEligibility Form Name
1NSW Smart & Skilled.
2ACT Skilled Capital.
3Qld User Choice, Cert 3 Guarantee, Higher Level Skills.
4South Australia Work Ready.
5West Australia Future Skills.
6Victorian Skills First.


Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&page=eligibility.aspx&eID=1

 

yes & no
These parameters are for the Eligibility Calculator only. The link must include page, eID, and OccuID. Both yes and no parameters require a price ID number (representing the pricing item) to be used for an Eligibile (yes) or ineligibile (no) outcome.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&page=eligibility.aspx&eID=1&occuID=3395&yes=45&no=22

 

Rapid
This triggers the Rapid Registration process for the Schedule page.

Example: https://enrol.vetenrol.com.au/?clientID=VT-DEMO&page=schedule.aspx&rapid=1

 

txtGivenName, txtSurname, txtDOB
These parameters can be used to pre-fill the Given Name, Surname and Date of birth fields of the registration process.


See also: Registration Builder

 

txtUsername, txtClientCode
These parameters can be used to pre-fill the Returning Participant details. The option Allow "Easy" returning participant must be enabled to use txtClientCode, but cannot be used with txtUsername.


See also: Registration Settings: Personal Step

 

VerifyAward
This is for linking directly to the Award Verification Service. This functions slightly differently, in that this is a page with its own parameters, and not simply an additional parameter.

For example: https://enrol.vetenrol.com.au/VerifyAward?clientID=VT-DEMO
The Client ID in the link should be replaced with your own Client ID.


See also: Award Verification Service (section)

 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.