Initialize questionnaire instance
curl --request POST \
--url https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"userId": "<string>",
"questionnaireId": "<string>",
"externalId": "<string>",
"metadata": {}
}
'import requests
url = "https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize"
payload = {
"userId": "<string>",
"questionnaireId": "<string>",
"externalId": "<string>",
"metadata": {}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
questionnaireId: '<string>',
externalId: '<string>',
metadata: {}
})
};
fetch('https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize', 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}/api/v1/questionnaire-status/initialize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'questionnaireId' => '<string>',
'externalId' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"instanceId": "<string>",
"status": "<string>"
}
}{
"status": "error",
"code": 123,
"error_code": "<string>",
"message": "<string>"
}Questionnaire Instances
Initialize questionnaire instance
Creates an instance for a user and questionnaire if it does not exist.
POST
/
api
/
v1
/
questionnaire-status
/
initialize
Initialize questionnaire instance
curl --request POST \
--url https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"userId": "<string>",
"questionnaireId": "<string>",
"externalId": "<string>",
"metadata": {}
}
'import requests
url = "https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize"
payload = {
"userId": "<string>",
"questionnaireId": "<string>",
"externalId": "<string>",
"metadata": {}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '<string>',
questionnaireId: '<string>',
externalId: '<string>',
metadata: {}
})
};
fetch('https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize', 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}/api/v1/questionnaire-status/initialize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '<string>',
'questionnaireId' => '<string>',
'externalId' => '<string>',
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize"
payload := strings.NewReader("{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{your-prod-endpoint}/api/v1/questionnaire-status/initialize")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"<string>\",\n \"questionnaireId\": \"<string>\",\n \"externalId\": \"<string>\",\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"instanceId": "<string>",
"status": "<string>"
}
}{
"status": "error",
"code": 123,
"error_code": "<string>",
"message": "<string>"
}Authorizations
API Key provided by Omniloy. The same key is used for inbound and outbound calls.
Body
application/json
⌘I