Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Web-Services provides programmatic access to the breast and ovarian cancer risk models.

Patient identifiable data is not needed to run the risk calculations and the client software should remove names to de-identify the data before submitting the request to the web-service.

To avoid possible slowdown of the CanRisk tool website, it is requested that users of the web-services submit only small data sets for short periods during the week and larger sets over the weekends. It is best to submit requests to the service intermittently in small batches. Maximum throttle rates may be applied to the web-service usage to help manage resources. Please contact us if you do need to submit large data sets so we can help with scheduling.

All requests to the web-services are made over HTTPS. 

Data is sent to and from the web-service in JSON format.

An authentication token can be requested using the ‘auth-token’ web-service and added to the request authorisation headers.