Data API Release Log

Below is a list of Data API releases and notes for each.

LTS Long Term Support, the most stable versions, features locked, recommended for new engagements

Latest Rolling release of latest features, recommended for dev only

Deprecated In limited use and not recommended for new engagements

Archived Version no longer available

Long Term Support releases are now available and should be used in Production environments.

Version 1

v1.33.1 – 31st October 2019 Latest v2019.3.LTS

Bug fixes

  • GET itembank/items: Fixed a bug where an error prevented retrieving Items from a secondary Item bank with item_pool_id and advance_tags.
  • GET itembank/offlinepackage: Fixed a bug where non-existent Activities would be silently ignored from the request. This could lead to confusing situations where incomplete packages would be generated. A clear error is now returned, allowing the caller to correct their request.

v1.32.2 – 9th October 2019 v2019.2.LTS

Polish

  • Improved the performance of processing Tags during the saving operations of Items and Activities.

v1.33.0 – 19th September 2019 Archived

Features

Polish

Bug fixes

  • GET itembank/offlinepackage: Fixed a bug where some Items in the generated packages would be missing some of their Questions or Features.

v1.32.1 – 17th July 2019 Archived

Polish

  • Improved error messages for requests to invalid Item bank endpoints.

Bug fixes

  • SET /itembank/activities: Fixed a bug where Activities containing duplicates of the same Item reference could not be saved.

v1.32.0 – 26th June 2019 Archived

Features

  • GET /scoring: Added new optional param partial_scores. This enables Data API's scoring endpoint to give partial score information.

v1.31.0 – 5th June 2019 Archived

Polish

  • Internal changes and dependency updates to support future functionality.

v1.30.1 – 15th May 2019 Archived

Polish

  • GET /itembank/activities: Improved the validation of the tags parameter to reject invalidly-formatted tags with better error messages. The tags should be in TagsV2 or TagSearchByType.

v1.27.2 – 15th May 2019 v2019.1.LTS

Bug fixes

  • GET /itembank/activities: Fixed a bug where newly-created or updated Activities would no longer be searchable using the item_references filter. This bug continues to affect Activities created or updated using Data API 2019.1.LTS between 20th Feb–15th May. All affected Activities will be corrected in the coming weeks. For an ad-hoc fix in the meantime, the Activity data can be retrieved, and re-SET without modification with the SET /itembank/activities endpoint; alternatively, the Activity can also be loaded in the Author site and saved without modification.

v1.30.0 – 30th April 2019 Archived

Features

  • SET /reports/datasets: Added support for in-place update of report datasets. The dataset_id parameter can be specified to target an existing dataset for update. The previous version of a dataset remains valid until the new version is available, allowing for continuous use of a dataset during background updates.

Bug fixes

  • GET /itembank/activities: Fixed a bug where newly-created or updated Activities would no longer be searchable using the item_references filter. This bug continues to affect Activities created or updated using Data API 2019.1.LTS, or latest between 20th Feb–30th Apr. All affected Activities will be corrected in the coming weeks. For an ad-hoc fix in the meantime, the Activity data can be retrieved, and re-SET without modification with the SET /itembank/activities endpoint; alternatively, the Activity can also be loaded in the Author site and saved without modification.

v1.29.0 – 3rd April 2019 Archived

Features

  • GET /sessions/statuses: Added support for parameter include to request more data from the session status. This currently allows to retrieve the activity_template_id of the requested sessions without an extra call to the Data API.

v1.28.0 – 13th March 2019 Archived

Features

  • Added two new attributes, max_score_of_attempted and max_score_of_unmarked, to the output of the GET /sessions/scores endpoint for each session returned. These new attributes provide a more complete picture of the state of a session's score, including whether manual scoring may be required.

v1.27.1 – 20th February 2019 Archived

Bug fixes

  • Fixed input validation for the SET itembank/items endpoint to force the Item definition to match the Item's Question and Feature references. This reduces scenarios where the Item can be mistakenly saved with the wrong set of widgets.
  • Fixed a bug in the SET itembank/activities endpoint where an Activity with resource_items could not be saved.

v1.27.0 – 9th January 2019 Archived

Features

  • Added support for specifying the creating user when calling the SET /itembank/activities/duplicate endpoint, by providing the meta.user parameter. The specified user will be marked as the creator of the newly duplicated Activities/Items/Questions/Features (for the purposes of audit trail and when retrieving the entities via Data API).

Bug fixes


v1.23.8 – 9th January 2019 v2018.1.LTS

Bug fixes

  • Fixed an error in the SET itembank/items/duplicate endpoint that prevented an Item from being duplicated if it contained Tags with different numeric names representing the same integer value, for example "001" and "01".

v1.26.5 – 10th December 2018 v2018.2.LTS

Bug fixes

  • Internal performance improvements for executing requests with Learnosity servers.

v1.23.7 – 10th December 2018 Archived

Bug fixes

  • Internal performance improvements for executing requests with Learnosity servers.

v1.26.4 – 14th November 2018 Archived

Bug fixes

  • Fixed an error in SET itembank/items/duplicate that prevented an Item from being duplicated if it contained Tags with different numeric names representing the same integer value, for example "001" and "01".

v1.23.6 – 24th October 2018 Archived

Bug fixes

  • Improved suggested Tags functionality to allow searching for and adding short Tags.

v1.26.3 – 3rd October 2018 Archived

