API Change Log for VETtrak 21.2.x and 21.3.x

Version for VETtrak - 31/08/2021

Bugfix release. No breaking changes.

  1. UpdateResult and UpdateResultIncludingLinked will no longer produce the "Finish date must not be in the future for a completed result" error when a finishDate of today and containing a time has been specified.
  2. Added support for the "expiry period" preservability properties when sending enrolments to aNewSpring.
  3. Fixed an issue that caused the completion date to not be set when auto-recording VET Student Loans Unit of Study completions when enrolled unit results are recorded.

Version for VETtrak 21.2.0 - 21/06/2021

Changes for VETtrak 21.2. Note: The added fields may be a breaking change for you, depending on your SOAP client.

Add functions

  1. GetAwardsModifiedSince: Finds awards that have been created or modified since a specified date.
  2. GetInvoice: Retrieves a single invoice by ID.
  3. CheckPasswordValidity: Indicates whether a proposed new password meets VETtrak's configured password requirements.
  4. UpdateConfig, VETenrolLogin, VETenrolDirectLogin: These functions are used by VETenrol only.

Modify functions

  1. UpdateClientDetails: This function will no longer create an empty employment record when updating a client that doesn't already have any employment records, when you don't specify any employer information in the call.
  2. UpdateResult, UpdateResultIncludingLinked, UpdateEnrolledTask, UpdateClientTasks: These functions will now return an error if you attempt to record a completed-type result with a future completion date if the "Don't allow completed units or tasks to have a completed date in the future" preference is turned on in VETtrak.

Modify classes

  1. TInvoiceItem
    1. Added fields
      1. OwnerClientCode: Code of the client that owns the item that was invoiced (eg. if the invoice item is for a pricing item on a client enrolment or contract, this will indicate the client that is enrolled). Will be empty if the item that was invoiced does not belong to a specific client.
  2. TQucl
    1. Added fields
      1. Issued: Boolean indicating whether the award is marked as issued.
      2. Completion: Boolean indicating whether the award is marked as being a completion.

Additional data field changes

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

Changed fields

  1. Client
    1. Citizenship: Added support for new value 6 "Temporary Visa holder". Names of some existing options have been adjusted.

Did you find it helpful? Yes No

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