Read question

get https://api.sandbox.buoyhealth.com/symptom-checker/v2/questions/{question_token}/

Retrieves an interview question.

Responses

Response body

object

token

uuid

A UUID-formatted token uniquely identifying a question.

text

string

length ≥ 1

A string containing the question text that should be displayed to a user.

choice

string

A string indicating the response type of a question. Either 'S' for single-choice, 'M' for multiple-choice, or 'D' for duration.

M S D

media

uri

An absolute URI linking to media. Clients should use the content-type of the associated file to determine how to display the file to the user.

options

array of objects

options

object

token

uuid

A UUID-formatted token uniquely identifying an answer option.

text

string

length ≥ 1

A string containing the answer option text that should be displayed to a user.

media

uri

An absolute URI linking to media. Clients should use the content-type of the associated file to determine how to display the file to the user.

exclusive

boolean

A flag indicating whether an answer option should not be submitted with other answer options. Answer options with the exclusive parameter set to True should not be returned with any other answer options.

media_alttext

string

length ≥ 1

A string providing alternative text for it's associated media.

free_text

boolean

A flag indicating whether free text from a user may be returned to Buoy in the extra parameter.

answer

array of objects

An array of selected answer options.

answer

object

token

uuid

A UUID-formatted token that indicates the user's selected answer option(s).

extra

string | null

A string in which API clients may return extra information in limited scenarios. "D"-type questions should return the duration, in hours, that a user has been experiencing a given condition. Clients may optionally return additional context when the free_text field is true.

interview

uuid

A UUID-formatted token uniquely identifying an interview instance.

media_alttext

string

length ≥ 1

A string providing alternative text for it's associated media.

_links

object

Conditional links that point to the next step of the interview.

string | null

Absolute URI for next the question in an interview.

result

string | null

Absolute URI for the result of an interview.

200OK

401Unauthorized

404Not Found