Bug fixes

  • Fixed a bug in SET /itembank/items/duplicate where all-numeric reference strings were rejected as invalid even though they were passed in correctly.

v1.23.5 – 3rd October 2018 Archived

Bug fixes

  • Fixed bug in SET /itembank/items/tags where a large item/tag combination could make the request fail. Requests are now split and batched internally to allow appropriate scaling.
  • Fixed a bug in SET /itembank/items/duplicate where all-numeric reference strings were rejected as invalid even though they were passed in correctly.
  • Internal performance improvements for executing requests with Learnosity servers.

Version 0

v0.64.15 – 3rd October 2018 Deprecated

Bug fixes

  • Fixed a bug in SET /itembank/items/duplicate where all-numeric reference strings were rejected as invalid even though they were passed in correctly.

Version 1

v1.26.2 – 27th September 2018 Archived

Bug fixes

  • Fixed bug in SET /itembank/items/tags where a large item/tag combination could make the request fail. Requests are now split and batched internally to allow appropriate scaling.

v1.26.1 – 12th September 2018 Archived

Bug fixes

  • SET /itembank/items/tags - fixed a bug where supplying the same Tag with different spacing within its type or name can trigger a 500 server error. It now treats the above scenario as two separate Tags.
  • GET /itembank/questions - fixed an issue where a non-string array of references or item_references would trigger a 500 server error. The request now returns a validation error instead.
  • GET /itembank/items - fixed an issue where a non-string array of references or questions.references would trigger a 500 server error. The request now returns a validation error instead.

v1.23.4 – 12th September 2018 Archived

Bug fixes

  • SET /itembank/items/tags - fixed a bug where supplying the same Tag with different spacing within its type or name can trigger a 500 server error. It now treats the above scenario as two separate Tags.
  • GET /itembank/questions - fixed an issue where a non-string array of references or item_references would trigger a 500 server error. The request now returns a validation error instead.
  • GET /itembank/items - fixed an issue where a non-string array of references or questions.references would trigger a 500 server error. The request now returns a validation error instead.

v1.26.0 – 27th August 2018 Archived

Polish

  • Added a Request UUID to all Data API Endpoints which identifies the request in the Learnosity system. The UUID is returned in the response metadata on error. This UUID can be communicated to Learnosity support to assist with investigating root causes of unexpected errors.

Bug fixes

  • Fixed bug in session/responses endpoint where a combination of several user and activity ids could lead to a timeout of the endpoint. The endpoint is now able to fetch data for those combinations in linear time.

v1.25.2 – 27th August 2018 Archived

Polish

  • Added a Request UUID to all Data API Endpoints which identifies the request in the Learnosity system. The UUID is returned in the response metadata on error. This UUID can be communicated to Learnosity support to assist with investigating root causes of unexpected errors.

Bug fixes

  • Fixed bug in session/responses endpoint where a combination of several user and activity ids could lead to a timeout of the endpoint. The endpoint is now able to fetch data for those combinations in linear time.

v1.23.3 – 27th August 2018 Archived

Polish

  • Added a Request UUID to all Data API Endpoints which identifies the request in the Learnosity system. The UUID is returned in the response metadata on error. This UUID can be communicated to Learnosity support to assist with investigating root causes of unexpected errors.

Bug fixes

  • Fixed bug in session/responses endpoint where a combination of several user and activity ids could lead to a timeout of the endpoint. The endpoint is now able to fetch data for those combinations in linear time.

v1.25.1 – 1st August 2018 Archived

Features

  • Improvements to internal tracking mechanism.

v1.23.2 – 1st August 2018 Archived

Features

  • Improvements to internal tracking mechanism.

v1.25.0 – 11th July 2018 Archived

Features

  • SET consumer/keys/lti: You can now set your own LTI key & secret pair instead of using the keypair generated by Learnosity. A valid key and secret must be 16-255 characters long, and is limited to characters allowed in HTTP headers.
  • SET sessions/template: Added support for gridded, choicematrix and longtextV2 Question types. Those can now be included and scored in paper-based assessments and other off-line tests.

Polish

  • SET sessions/template: Tightened validation of the session_id attribute. Various elements of the system assume it to be a UUID, which led to downstream processing error when it was not. The endpoint now rejects the payload upfront with an indication that the attribute needs to be fixed before continuing.

Bug fixes


v1.23.1 – 11th July 2018 Archived

Bug fixes


v1.24.0 – 20th June 2018 Archived

Features


v1.23.0 – 6th June 2018 Archived

Features

  • Added support for LTS versions
  • v2018.1.LTS is released

v1.22.2 – 9th May 2018 Deprecated

Bug fixes

  • SET /itembank/items/tags: Fixed a bug that caused a HTTP `500` response instead of a proper error message when sending an incorrect Tags payload.
  • SET /itembank/items/tags: Fixed a performance issue when saving multiple Items with the same Tags.
  • SET itembank/items/tags: Fixed a bug where saving a payload with duplicate tags would trigger a 500 HTTP error.
  • SET /itembank/items: Fixed a bug where saving items with tags which contains duplicate tags would trigger a 500 HTTP error.
  • SET /itembank/pools and UPDATE /itembank/pools: Fixed a bug where a 500 error can be encountered if the pools array contains any values that are null or otherwise not valid objects. This case now returns a meaningful validation error.

v1.22.1 – 18th April 2018 Archived

