Surfacing Review responses in OData

Access to this feature will be granted by request only. Please request access to this feature via the Support team or your Customer Success Manager.

  • Review responses will be available in OData where both the following conditions are met:
    • The section type is defined as “custom,” namely Custom, IAG, Workplace Induction Checklist, Learner Satisfaction Survey.
    • The review was “started” after the feature has been configured on the individual tenant.
  • When a learner, tutor, or employer clicks Start on the review, the configuration of the custom section(s) will be available in the OData feed (the answers at this point will be empty).
  • When a learner, tutor or employer saves the review section, the answers will be available in the OData feed – the OData feed will be updated asynchronously and will be available within 15 minutes of the review being started or answer being saved.
  • The Review Responses is displayed via a new table – customers can access this table in the same way they access other tables in OData. For more information please see this collection of articles.
    po4.png
  • The Reviews Responses table is linked to the Reviews table via the Review ID. For more information please see the diagram in the OData dictionary here.
  • There is a paging limitation of 5000 rows. Please see an example of a looped query to support loading the data efficiently in this article: Retrieving Review responses via OData.

Updates in a future release

Historic data for the current funding year (or current and previous funding year) will be migrated to the OData feed and will be available after general availability.

This will be migrated by request only. Customers can request either just the current funding year, or current and 1 previous funding year, by raising a support ticket. Once requested, we will plan the migration and inform you of the timeframe by which you can expect to receive your historic data.

Notes

Amendments made to reviews in the reviews token once the review instance has been started will not be reflected in the OData feed. Amendments are described as:

  • Changes made to the title of a custom question
  • A new question is added to a custom section
  • A new section is added to an existing review

Reviews started after the amendment has been made will include the amendments

Reviews which are deleted from the UI will also have associated responses deleted from the OData feed, ensuring the OData feed is consistent with data in UI.

Was this article helpful?
0 out of 0 found this helpful