Create assessment
curl --request POST \
--url https://staging.api.soludesks.com/v1/external/learnhub/assessments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"title": "Final project",
"description": "Submit your work.",
"questions": []
}
'import requests
url = "https://staging.api.soludesks.com/v1/external/learnhub/assessments"
payload = {
"title": "Final project",
"description": "Submit your work.",
"questions": []
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({title: 'Final project', description: 'Submit your work.', questions: []})
};
fetch('https://staging.api.soludesks.com/v1/external/learnhub/assessments', 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://staging.api.soludesks.com/v1/external/learnhub/assessments",
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([
'title' => 'Final project',
'description' => 'Submit your work.',
'questions' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://staging.api.soludesks.com/v1/external/learnhub/assessments"
payload := strings.NewReader("{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "<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://staging.api.soludesks.com/v1/external/learnhub/assessments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.soludesks.com/v1/external/learnhub/assessments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"source": "MANUAL_CREATION",
"type": "VIRTUAL",
"organization_strategy": "SINGLE_CANDIDATE",
"seat_layout": "CIRCLE",
"duration_hours": 123,
"duration_minutes": 123,
"status": "DRAFT",
"total_points": "<string>",
"questions_count": "<string>",
"start_datetime": "2023-11-07T05:31:56Z",
"submission_date": "2023-12-25",
"deadline_datetime": "2023-11-07T05:31:56Z",
"locked_datetime": "2023-11-07T05:31:56Z",
"results_released_datetime": "2023-11-07T05:31:56Z",
"maximum_attempts": "<string>",
"effective_auto_release_result": "<string>",
"effective_camera_proctoring_enabled": "<string>",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": "beginner",
"description": "<string>",
"source": "MANUAL_CREATION",
"requirements": "<string>",
"status": "DRAFT",
"categories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
}
],
"has_enrollments": true,
"quizzes_count": 123,
"cover_image_url": "<string>",
"preview_video_url": "<string>",
"preview_video_status": "<string>",
"preview_video_ready": "<string>",
"preview_video_error": "<string>",
"preview_video_has_subtitles": true,
"preview_video_playback_endpoint": "<string>",
"instructors": "<string>",
"overall_duration_seconds": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
},
"locations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"address": "<string>",
"capacity": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"learner_ids": "<string>",
"learners": "<string>"
}
],
"seats": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seat_number": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"address": "<string>",
"capacity": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
},
"learner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"learner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"status": "ACTIVE"
}
}
],
"passing_score_percent": 123,
"passing_score_points": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z",
"questions": "<string>"
},
"errors": [
{}
]
}{
"status": 400,
"success": false,
"code": "REQUEST_FAILED",
"message": "Bad request.",
"data": null,
"errors": []
}{
"status": 401,
"success": false,
"code": "REQUEST_FAILED",
"message": "Missing or invalid API key.",
"data": null,
"errors": []
}{
"status": 403,
"success": false,
"code": "REQUEST_FAILED",
"message": "Permission denied, inactive service provider, or unsupported key mode.",
"data": null,
"errors": []
}{
"status": 404,
"success": false,
"code": "REQUEST_FAILED",
"message": "Resource not found.",
"data": null,
"errors": []
}{
"status": 409,
"success": false,
"code": "REQUEST_FAILED",
"message": "Idempotency conflict or request already in progress.",
"data": null,
"errors": []
}{
"status": 422,
"success": false,
"code": "REQUEST_FAILED",
"message": "Validation failed.",
"data": null,
"errors": []
}{
"status": 429,
"success": false,
"code": "REQUEST_FAILED",
"message": "Rate limit exceeded.",
"data": null,
"errors": []
}{
"status": 500,
"success": false,
"code": "REQUEST_FAILED",
"message": "Internal server error.",
"data": null,
"errors": []
}Assessments
Create Assessment
Create assessment through SoluDesks APIs.
This resource is tenant-only. Tenant API keys can use it when the key has the required LearnHub permissions. Service-provider API keys are not supported for this resource. Create requests require a unique Idempotency-Key header.
POST
/
v1
/
external
/
learnhub
/
assessments
Create assessment
curl --request POST \
--url https://staging.api.soludesks.com/v1/external/learnhub/assessments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"title": "Final project",
"description": "Submit your work.",
"questions": []
}
'import requests
url = "https://staging.api.soludesks.com/v1/external/learnhub/assessments"
payload = {
"title": "Final project",
"description": "Submit your work.",
"questions": []
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({title: 'Final project', description: 'Submit your work.', questions: []})
};
fetch('https://staging.api.soludesks.com/v1/external/learnhub/assessments', 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://staging.api.soludesks.com/v1/external/learnhub/assessments",
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([
'title' => 'Final project',
'description' => 'Submit your work.',
'questions' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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://staging.api.soludesks.com/v1/external/learnhub/assessments"
payload := strings.NewReader("{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "<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://staging.api.soludesks.com/v1/external/learnhub/assessments")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.soludesks.com/v1/external/learnhub/assessments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Final project\",\n \"description\": \"Submit your work.\",\n \"questions\": []\n}"
response = http.request(request)
puts response.read_body{
"status": 123,
"success": true,
"code": "<string>",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"description": "<string>",
"source": "MANUAL_CREATION",
"type": "VIRTUAL",
"organization_strategy": "SINGLE_CANDIDATE",
"seat_layout": "CIRCLE",
"duration_hours": 123,
"duration_minutes": 123,
"status": "DRAFT",
"total_points": "<string>",
"questions_count": "<string>",
"start_datetime": "2023-11-07T05:31:56Z",
"submission_date": "2023-12-25",
"deadline_datetime": "2023-11-07T05:31:56Z",
"locked_datetime": "2023-11-07T05:31:56Z",
"results_released_datetime": "2023-11-07T05:31:56Z",
"maximum_attempts": "<string>",
"effective_auto_release_result": "<string>",
"effective_camera_proctoring_enabled": "<string>",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": "beginner",
"description": "<string>",
"source": "MANUAL_CREATION",
"requirements": "<string>",
"status": "DRAFT",
"categories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
}
],
"has_enrollments": true,
"quizzes_count": 123,
"cover_image_url": "<string>",
"preview_video_url": "<string>",
"preview_video_status": "<string>",
"preview_video_ready": "<string>",
"preview_video_error": "<string>",
"preview_video_has_subtitles": true,
"preview_video_playback_endpoint": "<string>",
"instructors": "<string>",
"overall_duration_seconds": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
},
"locations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"address": "<string>",
"capacity": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
}
],
"groups": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"learner_ids": "<string>",
"learners": "<string>"
}
],
"seats": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seat_number": "<string>",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"address": "<string>",
"capacity": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z"
},
"learner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"learner": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"staff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"full_name": "<string>",
"email": "<string>",
"status": "ACTIVE"
}
}
],
"passing_score_percent": 123,
"passing_score_points": 123,
"created_datetime": "2023-11-07T05:31:56Z",
"updated_datetime": "2023-11-07T05:31:56Z",
"questions": "<string>"
},
"errors": [
{}
]
}{
"status": 400,
"success": false,
"code": "REQUEST_FAILED",
"message": "Bad request.",
"data": null,
"errors": []
}{
"status": 401,
"success": false,
"code": "REQUEST_FAILED",
"message": "Missing or invalid API key.",
"data": null,
"errors": []
}{
"status": 403,
"success": false,
"code": "REQUEST_FAILED",
"message": "Permission denied, inactive service provider, or unsupported key mode.",
"data": null,
"errors": []
}{
"status": 404,
"success": false,
"code": "REQUEST_FAILED",
"message": "Resource not found.",
"data": null,
"errors": []
}{
"status": 409,
"success": false,
"code": "REQUEST_FAILED",
"message": "Idempotency conflict or request already in progress.",
"data": null,
"errors": []
}{
"status": 422,
"success": false,
"code": "REQUEST_FAILED",
"message": "Validation failed.",
"data": null,
"errors": []
}{
"status": 429,
"success": false,
"code": "REQUEST_FAILED",
"message": "Rate limit exceeded.",
"data": null,
"errors": []
}{
"status": 500,
"success": false,
"code": "REQUEST_FAILED",
"message": "Internal server error.",
"data": null,
"errors": []
}Authorizations
External API key. Format: Bearer <API_KEY>
Headers
Unique client-generated key used to safely retry create requests.
Body
application/json
Required string length:
1 - 255Minimum string length:
1VIRTUAL- VirtualPHYSICAL- Physical
Available options:
VIRTUAL, PHYSICAL MANUAL_CREATION- Manual CreationAI_GENERATED- AI GeneratedDOCUMENT_EXTRACTION- Document Extraction
Available options:
MANUAL_CREATION, AI_GENERATED, DOCUMENT_EXTRACTION SINGLE_CANDIDATE- Single CandidateGROUP- Group
Available options:
SINGLE_CANDIDATE, GROUP CIRCLE- CircleGRID- GridL- LU- URECTANGLE- Rectangle
Available options:
CIRCLE, GRID, L, U, RECTANGLE Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647DRAFT- DraftPUBLISHED- PublishedARCHIVED- Archived
Available options:
DRAFT, PUBLISHED, ARCHIVED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes