GET /v1/chatbot/question

The chatbot collects information from Patients by a question-answer flow. This endpoint is used to get next question of the check.

Request

Parameter name	Parameter type	Parameter description
`check-id`	string	The ID of the ongoing check
`language`	ClientLanguage	The expected language of the response

Parameter name	Parameter type	Parameter description
`optionTop`	number?	If provided, only the top `optionTop` optionItem will be included in the response. Can be used for paging and/or performance optimization purposes.
`optionSkip`	number?	If provided, the first `optionSkip` optionItem will not be included in the response. Can be used for paging and/or performance optimization purposes.
`optionSearchTerm`	string (localized text)?	User-entered search text. If provided, the optionItem list will include only the matching items. The resulting list of optionItems is sorted by relevancy. Space characters should be URL encoded. In some cases filtering happens by medical and not alphabetical logic, therefore the names or descriptions of results might not match exactly the search term.
`questionId`	string?	By calling this parameter, a recently asked question can be shown again.

Request Query Examples

URL	Purpose
`/v1/chatbot/question`	Using this endpoint without any additional parameter is its most frequent usecase. The endpoint without parameters returns to the last unanswered question with all its optionItems.
`/v1/chatbot/question?optionTop=10`	The response to question object will include only the top 10 optionItems. This parameter has no effect on the value of `options.count` in the response.
`/v1/chatbot/question?optionTop=10&optionSkip=10`	The response to question object will include optionItems from matching top 10 to 20. These parameters have no effect on the value of `options.count` in the response.
`/v1/chatbot/question?optionSearchTerm=tension%20headache`	The response to question object will only include optionItems matching the search term: “tension headache”.

The response is a Question model.