Bug fixes

  • Fixed a bug in the GET /reports/datasets endpoint where it would return a 500 HTTP error when called.
  • Fixed a bug, enforcing validation for custom session metadata in SET /jobs/sessions/metadata to limit the size of metadata to 10kB (or 10,000 characters).
  • SET /itembank/items: Fixed bug where using new_reference to rename an Item reference would return a 500 error if there was already an archived Item with that reference. This case now returns a validation error, which is a more meaningful message.
  • SET /itembank/pools: Fixed a bug where a 500 error would be returned if the pools property is null. This now returns a meaningful validation error and hint.
  • SET /itembank/activities: Fixed a bug where a 500 error would be returned if the activities array contains an Activity where the data property is null and the reference is not set. This now returns a meaningful validation error and hint.

v1.22.0 – 28th March 2018 Archived

Features

Bug fixes


v1.21.0 – 8th March 2018 Archived

Features

  • GET /scoring: Added a new automarkable property in the scoring result to indicate whether it was possible to score the response for this Question automatically. Requires Question responses from Questions API v2.117.0+.

v1.20.0 – 15th February 2018 Deprecated

Features


v1.19.1 – 24th January 2018 Deprecated

Bug fixes

  • SET /items: Fixed a bug with the meta parameter which resulted in user details not being updated in the audit trail when they had changed.

v1.19.0 – 10th January 2018 Archived

Features

  • SET /reports/datasets: Added count_sessions to the list of fields that can be requested from ibk-analysis-by-question and activity-analysis-by-question.
  • SET /consumers/lti/keys: Added a new endpoint to support generating a new keypair for Learnosity LTI.

Polish

  • Made some validation errors clearer on complex request payloads.

Bug fixes

  • SET /reports/datasets: Fixed a bug where activity-analysis-by-question reports could not be generated when Items were not presented all in the same order in the analysed sessions.

v1.18.0 – 6th December 2017 Archived

Features

  • Add duplication endpoints for Activities, Items, Questions and Features, so that you can easily duplicate content in your app.

v1.17.0 – 15th November 2017 Archived

Features

  • SET /itembank/items and GET /itembank/items: Add a new title attribute for setting and retrieving a free text title on an Item. The title field is used for display and search purposes in the Author API and Learnosity's Author Site.

Bug fixes

  • Fix a bug in the SET /jobs/sessions/scores/subscores endpoint where discarded session IDs were included in the request.
  • Fix a bug in the validation of the SET /sessions endpoint where the limit of 50 session entries per request was not enforced (for both failed_submission and from_template data formats).

v1.16.4 – 25th October 2017 Deprecated

Bug fixes

  • Fix a performance issue when calling GET /itembank/items with a pool_id for items with tags.
  • Fix a bug where submitting a job request could sometimes cause a 500 error.
  • Fix various validation issues in SET /reports/datasets which now returns the correct 400 error.

v1.16.3 – 17th October 2017 Archived

Features

  • Internal improvements to the processing and delegation of jobs.

v1.16.2 – 5th October 2017 Archived

Bug fixes

  • Fix a bug in SET /itembank/activities/tags where submitting a payload with empty items will trigger a 500 error instead of a 400 error.
  • Fix a bug in POST /itembank/activities/tags can sometimes trigger a 500 error with numeric tag types.
  • Fix a bug in SET /itembank/items/tags where submitting a payload with empty items will trigger a 500 error instead of a 400 error.
  • Fix a bug in POST /itembank/items/tags can sometimes trigger a 500 error with numeric tag types.
  • GET /itembank/items: fix a bug which is causing widgets shared between multiple items to only appear under one of the items it is included in (instead of being included in all the items in which it appears).

v1.16.1 – 20th September 2017 Archived

Bug fixes

  • Fix a bug in SET /sessions where a failed_submission payload would trigger a 500 error.

v1.16.0 – 14th September 2017 Archived

Features

  • GET itembank/items: add support for fetching max_score of Items via the include.items[] option.
  • reports/datasets: introduce two new dataset types for item analysis: ibk-analysis-by-question and activity-analysis-by-question. See the introduction to item analysis for details.

Bug fixes

  • GET itembank/questions, GET itembank/features: Fix timeouts for certain requests.
  • Fixed the limit on the number of entries allowed in a single request for all SET and UPDATE itembank endpoints.
  • SET itembank/questions: Improve error message when a provided Question has an undefined type.
  • SET itembank/items: Improve error message when a provided Item has a definition containing no widget references (see the Item Definition guide).

v1.15.0 – 2nd August 2017 Archived

Features

  • GET itembank/items: add support for fetching dynamic_content_data via include.items[]

v1.14.1 – 15th July 2017 Deprecated

Bug fixes

  • POST itembank/item/tags: fix rare bug where saving tags could fail with a 500 error.

v1.14.0 – 12th July 2017 Archived

Features

  • Expand support for programatically submitting responses when using the SET sessions endpoint. Support was added for clozetext, clozeinlinetext, shorttext, plaintext and longtext responses.

Polish

  • GET scoring, GET sessions/responses and GET sessions/responses/scores: Clarify the error messages returned when a scoring error is encountered.

v1.13.0 – 21st June 2017 Deprecated

Features

  • New support for submitting sessions programmatically using the GET sessions/template endpoint and SET sessions functionality. This can be used to submit results from paper based assessments or other manual processes.
  • GET sessions/responses and GET sessions/responses/scores: Return new dt_score_updated field for each response, indicating when the response data was was last updated via a save, submit, auto scoring or manual scoring operation.

