Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Assessments

Step 2. Start Assessment

This API is used to start and get the first question of the assessment. <Tip>Use this API to get the first question.</Tip>

put/assessment/api/v1/start/{assessment_id}

Path parameters

assessment_idstring required

The hash that uniquely identifies the assessment session.

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.

Response

OK

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
}