Skip to main content
POST
/
v1
/
scorm
Create a SCORM package
curl --request POST \
  --url https://api.example.com/v1/scorm \
  --header 'Content-Type: application/json' \
  --data '
{
  "cohort_id": "<string>",
  "version": {},
  "runtime_base_url": "<string>"
}
'
import requests

url = "https://api.example.com/v1/scorm"

payload = {
"cohort_id": "<string>",
"version": {},
"runtime_base_url": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({cohort_id: '<string>', version: {}, runtime_base_url: '<string>'})
};

fetch('https://api.example.com/v1/scorm', 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.example.com/v1/scorm",
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([
'cohort_id' => '<string>',
'version' => [

],
'runtime_base_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/v1/scorm"

payload := strings.NewReader("{\n \"cohort_id\": \"<string>\",\n \"version\": {},\n \"runtime_base_url\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

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://api.example.com/v1/scorm")
.header("Content-Type", "application/json")
.body("{\n \"cohort_id\": \"<string>\",\n \"version\": {},\n \"runtime_base_url\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/scorm")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"cohort_id\": \"<string>\",\n \"version\": {},\n \"runtime_base_url\": \"<string>\"\n}"

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

Body

cohort_id
string
required
version
enum
default:"2004"
1.2 | 2004.
runtime_base_url
string
Override the runtime’s API target. Defaults to https://api.hawkings.education.

Examples

const pkg = await hk.scorm.create({ cohort_id: "coh_123", version: "2004" });

const ready = await hk.poll(
  () => hk.scorm.retrieve(pkg.id),
  { until: p => p.status === "ready" },
);
$pkg = $hk->scorm->create(['cohort_id' => 'coh_123', 'version' => '2004']);

$ready = $hk->poll(
    fn () => $hk->scorm->retrieve($pkg->id),
    ['until' => fn ($p) => $p->status === 'ready'],
);

Returns

A ScormPackage in status: "pending".