Bug fixes

  • Fix a bug where creating or retrieving items with a user name containing spaces can cause an error.

v1.12.0 – 31st May 2017 Archived

Features

  • GET itembank/activities: Add new item_references parameter to retrieve activities containing one or more specific items.
  • GET itembank/tagging/hierarchies: Use a deterministic sort, using the hierarchies' ID.

Bug fixes

  • GET itembank/tagging/hierarchies: Fix a bug where references could not be omitted.
  • GET itembank/tagging/hierarchies: Fix a bug where limit/next requests weren't honoured.
  • POST activities: Fix a bug where tags were sometimes not properly removed from activities.
  • POST items: Fix a bug where tags were sometimes not properly removed from items.
  • GET sessions/responses: Ensure next tokens carried over from Data API v0 requests are supported.

v1.11.0 – 10th May 2017 Archived

Features

  • sessions/responses - Add activity_template_id, items_api_version to session's metadata object.

Bug fixes

  • Fix for public URLs returned from the itembank/upload/assets endpoint, which were not correctly encoded.

v1.10.0 – 19th April 2017 Archived

Features

  • New GET itembank/tagging/tags/search endpoint. It provides the ability to search for tag suggestions based on a query string.
  • Add support in GET sessions/reports/adaptive to fetch custom adaptive report for the itembranching algorithm.

Bug fixes

  • Fix a bug in SET itembank/activities and SET itembank/activities/tags where saving activities with tags could sometimes cause an error.

v1.9.0 – 28th March 2017 Archived

Features

Bug fixes

  • Fix a bug where SET /itembank/items[/tags] could return a 500 error for some items or tag names with certain combinations of whitespace or mixed casing.
  • Improve internal logging of errors and invalid endpoints.

v1.8.1 – 8th March 2017 Deprecated

Bug fixes

  • Improve performance for itembank/items and itembank/items/tags endpoints.

v1.8.0 – 15th February 2017 Archived

Features

  • Add new endpoint UPDATE /jobs/sessions/statuses. This allows to force set the status of the given session, and (re)-trigger post-completion events (scoring, firehose publication, ...).
  • Deprecate UPDATE /sessions/statuses. It is silently remapped to the new /jobs/sessions/statuses behaviour, which returns a job reference rather than immediately applying the status change.

v1.7.0 – 1st February 2017 Deprecated

Features

  • Add new endpoint SET /itembank/upload/assets for bulk uploading client assets.

v1.6.0 – 24th January 2017 Archived

Features

  • Add new endpoint GET /itembank/tags/hierarchies. This endpoint supports fetching the structure of existing tagging hierarchies.
  • New endpoint GET /itembank/tags/hierarchies/nodes. This endpoint enables browsing tags and items according to predefined tagging hierarchies.

Bug fixes

  • SET /itembank/items/tags - Fix a case where a 500 error could be returned during mass imports.
  • SET /itembank/items - Fix a case where a 500 error could be returned during mass imports.
  • SET /itembank/questions - Fix a case where a 500 error could be returned during mass imports.

v1.5.0 – 11 January 2017 Deprecated

Features

  • Replace SET /jobs/reports/datasets endpoint with SET /reports/datasets. This endpoint no longer creates a job record, and does not return a job_reference.
  • Replace UPDATE /jobs/reports/datasets endpoint with SET /jobs/reports/datasets. This endpoint now creates a job record and returns the job_reference.
  • SET /jobs/reports/datasets - abolish the status awaiting_data for jobs created by this endpoint.

v1.4.0 – 8 December 2016 Deprecated

Features

  • Added support for new dataset type sessions-summary-by-group. Full details coming soon.

Bug fixes

  • Fix an issue where subsequent calls to UPDATE /jobs/reports/datasets after the first would not return the correct error message
  • SET /submissions - Fix bug where a submission with no attempted responses would fail

v1.3.0 – 17th October 2016 Archived

Features

  • Increase the limit on array filter fields to 1000 values (was 50). See the updated filter controls section of the upgrade guide
  • All endpoints now use the maximum allowed limit by default, to return the maximum allowed number of results. Requests no longer need to specify a limit unless intended.

Bug fixes

  • Fix a bug where a new session cannot be retrieved within 5 seconds of submission.

v1.2.2 – 27th October 2016 Archived

Bug fixes

  • Limit maximum number of entries for SET itembank/activities to 50
  • Limit maximum number of entries for SET itembank/items to 50
  • Limit maximum number of entries for SET/UPDATE itembank/activities/tags to 50
  • Limit maximum number of entries for SET/UPDATE itembank/items/tags to 50
  • Limit maximum number of entries for SET/UPDATE itembank/pools to 50
  • Limit maximum number of entries for SET itembank/tags to 50
  • Fix bug where SET itembank/items could throw 500 error if invalid parameters were passed

v1.2.1 – 5th October 2016 Archived

Bug fixes

  • Fix bug where saving features through POST itembank/features always failed
  • Fix bug where sessions initialised with no course_id could not be submitted through POST sessions

v1.2.0 – 27th September 2016 Archived

Features

  • Introduce modular support for external adaptive algorithms via AWS Lambda

v1.1.0 – 14th September 2016 Archived

Features

  • Add beta endpoints for jobs/reports/datasets and reports/datasets to generate and retrieve aggregated datasets for the activity-summary-by-group report. Full details coming soon.

