Advance Step
curl --request PATCH \
--url https://haico.gr/api/study/sessions/{session_id}/step \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step": "<string>"
}
'import requests
url = "https://haico.gr/api/study/sessions/{session_id}/step"
payload = { "step": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({step: '<string>'})
};
fetch('https://haico.gr/api/study/sessions/{session_id}/step', 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://haico.gr/api/study/sessions/{session_id}/step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'step' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://haico.gr/api/study/sessions/{session_id}/step"
payload := strings.NewReader("{\n \"step\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://haico.gr/api/study/sessions/{session_id}/step")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://haico.gr/api/study/sessions/{session_id}/step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"study_code": "<string>",
"current_step": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"participant_code": "<string>",
"condition_order": [],
"task_order": [],
"counterbalance_index": 0,
"completed_at": "2023-11-07T05:31:56Z",
"study_thread_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Study
Advance Step
Persist the resume point so a refresh continues where the user left off.
PATCH
/
api
/
study
/
sessions
/
{session_id}
/
step
Advance Step
curl --request PATCH \
--url https://haico.gr/api/study/sessions/{session_id}/step \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step": "<string>"
}
'import requests
url = "https://haico.gr/api/study/sessions/{session_id}/step"
payload = { "step": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({step: '<string>'})
};
fetch('https://haico.gr/api/study/sessions/{session_id}/step', 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://haico.gr/api/study/sessions/{session_id}/step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'step' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://haico.gr/api/study/sessions/{session_id}/step"
payload := strings.NewReader("{\n \"step\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://haico.gr/api/study/sessions/{session_id}/step")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://haico.gr/api/study/sessions/{session_id}/step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"study_code": "<string>",
"current_step": "<string>",
"status": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"participant_code": "<string>",
"condition_order": [],
"task_order": [],
"counterbalance_index": 0,
"completed_at": "2023-11-07T05:31:56Z",
"study_thread_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
A personal access token (haico_pat_...), created under Profile → API keys. Send it as Authorization: Bearer <key>. The browser session JWT is also accepted but is an internal mechanism and is not part of the public contract.
Path Parameters
Body
application/json
Required string length:
1 - 64Response
Successful Response
A study session as returned to the participant.
⌘I