Get a questionnaire with its result
curl --request GET \
--url https://{your-prod-endpoint}/v1/protocol-runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{your-prod-endpoint}/v1/protocol-runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{your-prod-endpoint}/v1/protocol-runs/{runId}', 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://{your-prod-endpoint}/v1/protocol-runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{your-prod-endpoint}/v1/protocol-runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{your-prod-endpoint}/v1/protocol-runs/{runId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-prod-endpoint}/v1/protocol-runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence_number": 123,
"questionnaire_status": "pending",
"language": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"origin": "dispatcher_scheduled",
"cancel_reason": "<string>",
"custom_variable_values": {},
"score": 123,
"score_class": "<string>",
"effective_score_class": "<string>",
"score_class_overridden": true,
"score_unavailable_reason": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"review_note": "<string>",
"protocol": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"protocol_key": "<string>",
"title": "<string>"
},
"protocol_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123
},
"patient": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"answers": [
{
"question_key": "<string>",
"question_text": "<string>",
"type": "text",
"status": "asked",
"asked_at": "2023-11-07T05:31:56Z",
"answered_at": "2023-11-07T05:31:56Z",
"call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": 123
}
],
"calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"call_direction": "inbound",
"disconnect_reason": "<string>",
"cancelled_reason": "<string>",
"opt_out_result": "accepted",
"language": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"has_recording": true,
"transcription": [
{
"speaker": "agent",
"content": "<string>",
"occurred_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Protocol Runs
Get a questionnaire with its result
Returns the questionnaire with answers (one entry per question it reached, carrying the wording, the outcome and the value by key), the calls with their transcription, a patient summary and the score. Protocol and version travel as summaries: for the questionnaire definition, call GET /v1/protocols/{idOrKey}.
GET
/
v1
/
protocol-runs
/
{runId}
Get a questionnaire with its result
curl --request GET \
--url https://{your-prod-endpoint}/v1/protocol-runs/{runId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{your-prod-endpoint}/v1/protocol-runs/{runId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{your-prod-endpoint}/v1/protocol-runs/{runId}', 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://{your-prod-endpoint}/v1/protocol-runs/{runId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://{your-prod-endpoint}/v1/protocol-runs/{runId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{your-prod-endpoint}/v1/protocol-runs/{runId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-prod-endpoint}/v1/protocol-runs/{runId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrollment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sequence_number": 123,
"questionnaire_status": "pending",
"language": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"origin": "dispatcher_scheduled",
"cancel_reason": "<string>",
"custom_variable_values": {},
"score": 123,
"score_class": "<string>",
"effective_score_class": "<string>",
"score_class_overridden": true,
"score_unavailable_reason": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"review_note": "<string>",
"protocol": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"protocol_key": "<string>",
"title": "<string>"
},
"protocol_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123
},
"patient": {
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>"
},
"answers": [
{
"question_key": "<string>",
"question_text": "<string>",
"type": "text",
"status": "asked",
"asked_at": "2023-11-07T05:31:56Z",
"answered_at": "2023-11-07T05:31:56Z",
"call_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": 123
}
],
"calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"call_direction": "inbound",
"disconnect_reason": "<string>",
"cancelled_reason": "<string>",
"opt_out_result": "accepted",
"language": "<string>",
"scheduled_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"has_recording": true,
"transcription": [
{
"speaker": "agent",
"content": "<string>",
"occurred_at": "2023-11-07T05:31:56Z"
}
]
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}