v1.0.2 – 24th August 2016 Archived

Bug fixes

  • Fix bug where GET sessions/responses/scores could throw 500 error if invalid parameters were passed
  • Improve the performance of GET itembank/items

v1.0.1 – 17th August 2016 Archived

Bug fixes

  • Improve performance of GET itembank/items

v1.0.0 – 10th August 2016 Archived

The release of Data API v1 brings a host of new improvements including:

  • Improved performance and stability, especially for item and session retrieval.
  • Simple and powerful new format for importing and manipulating item content.
  • A more consistent API for status polling and session data.

Get started with the getting started guide.


Version 0

v0.64.14 – 12th September 2018 Archived

Bug fixes

  • SET /itembank/items/tags - fixed a bug where supplying the same Tag with different spacing within its type or name can trigger a 500 server error. It now treats the above scenario as two separate Tags.

v0.64.13 – 11th July 2018 Archived

Bug fixes


v0.64.12 – 9th May 2018 Archived

Bug fixes

  • Improved performance on various itembank endpoints.

v0.64.11 – 14th September 2017 Archived

Bug fixes

  • GET itembank/questions, GET itembank/features - fix timeouts for certain requests.

v0.64.10 – 31st May 2017 Archived

Bug fixes

  • sessions/responses - internal performance improvements.

v0.64.9 – 10th May 2017 Archived

Bug fixes

  • Fix a bug in sessions/responses/scores where it sometimes returns an error processing request when passing in invalid requests.

v0.64.8 – 19th April 2017 Archived

Bug fixes

  • Fix a bug in SET itembank/activities and SET itembank/activities/tags where saving activities with tags could sometimes cause an error.

v0.64.7 – 29th March 2017 Archived

Bug fixes

  • Fix a bug where SET /itembank/items[/tags] could return a 500 error for some items or tag names with certain combinations of whitespace or mixed casing.
  • Improve internal logging of errors and invalid endpoints.

v0.64.6 – 8th March 2017 Archived

Bug fixes

  • Improve performance for itembank/items and itembank/items/tags endpoints.

v0.64.5 – 24th January 2017 Archived

Bug fixes

  • SET /itembank/items/tags - Fix a case where a 500 error could be returned during mass imports.
  • SET /itembank/items - Fix a case where a 500 error could be returned during mass imports.

v0.64.4 – 17th November 2016 Archived

Bug fixes

  • Fix a bug where a new session cannot be retrieved within 5 seconds of submission.

v0.64.3 – 5th October 2016 Archived

Bug fixes

  • Validate metadata attribute is string array in GET sessions/responses
  • Validate metadata attribute is string array in GET sessions/reports/adaptive
  • Validate to prevent empty item_references in GET itembank/questions
  • Fix bug where sessions initialised with no course_id could not be submitted through POST sessions

v0.64.2 – 24th August 2016 Archived

Bug fixes

  • Improve the performance of GET sessions/responses when searching by session_id
  • Improve the performance of GET sessions/scores when searching by session_id

v0.64.1 – 17th August 2016 Archived

Bug fixes

  • Improve performance of GET itembank/items

v0.64.0 – 3rd August 2016 Archived

Features

  • sessions/responses, sessions/responses/scores - add attempted flag to each response

v0.63.0 – 20th July 2016 Archived

Features

  • sessions/responses/scores - support for setting attempted status of a response

v0.62.0 – 5th July 2016 Archived

Features

  • Internal changes to support large numbers of tags.

v0.61.2 – 9th May 2018 Deprecated

Bug fixes

  • Improved performance on various itembank endpoints.

v0.61.1 – 17th August 2016 Archived

Bug fixes

  • Improve performance of GET itembank/items

v0.61.0 – 1st June 2016 Archived

Features

  • Added support to handle Hotspot Interaction question type on itembank/conversion/fromqti and itembank/conversion/toqtiendpoint

v0.60.0 – 11th May 2016 Archived

Features

  • itembank/pools - Itembank pool references can only be up to 150 characters long
  • itembank/pools - Itembank pools cannot store unpublished content, to create a pool with unpublished content, 'set_unpublished_to_published': 'true' can be passed in with the pool request

Bug fixes

  • sessions/responses/scores - Validate existence of max_score if not already set for a given response
  • sessions/responses/scores - Validate manual_score is less than score
  • sessions/responses/scores - Validate max_manual_score is less than max_score
  • sessions/responses/scores - Validate response being updated already exists
  • sessions/responses/scores - Validate response being updated is already attempted

v0.59.4 – 9th May 2018 Deprecated

Bug fixes

  • Improved performance on various itembank endpoints.

v0.59.3 – 17th August 2016 Archived

Bug fixes

  • Improve performance of GET itembank/items

v0.59.2 – 6th April 2016 Archived

Bug fixes

  • itembank/items - fix a 500 error occasionally thrown when making concurrent SET requests to this endpoint

v0.59.1 – 30th March 2016 Archived

Bug fixes

  • sessions/reports/adaptive - fix 500 error thrown when result contains Incomplete sessions

v0.59.0 – 30th March 2016 Archived

Features

  • sessions/responses / sessions/responses/scores - show any scoring errors for each response
  • sessions/reports/adaptive - support for new ability estimation methods

v0.58.2 – 17th August 2016 Deprecated

Bug fixes

  • Improve performance of GET itembank/items

v0.58.1 – 9th March 2016 Archived

