The API uses the assessmentid
generated from the init assessment API to start the assessment.
The reponse of the API will depend on the type of the component that is being used to ask the question.
Refer to the Assessment Response Format documentation for different question component response format.
API Details The authentication token of the developer (generated using Authorization API).
Any unique string to identify the logged in developer.
Locale is used to determine the language of the assessment. Supported locales are en
, hi
, kn
for english, hindi and kannada respectively with default being en
.
Available options:
en
,
hi
,
kn
The hash that uniquely identifies the assessment session.
Master Response ATSG Response Radio Response Multi Select Response Radio Group Response This is a boolean value . If true, this is the last question of the assessment and you can hit submit API.
This is the progress of the assessment in percentage format. It is a number between 0.00 and 100.00 .
Required range: 0 < x < 100
questions.component_data. autosuggest_static_choices
This is valid only for autosuggest component . It contains the section wise static choices to be shown to users at first.
questions.component_data.autosuggest_static_choices. sections
questions.component_data.autosuggest_static_choices.sections. choices
questions.component_data.autosuggest_static_choices.sections. section_title
This is the title of the section
questions.component_data. choices
Valid only for choice type components - multi choice, radio (single choice) and radio group
questions.component_data.choices. choice_id
questions.component_data.choices. choice_label
questions.component_data.choices. qualifier
questions.component_data.choices.qualifier. id
Available options:
p
,
a
,
u
questions.component_data.choices.qualifier. label
Available options:
Yes
,
No
,
Don't Know
questions.component_data.choices.qualifier. is_selected
questions.component_data.choices. is_selected
This is a boolean value, if true
this choice is be selected by default
questions.component_data. url
Valid only for autosuggest component . This content should be used to get autosuggest choices for users. After combining all the requests, You can get a url like: https://example.eka.care?gender=m&age=23&src=sn&q
questions.component_data.url. base_url
Base URL for autosuggest API
questions.component_data.url. query_params
These are the query params to be sent with URL to get autosuggest choices.
questions.component_data.url.query_params. age
questions.component_data.url.query_params. gender
questions.component_data.url.query_params. src
questions.component_data.url. search_query_param
This is the question id. It is used to identify the question. its an integer, during start it will always be 0
This is a boolean value, if true user has to answer this question