Support Centre Community Submit a Ticket
Welcome
Login  Sign up
  1. VETtrak
  2. Knowledge base
  3. VETtrak Integrations
  4. VETtrak API (VETtrak Web Connector)

VETtrak API Change Log - Versions 1.8.0 to 1.11.0 for VETtrak 4.4.4.x to 4.4.6.x

Ash Wayling
Modified on: Thu, 19 May, 2022 at 10:56 AM

This article contains detailed change logs describing the changes made in each of the following versions of the web connector:

VETtrak 4.4.6.x

Version 1.11.0.0 - April 1, 2016

Updates to reflect functionality introduced in VETtrak version 4.4.6. No breaking changes.

Adds limited support for specifying an Ezidebit payment plan for web enrolments.

When enrolling into an occurrence, occurrence events marked as "optional" are now not copied to the new enrolment, allowing the VETtrak user to control which particular occurrence events are copied to new enrolments and which are not.

Support for the new "addresses are overseas" and "address is not specified" tickboxes for a client address, when using UpdateClientDetails, or when processing a web enrolment with updates on. You don't set these directly - they will be set automatically if you specify the address appropriately as per NCVER rules:

  • For a "not specified" address, you should pass the following in the usual address:
    • Street number: "not specified"
    • Street name: "not specified"
    • City: "not specified"
    • State: empty
    • Postcode: "0000"
  • For an overseas address, you should pass the following in both the usual and postal addresses:
    • City: "not specified"
    • State: "Overseas"
    • Postcode: "OSPC"

Add functions

  1. AddWebPaymentPlan: Call this to specify that the enrolee wants to pay for the web enrolment in instalments through Ezidebit. Note that this only pre-populates a pending payment plan in VETtrak for the invoice generated when the web enrolment is processed. It still requires the VETtrak user to complete the setup for the payment plan in VETtrak after processing the web enrolment.

Modify classes

  1. TWebe
    1. Added fields
      1. PaymentPlanProvider: The provider for the payment plan for the web enrolment.
      2. PaymentPlanFrequency: The instalment payment frequency for the payment plan.
      3. PaymentPlanInstalmentAmount: The amount of each instalment payment for the payment plan.

Additional data field changes

These changes affect the QueryAdditionalData, GetAdditionalDataFieldsForEntity, GetAdditionalDataForWebRecord, UpdateAdditionalDataForWebRecord, UpdateClientAdditionalFields and UpdateEmployerAdditionalFields functions.

  1. New fields
    1. Client
      1. UsualAddressNotSpecified: Whether the client's usual address is not specified.
      2. OverseasAddresses: Whether the client's addresses are overseas.
      3. JobActiveEmployerId: ID of the employer who is the Job Active provider for this client.
      4. JobActiveEmployerName: Name of the employer who is the Job Active provider for this client.
      5. JobActiveConsultantClientCode: Client code of the Job Active consultant for this client.
      6. JobActiveConsultantGivenName: Given name of the Job Active consultant for this client.
      7. JobActiveConsultantSurname: Surname of the Job Active consultant for this client.
      8. JobActiveConsultantEmail: Email address of the Job Active consultant for this client.
      9. JobActiveSiteManagerClientCode: Client code of the Job Active site manager for this client.
      10. JobActiveSiteManagerGivenName: Given name of the Job Active site manager for this client.
      11. JobActiveSiteManagerSurname: Surname of the Job Active site manager for this client.
      12. JobActiveSiteManagerEmail: Email address of the Job Active site manager for this client.
      13. JobActiveCurrentFlag: Whether the Job Active details for this client are current.

VETrak 4.4.5.x

Version 1.10.0.0 - January 15, 2016

Updates to reflect functionality introduced in VETtrak version 4.4.5. No breaking changes.

Supports new VIC 2016 reportable fields when enrolling in occurrences, including calculation of the Program Unique Supervised Hours (PUSH) from units, or classes and events, in the new enrolment if specified in the occurrence.

Supports automatic setting of VET FEE-HELP Unit of Study completion statuses when recording a result in a related enrolled unit, if VETtrak is set up to do so.

Modify classes

  1. TEnun
    1. Added fields
      1. AssessmentStatus: The assessment status of the result for this enrolled unit (assessed, not assessed, RPL, CT).
      2. Percentage: The result percentage recorded for this enrolled unit.

Additional data field changes