Bug fixes

  • sessions/responses - fix issue where large responses would fail
  • Fixed Itembank tag searching - fail when tags do not exist

v0.58.0 – 17th February 2016 Archived

Features

  • Support for read-only organisations within a consumer
  • Add support for whitelisting all domains passed in security

Bug fixes

  • Fixed a bug where saving a question sometimes generates invalid metadata
  • Fixed HTML rendering bug upon QTI conversion on itembank/conversion/fromqti endpoint

v0.57.2 – 17th February 2016 Archived

Bug fixes

  • Fixed a bug where saving a question sometimes generates invalid metadata

v0.57.1 – 3rd February 2016 Archived

Polish

  • Improvement to internal security configuration.

v0.56.1 – 19th November 2015 Deprecated

Refactors

  • Improved detection of potentially malicious user inputs

v0.55.1 – 1st October 2015 Archived

Bug fixes

  • Fixed issue with incomplete scoring affecting a small number of scorable responses

v0.54.1 – 18th September 2015 Archived

Bug fixes

  • Get items/activities - fix issue with next token for recursive requests

v0.54.0 – 10th September 2015 Archived

Features

  • Session scores - for manually scored questions, manual_score and max_manual_score are now returned
  • Item pool creation - improved flexibility for specifying content by tags
  • Items and activities can now be sorted by time created/updated
  • Added support to `validate` QTI with the standard IMS schema on itembank/conversion/fromqti endpoint

Bug fixes

  • Saving items - questions/features are allowed to be empty
  • Get questions - fix issue with reference wildcard search

v0.53.0 – 27th August 2015 Archived

Features

  • Updating pools will now fail when duplicate items found and overwrite is not set.
  • Added endpoint itembank/conversion/fromqti and itembank/conversion/toqti for QTI conversion
  • Added support for specifying a different organisation for all Itembank endpoints

v0.52.1 – 9th May 2018 Deprecated

Bug fixes

  • Improved performance on various itembank endpoints.

v0.52.0 – 13th August 2015 Archived

Features

  • Added support for QTI conversion (BETA)

Bug fixes

  • Improved SET `itembank/tags` and `itembank/items/tags` operations to now only perform operation if changes are detected. This will avoid polluting audit trails.
  • Improved validation on failed submissions endpoint to now check whether sessions belong to the Consumer making the request

v0.51.0 – 30th July 2015 Archived

Features

  • Added the /jobs/sessions/scores/subscores endpoint to carry out subscores calculation for the requested sessions.
  • Added support for base_directory in the Offline Package. For more information, refer to the Offline Package documentation.

v0.50.3 – 2nd July 2015 Deprecated

Features

  • Added the course_id field as an optional included return value on for session requests

Bug fixes

  • Job creation exceptions won't pass back a job reference id
  • Ignores item metadata passed in as null instead of throwing error and not completing request

v0.49.0 – 21st May 2015 Archived

Features

  • Instead of a user id, a user object can be passed in the meta data to track who made changes via data api. If the user does not exist, a new user will be created.

Bug fixes

  • Changes made to items/tags are now reflected in the tag hierarchy queue
  • contenteditable attributes for item content cannot be set to true

v0.48.0 – 7th May 2015 Deprecated

Features

  • Added endpoint to query jobs
  • Optimised some queries

Bug fixes

  • Manual updates to question scores are now reflected in the item score

v0.47.4 – 23rd April 2015 Deprecated

Bug fixes

  • Minor performance improvements

v0.46.0 – 26th February 2015 Archived

Features

  • Add item level scoring support to get and set items requests

Bug fixes

  • Various bug fixes

v0.45.0 – 12th February 2015 Archived

Features

  • Add item level scoring to sessions data

v0.43.2 – 18th December 2014 Archived

Bug fixes

  • Endpoint itembank/items, itembank/questions, and itembank/activities, now return `next` token as an integer (previously was a float)
  • Various bug fixes

v0.43.0 – 11st December 2014 Archived

Features

  • Performance improvements on items and sessions endpoints
  • Set users/activities - validation should handle adaptive activities
  • Get activities - don't return deleted activities by default
  • Add question and item references to response objects
  • Support for requesting additional fields in response data

v0.41.1 – 11th November 2014 Archived

Features

  • Change The score property on all session objects is now the raw score, not the percentage score as before. Percentage score can be calculated from score and max_score.

v0.40.0 – 30th October 2014 Archived

Features

  • Added /itembank/features endpoint

Bug fixes

  • Various bug fixes

v0.38.1 – 10th October 2014 Deprecated

Bug fixes

  • Various bug fixes

v0.36.0 – 18th September 2014 Archived

Features

  • /itembank/activities/tags
    • New endpoint to set activities' tags
  • Empty tags will now be returned as an empty object instead of array

v0.35.0 – 11st September 2014 Archived

Features

  • Added support for importing source, note, and acknowledgements on /itembank/items
  • Added support for exporting and importing adaptive on /itembank/activities
  • Added support for exporting tags on /itembank/activities

Bug fixes

  • Various bug fixes

v0.34.1 – 6th September 2014 Archived

Bug fixes

  • Allowed all cross origin domains

v0.27.6 – 19th September 2016 Archived

Refactors

  • Internal logging fix

v0.27.5 – 3rd November 2015 Archived

Bug fixes

  • Restricted calls for /sessions/statuses without activity_id or user_id parameters

v0.27.4 – 5th December 2014 Archived

