PUT
/
assessment
/
api
/
v1
/
continue
/
{assessment_id}
/
{qid}
curl --request PUT \
  --url https://api.eka.care/assessment/api/v1/continue/{assessment_id}/{qid} \
  --header 'Content-Type: application/json' \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>' \
  --data '{
  "user_response": [
    {
      "selected_choices": [
        {
          "choice_id": "test-choice-1",
          "choice_label": "Fever"
        }
      ]
    }
  ]
}'
{
    "questions": [
        {
            "qid": 0,
            "component_code": "I-ATSG",
            "question_text": "Add all symptoms",
            "tip": "Type here to search for symptoms.",
            "component_data": {
                "url": {
                    "base_url": "https://mdb.dev.eka.care/v1/sa-terms",
                    "query_params": {
                        "gender": "m",
                        "age": "23",
                        "src": "sn"
                    },
                    "search_query_param": "q"
                },
                "autosuggest_static_choices": {
                    "sections": [
                        {
                            "section_title": "Most Searched",
                            "choices": [
                                {
                                    "id": "47258974-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Fever"
                                },
                                {
                                    "id": "473f9e54-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Constipation"
                                },
                                {
                                    "id": "471e8e62-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Cough"
                                },
                                {
                                    "id": "476efd70-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Acidity"
                                },
                                {
                                    "id": "4736971e-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Diarrhoea"
                                },
                                {
                                    "id": "4737ee0c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Vomiting"
                                },
                                {
                                    "id": "4720607a-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Headache",
                                    "is_selected": true
                                },
                                {
                                    "id": "47172c6c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Stomach ache"
                                }
                            ]
                        }
                    ]
                }
            },
            "is_mandatory": true
        }
    ],
    "progress": "0.00",
    "is_last_question": false
}

{
    "questions": [
        {
            "qid": 0,
            "component_code": "I-ATSG",
            "question_text": "Add all symptoms",
            "tip": "Type here to search for symptoms.",
            "component_data": {
                "url": {
                    "base_url": "https://mdb.dev.eka.care/v1/sa-terms",
                    "query_params": {
                        "gender": "m",
                        "age": "23",
                        "src": "sn"
                    },
                    "search_query_param": "q"
                },
                "autosuggest_static_choices": {
                    "sections": [
                        {
                            "section_title": "Most Searched",
                            "choices": [
                                {
                                    "id": "47258974-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Fever"
                                },
                                {
                                    "id": "473f9e54-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Constipation"
                                },
                                {
                                    "id": "471e8e62-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Cough"
                                },
                                {
                                    "id": "476efd70-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Acidity"
                                },
                                {
                                    "id": "4736971e-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Diarrhoea"
                                },
                                {
                                    "id": "4737ee0c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Vomiting"
                                },
                                {
                                    "id": "4720607a-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Headache",
                                    "is_selected": true
                                },
                                {
                                    "id": "47172c6c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Stomach ache"
                                }
                            ]
                        }
                    ]
                }
            },
            "is_mandatory": true
        }
    ],
    "progress": "0.00",
    "is_last_question": false
}

The hash in the URL is the unique identifier for the assessment which was provided in the response of init assessment API. The qid in the URL is the unique identifier for the question starting from 0 (first question).

Refer to the list component documentation for different question compoent response format.

Authorizations

​
auth
string
header
required

The authentication token of the developer (generated using Authorization API).

Headers

​
client-id
string
required

Any unique string to identify the logged in developer.

Example:

"test-client"

​
locale
enum<string>

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
Example:

"en"

Path Parameters

​
assessment_id
string
required

The hash that uniquely identifies the assessment session.

​
qid
integer
required

The question id that uniquely identifies the question.

Body

application/json

The request body should contain the answer to the question depending on the type of question component. It should be in format as explained in above dropdown.

Response

200
application/json

OK

The response is of type object.

PUT
/
assessment
/
api
/
v1
/
continue
/
{assessment_id}
/
{qid}
curl --request PUT \
  --url https://api.eka.care/assessment/api/v1/continue/{assessment_id}/{qid} \
  --header 'Content-Type: application/json' \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>' \
  --data '{
  "user_response": [
    {
      "selected_choices": [
        {
          "choice_id": "test-choice-1",
          "choice_label": "Fever"
        }
      ]
    }
  ]
}'
{
    "questions": [
        {
            "qid": 0,
            "component_code": "I-ATSG",
            "question_text": "Add all symptoms",
            "tip": "Type here to search for symptoms.",
            "component_data": {
                "url": {
                    "base_url": "https://mdb.dev.eka.care/v1/sa-terms",
                    "query_params": {
                        "gender": "m",
                        "age": "23",
                        "src": "sn"
                    },
                    "search_query_param": "q"
                },
                "autosuggest_static_choices": {
                    "sections": [
                        {
                            "section_title": "Most Searched",
                            "choices": [
                                {
                                    "id": "47258974-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Fever"
                                },
                                {
                                    "id": "473f9e54-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Constipation"
                                },
                                {
                                    "id": "471e8e62-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Cough"
                                },
                                {
                                    "id": "476efd70-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Acidity"
                                },
                                {
                                    "id": "4736971e-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Diarrhoea"
                                },
                                {
                                    "id": "4737ee0c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Vomiting"
                                },
                                {
                                    "id": "4720607a-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Headache",
                                    "is_selected": true
                                },
                                {
                                    "id": "47172c6c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Stomach ache"
                                }
                            ]
                        }
                    ]
                }
            },
            "is_mandatory": true
        }
    ],
    "progress": "0.00",
    "is_last_question": false
}

{
    "questions": [
        {
            "qid": 0,
            "component_code": "I-ATSG",
            "question_text": "Add all symptoms",
            "tip": "Type here to search for symptoms.",
            "component_data": {
                "url": {
                    "base_url": "https://mdb.dev.eka.care/v1/sa-terms",
                    "query_params": {
                        "gender": "m",
                        "age": "23",
                        "src": "sn"
                    },
                    "search_query_param": "q"
                },
                "autosuggest_static_choices": {
                    "sections": [
                        {
                            "section_title": "Most Searched",
                            "choices": [
                                {
                                    "id": "47258974-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Fever"
                                },
                                {
                                    "id": "473f9e54-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Constipation"
                                },
                                {
                                    "id": "471e8e62-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Cough"
                                },
                                {
                                    "id": "476efd70-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Acidity"
                                },
                                {
                                    "id": "4736971e-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Diarrhoea"
                                },
                                {
                                    "id": "4737ee0c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Vomiting"
                                },
                                {
                                    "id": "4720607a-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Headache",
                                    "is_selected": true
                                },
                                {
                                    "id": "47172c6c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Stomach ache"
                                }
                            ]
                        }
                    ]
                }
            },
            "is_mandatory": true
        }
    ],
    "progress": "0.00",
    "is_last_question": false
}

The hash in the URL is the unique identifier for the assessment which was provided in the response of init assessment API. The qid in the URL is the unique identifier for the question starting from 0 (first question).

Refer to the list component documentation for different question compoent response format.

Authorizations

​
auth
string
header
required

The authentication token of the developer (generated using Authorization API).

Headers

​
client-id
string
required

Any unique string to identify the logged in developer.

Example:

"test-client"

​
locale
enum<string>

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
Example:

"en"

Path Parameters

​
assessment_id
string
required

The hash that uniquely identifies the assessment session.

​
qid
integer
required

The question id that uniquely identifies the question.

Body

application/json

The request body should contain the answer to the question depending on the type of question component. It should be in format as explained in above dropdown.

Response

200
application/json

OK

The response is of type object.