Get Assessment Data

This API retrieves the assessment data for a given assessment ID. The assessment data includes all the available information about practitioner, patient and questionnaire.

GET /assessment/api/v1/questionnaire_data/{assessment_id}/

Get Assessment Data

cURL

curl --request GET \
  --url https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/ \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>' \
  --header 'content-type: <content-type>'

import requests

url = "https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/"

headers = {
    "client-id": "<client-id>",
    "content-type": "<content-type>",
    "auth": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'client-id': '<client-id>',
    'content-type': '<content-type>',
    auth: '<api-key>'
  }
};

fetch('https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "auth: <api-key>",
    "client-id: <client-id>",
    "content-type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("client-id", "<client-id>")
	req.Header.Add("content-type", "<content-type>")
	req.Header.Add("auth", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/")
  .header("client-id", "<client-id>")
  .header("content-type", "<content-type>")
  .header("auth", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/assessment/api/v1/questionnaire_data/{assessment_id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["client-id"] = '<client-id>'
request["content-type"] = '<content-type>'
request["auth"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "practitioner": {
      "practitioner_uuid": "TEST-DR-123"
    },
    "patient": {
      "unique_identifier": "TEST-PATIENT-UNIQUE-123",
      "patient_uuid": "TEST-PATIENT-123",
      "age": 24,
      "gender": "m"
    },
    "questionnaire": [
      {
        "question": "What symptoms are you facing?",
        "answer": "Fever, Cough",
        "items": [
          {
            "question": "Fever",
            "answer": "99.5",
            "items": [
              {
                "question": "When did the fever start?",
                "answer": "2 days ago"
              }
            ]
          }
        ]
      }
    ]
  }
}

{
  "error": {
    "error_code": "bad_request",
    "display_message": "(Generic User friendly message)",
    "message": "(Server error message)"
  }
}

{
  "error": {
    "error_code": "server_error",
    "display_message": "(Generic User friendly message)",
    "message": "(Server error message)"
  }
}

The format of the response is as follows:

Response

{
    "data": {
        "practitioner": {
            "practitioner_uuid": "<string>"
        },
        "patient": {
            "unique_identifier": "<string>",
            "patient_uuid": "<string>",
            "age": "<integer>",
            "gender": "<m/f/o>",
        },
        "questionnaire": [
            {
                "question": "<string>",
                "answer": "<string>",
                "items": [
                    {
                        "question": "<string>",
                        "answer": "<string>"
                        "items": []
                    }
                ]
            },
        ]
    }
}

---

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.

content-type · enum<string> · required

Available options: application/json

Example:

"application/json"

Path Parameters

assessment_id · string · required

The hash that uniquely identifies the assessment session.

Response

200

application/json

OK

data · object

Show child attributes