Features

  • Can now update session (test) statuses
  • mintime and maxtime now accept datetime strings as well as unit timestamp
  • Added support for reporting on discarded session (test) statuses

v0.27.3 – 5th December 2014 Archived

Bug fixes

  • Improved index performance for get test status

v0.57.0 – 1st February 2016 Archived

Features

  • Remove count parameter from GET endpoints
  • itembank/questions endpoint - get/set question metadata now supported

Bug fixes

  • sessions/responses endpoint - Corrected sessions can now be queried

v0.56.0 – 28th October 2015 Archived

Features

  • For GET `itembank/items`, we now allow `name` key to be an array and tag type only in `all` tags upon searching via tags

Bug fixes

  • Fixed SET `itembank/item` endpoint in which existing item is not cleaned properly upon replacing with `set` operation

v0.55.0 – 24th September 2015 Archived

Features

  • Added more question types support for `clozedropdown`, `clozetext`, and `imageclozeassociation` on itembank/conversion/toqti endpoint

v0.50.2 – 18th June 2015 Archived

Bug fixes

  • Returning source and note when getting items

v0.50.0 – 4th June 2015 Archived

Features


v0.47.3 – 9th April 2015 Archived

Bug fixes

  • next token for requests to /users/statuses endpoint works as expected
  • Setting user ids (e.g. "meta": { "user_id": "CURRENT_USER_ID" }) for requests to /activities/tags endpoint correctly attributes changes to given user instead of Manual User/Data GUI
  • Setting user ids (e.g. "meta": { "user_id": "CURRENT_USER_ID" }) for requests to /items/tags endpoint correctly attributes changes to given user instead of Manual User/Data GUI

v0.47.2 – 26th March 2015 Archived

Polish

  • Polish for item pools: creation and update date correctly updated
  • Polish for item pools: when updating a pool, existing items are always overwritten
  • Polish for item pools: status can now be set to unpublished

v0.47.1 – 13th March 2015 Archived

Bug fixes

  • Fixed data api usage for non-itembank data operations

v0.47.0 – 12th March 2015 Archived

Features

  • Add ability to create and update pools
  • Add ability to specify a user for sets and updates

v0.44.2 – 21st January 2015 Archived

Bug fixes

  • Various bug fixes

v0.44.1 – 20th January 2015 Archived

Bug fixes

  • Fixed itembank/questions endpoint not being able to create questions
  • Various other bug fixes

v0.44.0 – 15th January 2015 Archived

Features

  • Add ability to return information about item pools, available off itembank/pools
  • All itembank endpoints now support retrieving content from a pool

v0.42.0 – 27th November 2014 Archived

Features

  • Expose response level scores on a new endpoint, GET/UPDATE /sessions/responses/scores

v0.39.0 – 16th October 2014 Archived

Features

  • Activity references now support up to 150 characters
  • Added support for importing with base template applied on itembank/activities

v0.38.0 – 8th October 2014 Archived

Features

  • Added support for importing tags on itembank/activities
  • Added support for importing tags on itembank/items

Bug fixes

  • Various bug fixes

v0.37.0 – 2nd October 2014 Archived

Features

  • Set activities now only accepts 'published' items
  • The following endpoints will now always return a next token even if no more records available. This means requests using the same token can be made until new datas eventually returned.
    • /sessions/responses
    • /sessions/reports/adaptive
    • /sessions/scores
    • /sessions/statuses

Bug fixes

  • Various bug fixes

v0.34.0 – 4th September 2014 Archived

Features

  • Added item_reference field to sessions/scores

Bug fixes

  • Various bug fixes

v0.27.2 – 29th August 2014 Archived

Bug fixes

  • Improved performance with read only slaves

v0.33.1 – 28th August 2014 Archived

Features

  • Performance optimisations when running read requests against the item bank

v0.33.0 – 21th August 2014 Archived

Features

  • Added max_score to sessions/scores
  • Items' content and all values on Questions' JSON now will be stripped for invalid HTML tags and attributes on import
  • Added a new endpoint /itembank/activities/templates to get all base templates. Deprecated endpoint /itembank/activities/base
  • Various bug fixes

v0.32.0 – 14th August 2014 Archived

Features

  • Added validation on Item references
  • Miscellaneous bug fixes

v0.31.0 – 7th August 2014 Archived

Features

  • Added metadata to /itembank/items
  • Item and Question references now support up to 150 and 155 characters respectively

v0.30.1 – 29th July 2014 Archived

Bug fixes

  • Explicitly converting include_response_scores to boolean

v0.30.0 – 24th July 2014 Archived

Features

  • Added max_time to session metadata (visible via /sessions/responses)
  • Action Builder is now returned as decoded JSON

v0.29.0 – 22nd July 2014 Archived

Features

  • Added /sessions/scores endpoint
  • Now returns the student user agent string in /sessions/responses
  • Cast score and max_score values to floats in /sessions/responses –

v0.28.0 – 10th July 2014 Archived

Features

  • Removed the score from /sessions/statuses –
  • Added reporting on sub score calculations
  • Added feature to save new activites to ItemBank
  • Ability to create activity stubs in the Dashboard (via user provisioning)
  • Ability to filter items that are deleted
  • Added ability to save tags
  • Added ability to filter /sessions/responses by session_id
  • Now returning score as a float in /sessions/responses
  • Casting int/float return values for /sessions/reports/adaptive report –
  • Added ability to retrieve deleted activities