These changes affect the QueryAdditionalData, GetAdditionalDataFieldsForEntity, GetAdditionalDataForWebRecord, UpdateAdditionalDataForWebRecord, UpdateClientAdditionalFields and UpdateEmployerAdditionalFields functions.

  1. New fields
    1. Client
      1. MobilePhone2: The client's secondary mobile phone number.
      2. SMSBothMobiles: Whether to send SMS to both the client's mobile phone numbers.
      3. Email2: The client's secondary email address.
      4. EmailBothAddresses: Whether to send email to both the client's email addresses.

Bug fixes

  1. Fixed an error message that could occur when calling GetAwardTypes in SQL Server, where an award type had no description.

Version 1.9.0.1 - October 30, 2015

Small updates to reflect functionality introduced in VETtrak version 4.4.4.1. No breaking changes.

Password generation for new clients has been changed to never include characters that may be confused: zero, one, upper and lower-case letter O, lower-case letter L, and upper-case letter I.

Generation of invoice item descriptions from merge templates now supports templates with the new "any context" merge context.

Support for enrolling in occurrences with occurrence events. If the new "Add all occurrence events to new enrolments" preference is turned on in VETtrak, all events from the occurrence will be copied into new client enrolments made in the occurrence.

Add functions

  1. IsEnrolmentComplete: Indicates whether all the units in the specified enrolment are successfully completed. This is intended to be used in conjunction with the new AddAward function if you need to check that all units are complete before recording an award.
  2. GetAwardTypes: Returns a list of active award types. This is intended to be used in conjunction with the new AddAward function.
  3. AddAward: Records a new client award for an enrolment, with the ability to generate a parchment number and expiry date or override them.

VETtrak 4.4.4.x

Version 1.9.0.0 - September 1, 2015

Small update to suit a VETtrak 4.4.4 database. No breaking changes.

Generated invoice numbers for processed web enrolments will now follow the new generation rules configured in VETtrak.

Support for changes to the FinPa LMS add-on, allowing a VETtrak unit to be mapped to multiple FinPa courses.

Modify functions

  1. GetStudyReasonsForState: You can now specify a state of an empty string or "NAT" to get a list of nationally-reportable study reasons.
  2. GetStudyReasonsForOccurrence: This function will now correctly return the list of national study reasons if the occurrence is nationally reportable.
  3. UpdateAttendanceForClientClass: Added description parameter, allowing you to optionally record notes for the attendance.
  4. RecordPaymentForInvoice: Added externalIdentifier parameter, allowing you to optionally set an external number for the new payment.

Modify classes

  1. TAtte
    1. Added fields
      1. Description: Any notes recorded for the attendance.
  2. TOccu
    1. Added fields
      1. Colour: The hexadecimal RGB colour for the occurrence.
  3. TInvoiceItem
    1. Added fields
      1. LedgerCode: The code of the ledger for the invoice item.
      2. LedgerName: The name of the ledger for the invoice item.
  4. TPayment
    1. Added fields
      1. ExternalIdentifier: The external number for the payment.

Additional data field changes

These changes affect the QueryAdditionalData, GetAdditionalDataFieldsForEntity, GetAdditionalDataForWebRecord, UpdateAdditionalDataForWebRecord, UpdateClientAdditionalFields and UpdateEmployerAdditionalFields functions.

  1. New fields
    1. Enrolment
      1. ProgrammeId: The internal identifier of the programme the occurrence is in.

Bug fixes

  1. Fixed an issue causing the "combine invoices" flag in AddWebInvoice to not work correctly.
  2. Fixed a performance issue when generating client codes when existing client IDs and codes are a long way out of sync.

VETtrak Version 4.4.3.x

Version 1.8.0.1 - March 6, 2015

Small update with some fixes. No changes to any function signatures.

  1. Fixed a bug with the auto-link enrolments setting not applying when creating an enrolment.
  2. Will now attempt to load custom query fields from a CustomDatabaseMapping.xml file, if it exists, to avoid having to put custom field definitions in the DatabaseMapping.xml file.

Version 1.8.0.0 - December 24, 2014

Upgraded API to work with a VETtrak 4.4.3 database.

Significant changes have been made to pricing-related functionality that will affect existing websites. In VETtrak 4.4.3, enrolments/occurrences can now have pricing items per-unit, and inventory item prices, as well as pricing items against the whole enrolment/occurrence as was the only possibility in VETtrak 4.4.2. Any of these prices may be web published and included in web enrolments. It is also now possible for a pricing item type (the same Pric_ID) to appear on the same occurrence/enrolment multiple times. GetPricingForOccurrence, AddPriceTypesToWebEnrolment and TPric have changed to reflect this functionality.

Add functions

  1. GetPriorEducationRecognitionList: Returns a list of all prior education achievement recognition identifiers, used in TPric.Recognition.

