Tracker API Changelog

New release:

June 21, 2021

Additions/ New Features

search/experimentprocedures endpoint will now accept procedure key as a search parameter using the 'procedure' query string key.

Changes/ Bug Fixes

when the search/experiment procedures endpoint has no results, it will now return status 200 with an empty JSON array.


New release:

March 29, 2021

Additions/ New Features

  • /zip/:zipIdOrFilename/:xmlIdOrFilename
  • /xml/:idOrFilename

These endpoints will now default to summary information. To specify full detail, include ``detail=full`` as a query string parameter.

  • /search/experimentprocedures

the ageAtExperiment field is now just 'age' to bring it in line with other endpoints showing the same value

Changes/ Bug Fixes

No fixes added in this update


New release:

March 22, 2021

Additions/ New Features

the urls under 'item' path (experimentprocedures, specimens) now redirect. The new endpoint produces the same information, but takes a different approach which should be faster. Both URLs will remain supported for the forseeable future, so as long as clients can handle the redirect, no further change should be required.

Changes/ Bug Fixes

Refactoring behind the scenes to try and improve stability. There's more still to come, but this is being released in conjunction with changes to trackerweb


New release:

November 9, 2020

Additions/ New Features

No features added in this update

Changes/ Bug Fixes

Added 10,000 item limit on POST requests to prevent mis-use of the API.


New release:

September 25, 2020

Additions/ New Features

Added "showdetails" as additional parameter string for call "/search/:itemType" if passed as "true" will return the object's content in place of identifier.

Tags: API

Changes/ Bug Fixes

No fixes added in this update


New release:

September 21, 2020

Additions/ New Features

No features added in this update

Changes/ Bug Fixes

Unfortuntely a system-breaking bug was discovered that in addition to bug fixing required a number of changes to the available endpoints in order to prevent the bug recurring. As a result we determined the best course of action is to get these changes rolled out ASAP, but this does mean that we did not have time to notify users ahead of time. We apologise for the inconvenience - if these changes cause issues with API clients that your centres have implemented, please let us know and we will endeavour to assist in getting you back up and running as quickly as possible.

/xml/:idOrFilename
-parameters startProcedureCount and resultProcedureSize are removed
-specimens[], experimentProcedures[], lineProcedures[].Will return list of ids rather than full information.

/issues/zip/:zipIdOrFilename
-parameters startProcedureCount and resultProcedureSize are removed
-specimens[], experimentProcedures[], lineProcedures[].Will return list of ids rather than full information.

/zip/:zipIdOrFilename/:xmlIdOrFilename
-parameters startProcedureCount and resultProcedureSize are removed
-specimens[], experimentProcedures[], lineProcedures[].Will return list of ids rather than full information.

/specimen/:centre/:specimenId(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be specimens with additional parameters as centre.

/specimen/:centre(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be specimens with additional parameters as createdDateFrom ,createdDateTo and status.

Note: isBaseline parameter cannot be accessed from new endpoint.

/specimen/experimentprocedure/:centre/:specimenId(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be experimentprocedures with additional parameters as centre

/experimentprocedure/:centre(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be experimentprocedures with additional parameters as centre

/lineprocedure/:colonyId(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be “lineprocedures” with parameter as colonyId

/lineproc/:centre(Removed)
For getting same information need to use new endpoint.
“/search/:procedureType” procedureType would be “lineprocedures” with parameter as centre, createdDateFrom ,createdDateTo and status.

/item/:itemType/:id
-New endpoint

/item/:itemType/multiple(POST)
-New endpoint

/search/:itemType
-New endpoint


New release:

April 7, 2020

Additions/ New Features

No features added in this update

Changes/ Bug Fixes

Colony Id information for specimen

404 error for fetching specific xml details


New release:

March 16, 2020

Additions/ New Features

Added statusId and phaseId as additional parameter string for calls "/centre/xml?centre=:shortName", "/specimen/:centre/:specimenId" , "/experimentprocedure/:centre" and "/lineproc/:centre"

Tags: API

Changes/ Bug Fixes

No fixes added in this update


New release:

March 4, 2020

Additions/ New Features

Change in "ageInWeeks" field of "experimentProcedures" datatype. Updating the field "ageInWeeks" to "ageAtExperiment". This will help in returning the correct unit of age on the basis of type of specimen. If it is an embryo or mouse it will return the result in "DPC" and in "weeks" respectively.

Tags: API

Changes/ Bug Fixes

No fixes added in this update


New release:

January 6, 2020

Additions/ New Features

Default pagination is added on procedures/specimens for calls "/issues/zip/:zipIdOrFilename", "/xml/:idOrFilename" and "/zip/:zipIdOrFilename/:xmlIdOrFilename".

Tags: API

Changes/ Bug Fixes

Fixed listing of files with zip level issue.


New release:

November 22, 2019

Additions/ New Features

Returning list on the basis of "updatedSinceDate" rather than "createdSinceDate" for few calls.

Tags: API

Changes/ Bug Fixes

Fixed connection timeout and cache issues.


New release:

October 2, 2019

Additions/ New Features

No features added in this update

Changes/ Bug Fixes

Fixed processing of date for some calls.

Added lastUpdated field.