v0.27.1 – 12th August 2014 Archived

Bug fixes

  • Fix issue with min/max time filter

v0.27.0 – 11th June 2014 Archived

Features

  • Added ability to save test statuses via data api
  • Min/maxtime use ISO8601 date format

v0.26.0 – 27th May 2014 Archived

Features

  • /itembank/activities/base
    • New endpoint to return the activity base template
  • /itembank/activities
    • Now includes the base activity template by default

v0.25.0 – 7th May 2014 Archived

Features

  • /sessions/reports/adaptive
    • New endpoint to return adaptive reports

Bug fixes

  • Fixed bug with next token

v0.24.0 – 2nd May 2014 Archived

Features

  • /users/activities
    • New method to delete user activities provision
  • /itembank/questions
    • Add choice matrix as valid question type
  • /scoring
    • Add choice matrix as scorable question type

Bug fixes

  • /sessions/responses
    • Bug fix when filtered by incomplete sessions

v0.23.2 – 11th April 2014 Archived

Refactors

  • Refactor to increase performance of /sessions/statuses and /sessions/responses

Bug fixes

  • Misc bug fixes

v0.22.0 – 8th April 2014 Archived

Features

  • Perform all scoring through new scoring service

v0.21.0 – 27th March 2014 Archived

Features

  • Added records to response meta packet for GET requests

v0.20.0 – 17th March 2014 Archived

Features

  • sessions/responses endpoint:
    • Added school_id to each response
  • sessions/statuses endpoint:
    • Added school_id to each response

v0.19.0 – 11th March 2014 Archived

Features

  • sessions/responses endpoint:
    • Added max_score for each response
    • session_duration, num_attempted, num_questions are now returned as numbers.

v0.18.0 – 6th March 2014 Archived

Features

  • Added the following properties to the sessions/responses endpoint:
    • dt_started
    • dt_completed
    • num_attempted
    • num_questions
    • score
    • status
  • Removed dt_event from the sessions/responses endpoint
  • Added support for a status filter on the sessions/responses endpoint

v0.17.1 – 20th February 2014 Archived

Features

  • Added itembank/activities endpoint

v0.16.1 – 30th January 2014 Archived

Features

  • Added status parameter to:
    • itembank/items

Bug fixes

  • Fixed count parameter on:
    • itembank/items

v0.16.0 – 16th January 2014 Archived

Features

  • Added sort parameter to:
    • sessions/statuses
    • sessions/responses

v0.15.0 – 7th January 2014 Archived

Features

  • Added endpoints to create/update:
    • items
    • tags
    • questions
  • Responses using the count request parameter are now returned as integers (rather than strings)

v0.14.0 – 19th December 2013 Archived

Features

  • Added items metadata on the sessions/responses endpoint
  • Added adaptive information (difficulty, operational_exposure, seeding_exposure) on the itembank/items endpoint
  • credit and credit_used are now returned as integers

v0.13.0 – 12th December 2013 Archived

Features

  • Added clozeinlinetext and graphplotting support to the scoring service

v0.12.0 – 22nd November 2013 Archived

Features

  • Fixed issue where tokenhighlight requests to the scoring servicewere failing because a bug in v0.11.0
  • Added max_score to the response envelope of the scoring service

v0.11.0 – 12th November 2013 Archived

Features

  • Fixed issue where set requests were failing becausea bug in v0.10.2 dynamically added 'format' to the request packet.
  • Removed support for legacy properties and routes including:
    • /tests (now /sessions)
    • /users/exams (now /users/activities)

v0.10.2 – 7th November 2013 Archived


v0.10.1 – 16th October 2013 Archived


v0.10.0 – 13th October 2013 Archived

Features

  • New route: users/status
  • Add support for getting user expiry date via data api
  • Session duration to be added to tests/responses. Returns duration in minutes
  • Added html as a valid response type
  • Removed school_name from returned data for users
  • Moved session_duration up to the test level (no longer the responses level) and casted to int

Bug fixes

  • Issue where only a single class was returned (instead of an array)

v0.9.0 – 15th September 2013 Archived

Features

  • Addition of user classes
  • Now supporting the 'mintime' and 'maxtime' request parameters
  • Addition of 'get' and 'set' for school classes

v0.8.1 – 10th September 2013 Archived


v0.8.0 – 30th August 2013 Archived

Features

  • Added credit and credit_used in users/exams
  • Add support for saving user details i.e. first name, last name
  • Added user exams endpoint

v0.7.7 – 28th August 2013 Archived

Features

  • Features:
    • tests/status now returns a session_id, which is a unique user/session identifier
    • Removed v0.5.3

v0.7.6 – 27th August 2013 Archived

Features

  • Features:
    • tests/status update to always return 'Started' and 'Completed'

v0.7.4 – 26th August 2013 Archived

Features

  • Features:
    • The meta response envelope now contains a timestamp property
    • Added support for retrieving user exams, including per-user special provisions
    • Added support for retrieving user responses
    • Added support for persisting per-user products

v0.6.1 – 31st July 2013 Archived

Features

  • Features:
    • The request object, if passed, is now a part of the security signature
    • Added support for the action parameter (get|set). get is the default
    • QTI fixes and enhancements
    • Changed output format for tags, they are now grouped under tag type
    • Now only supporting POST request types
    • Removed support for the following generic parameters for itembank/tags:
      • limit
      • next
      • since
    • Schools and User resource request additions