Modify functions

  1. GetPricingForOccurrence (and any pricing details from GetoccurrenceExtendedDetails and SearchWebOccurrences): Returns the additional fields in TPric. Note that Pric_ID no longer uniquely identifies the prices, use Enpr_ID instead for a unique identifier.
  2. AddPriceTypesToWebEnrolment: It is highly recommended that calls to this function be changed to pass an Enpr_ID, instead of a Pric_ID, in each TPric. The Enpr_ID uniquely identifies each pricing item to add. The function still has some backward compatibility in that, if you pass a Pric_ID without an Enpr_ID, it will add each published pricing item of that type in the occurrence to the web enrolment, which may result in putting multiple pricing items in the web enrolment. In addition, if you also specify an Enpr_Amount and/or Enpr_GST, this amount will be applied to each pricing item of that type, which may be incorrect. Also note Pric_ID cannot be used to specify an inventory item - Enpr_ID must be used to specify an inventory item price.
  3. GetUnitStateDetails and GetQualificationStateDetails: Returns new ExpiryMonths field.
  4. GetPaymentsForInvoice: This function now returns payments that have had any effect on the specified invoice. The amount reflects the amount that was disbused to this invoice (not necessarily the entire payment amount). This change is necessary as VETtrak now allows a single payment to be recorded against multiple invoices.
  5. UpdateClientAVDetails, UpdateWebClientAVETMISS, UpdateClientWebWaitlistAVETMISS, UpdateWebEmployeeAVETMISS: Can pass a value for the new Recognition field in each TPred. Only used in Victoria.

Modify classes

  1. TPric
    1. Added fields
      • Enpr_ID: The unique identifier for the pricing item in the enrolment.
      • Pric_Type: The type of pricing item, such as tuition fee, government contribution, and inventory item.
      • Unit_Code: The code of the unit on the occurrence/enrolment that this pricing item is for, or blank if it is not for a unit.
      • Unit_Name: The name of the unit on the occurrence/enrolment that this pricing item is for, or blank if it is not for a unit.
    2. Changed fields
      • Pric_ID: This field can no longer be used to uniquely identify a price in an enrolment, use Enpr_ID instead. If this pricing item is an inventory item (ie. Pric_Type is 6), this field will contain the inventory item ID. Pricing item IDs and inventory item IDs may overlap
      • Pric_Code: If this pricing item is an inventory item (ie. Pric_Type is 6), this field will contain the inventory item code.
      • Pric_Name: If this pricing item is an inventory item (ie. Pric_Type is 6), this field will contain the inventory item name.
  2. TProcessedWebEnrol
    1. Changed fields
      • InvoiceItemId: Changed to InvoiceItemIds, now a list of integers. An invoice item is created for each enrolment pricing item, so a single processed web enrolment can now create multiple invoice items.
  3. TPred
    1. Added fields
      • Recognition: Recognition identifier for prior education. Only used in Victoria, for a client.
  4. TEmpl
    1. Added fields
      • Empl_ABN: ABN of the employer, now separate to the ACN.
  5. TQualState
    1. Added fields
      • ExpiryMonths: Number of months after which an award in this qualification and state expires.
  6. TUnitState
    1. Added fields
      • ExpiryMonths: Number of months after which an award in this unit and state expires.
  7. TOrga
    1. Added fields
      • ABN: ABN of the organisation.

Additional data field changes

These changes affect the QueryAdditionalData, GetAdditionalDataFieldsForEntity, GetAdditionalDataForWebRecord, UpdateAdditionalDataForWebRecord, UpdateClientAdditionalFields and UpdateEmployerAdditionalFields functions.

  1. New fields
    1. Client
      • SACEStudentID: The South Australian Certificate of Education student identifier for the client.
      • VicIndustryOfEmployment: The Victorian Industry of Employment of the client.
      • VicOccupation: The Victorian Occupation Identifier of the client.
    2. Employer
      • ABN: The employer's ABN (now separate from the ACN field).
    3. Enrolment
      • GovernmentAmount: The total government contribution amount for the enrolment.
    4. EnrolledUnit
      • GST: The total GST amount for the enrolled unit.
      • GovernmentAmount: The total government contribution amount for the enrolled unit.
      • RTOEmployerId: The ID of the employer that is the RTO/delivery provider for the enrolled unit.
      • RTOEmployerName: The name of the employer that is the RTO/delivery provider for the enrolled unit.
  2. Removed fields
    1. Enrolment
      • LedgerCode: Ledgers are now per pricing item, not on the enrolment.
      • LedgerName: Ledgers are now per pricing item, not on the enrolment.

Did you find it helpful? Yes No

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