Back to All

November 2020

over 3 years ago by Brett Cooke
  • Removed potentially misleading triage object from triage_explanation → potential_condition in results
    • Endpoint: results_read (GET /results/{{token}}/)
    • Response body schema change: Removed the triage attribute found at triage_explanation.potential_condition.triage
    • Rationale: The removed triage object created confusion when compared the top level triage object. For clarity and simplicity, we are removing triage_explanation.potential_condition.triage. If needed, please use the top level triage object.
  • Question options payload has been updated
    • Endpoints:
      • questions_list (GET /questions/)
      • questions_read (GET /questions/{{token}})
    • Response body schema change: added free_text attribute to objects in options[]
    • Rationale: for options where free_text is true (e.g. “Something else”), the client can choose to populate the extra attribute in the question answer
  • Alt text now available on questions and options
    • Endpoints:
      • questions_list (GET /questions/)
      • questions_read (GET /questions/{{token}}/)
    • Response body schema change: added media_alttext attribute to the top level of the response body and to objects in options[]
    • Rationale: alt text enables clients to implement more accessible experiences