Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Assessments

Step 3. Continue Assessment

This API is used to submit user answers and get the next questions based on the answers. <Tip>Call this API multiple times until the assessment is complete where is_last_question will be true </Tip>

put/assessment/api/v1/continue/{assessment_id}/{qid}

Path parameters

assessment_idstring required

The hash that uniquely identifies the assessment session.

qidinteger required

The question id that uniquely identifies the question.

Headers

client-idstring required

Any unique string to identify the logged in developer.

locale'en' | 'hi' | 'kn'
Example:en

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.

Request body

Example request

{
  "user_response": [
    {
      "selected_choices": [
        {
          "choice_id": "test-choice-1",
          "choice_label": "Fever"
        }
      ]
    }
  ]
}

Response

OK

OR
OR
OR
OR
OR

Example response

{
  "questions": [
    {
      "qid": 1,
      "component_code": "I-ATSG",
      "question_text": "Add all symptoms",
      "tip": "Type here to search for symptoms",
      "component_data": {
        "url": {
          "base_url": "https://example.eka.care",
          "query_params": {
            "gender": "m",
            "age": "21",
            "src": "sn"
          },
          "search_query_param": "q"
        },
        "autosuggest_static_choices": {
          "sections": [
            {
              "section_title": "Most Searched",
              "choices": [
                {
                  "id": "47258974-a65c-11eb-8d02-1e003a340630",
                  "common_name": "Fever"
                }
              ]
            }
          ]
        },
        "choices": [
          {
            "choice_id": "s_344147d6-b416-11eb-8c69-1sweet340631",
            "choice_label": "I have Diabetes",
            "qualifier": {
              "id": "p",
              "label": "Yes"
            },
            "is_selected": true
          }
        ]
      },
      "is_mandatory": true
    }
  ],
  "progress": 50
}