Skip to main content
POST
/
unified
/
lms
/
users
/
{id}
/
completions
Create User Completion
curl --request POST \
  --url https://api.stackone.com/unified/lms/users/{id}/completions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "learning_object_external_reference": "learning-content-123",
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "result": {
    "source_value": "<string>"
  },
  "completed_at": "2021-07-21T14:00:00.000Z",
  "learning_object_id": "e3gd34-23tr21-er234-345er56",
  "time_spent": "PT1H30M45S",
  "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
  "content_id": "16873-ENG-VIDEO-1",
  "score": {
    "percentage": 87,
    "raw_value": "87 / 100"
  }
}
'
import requests

url = "https://api.stackone.com/unified/lms/users/{id}/completions"

payload = {
    "learning_object_external_reference": "learning-content-123",
    "passthrough": { "other_known_names": "John Doe" },
    "result": { "source_value": "<string>" },
    "completed_at": "2021-07-21T14:00:00.000Z",
    "learning_object_id": "e3gd34-23tr21-er234-345er56",
    "time_spent": "PT1H30M45S",
    "content_external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT",
    "content_id": "16873-ENG-VIDEO-1",
    "score": {
        "percentage": 87,
        "raw_value": "87 / 100"
    }
}
headers = {
    "x-account-id": "<x-account-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-account-id': '<x-account-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    learning_object_external_reference: 'learning-content-123',
    passthrough: {other_known_names: 'John Doe'},
    result: {source_value: '<string>'},
    completed_at: '2021-07-21T14:00:00.000Z',
    learning_object_id: 'e3gd34-23tr21-er234-345er56',
    time_spent: 'PT1H30M45S',
    content_external_reference: 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT',
    content_id: '16873-ENG-VIDEO-1',
    score: {percentage: 87, raw_value: '87 / 100'}
  })
};

fetch('https://api.stackone.com/unified/lms/users/{id}/completions', 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.stackone.com/unified/lms/users/{id}/completions",
  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([
    'learning_object_external_reference' => 'learning-content-123',
    'passthrough' => [
        'other_known_names' => 'John Doe'
    ],
    'result' => [
        'source_value' => '<string>'
    ],
    'completed_at' => '2021-07-21T14:00:00.000Z',
    'learning_object_id' => 'e3gd34-23tr21-er234-345er56',
    'time_spent' => 'PT1H30M45S',
    'content_external_reference' => 'SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT',
    'content_id' => '16873-ENG-VIDEO-1',
    'score' => [
        'percentage' => 87,
        'raw_value' => '87 / 100'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "x-account-id: <x-account-id>"
  ],
]);

$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.stackone.com/unified/lms/users/{id}/completions"

	payload := strings.NewReader("{\n  \"learning_object_external_reference\": \"learning-content-123\",\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  },\n  \"result\": {\n    \"source_value\": \"<string>\"\n  },\n  \"completed_at\": \"2021-07-21T14:00:00.000Z\",\n  \"learning_object_id\": \"e3gd34-23tr21-er234-345er56\",\n  \"time_spent\": \"PT1H30M45S\",\n  \"content_external_reference\": \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT\",\n  \"content_id\": \"16873-ENG-VIDEO-1\",\n  \"score\": {\n    \"percentage\": 87,\n    \"raw_value\": \"87 / 100\"\n  }\n}")

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

	req.Header.Add("x-account-id", "<x-account-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.stackone.com/unified/lms/users/{id}/completions")
  .header("x-account-id", "<x-account-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"learning_object_external_reference\": \"learning-content-123\",\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  },\n  \"result\": {\n    \"source_value\": \"<string>\"\n  },\n  \"completed_at\": \"2021-07-21T14:00:00.000Z\",\n  \"learning_object_id\": \"e3gd34-23tr21-er234-345er56\",\n  \"time_spent\": \"PT1H30M45S\",\n  \"content_external_reference\": \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT\",\n  \"content_id\": \"16873-ENG-VIDEO-1\",\n  \"score\": {\n    \"percentage\": 87,\n    \"raw_value\": \"87 / 100\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/unified/lms/users/{id}/completions")

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

request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"learning_object_external_reference\": \"learning-content-123\",\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  },\n  \"result\": {\n    \"source_value\": \"<string>\"\n  },\n  \"completed_at\": \"2021-07-21T14:00:00.000Z\",\n  \"learning_object_id\": \"e3gd34-23tr21-er234-345er56\",\n  \"time_spent\": \"PT1H30M45S\",\n  \"content_external_reference\": \"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT\",\n  \"content_id\": \"16873-ENG-VIDEO-1\",\n  \"score\": {\n    \"percentage\": 87,\n    \"raw_value\": \"87 / 100\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}
{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}
{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 412,
  "message": "Precondition failed",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Path Parameters

​
id
string
required

Body

application/json
​
learning_object_external_reference
string
required

The external reference of the learning object associated with this completion, this is the main identifier for creating completions.

Example:

"learning-content-123"

​
passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }
​
result
object | null

The result of the completion

​
completed_at
string<date-time> | null

The date the content was completed

Example:

"2021-07-21T14:00:00.000Z"

​
learning_object_id
string | null

The id of the learning object associated with this completion. This is not required unless specified in an integration.

Example:

"e3gd34-23tr21-er234-345er56"

​
time_spent
string<string> | null

ISO 8601 duration format representing the time spent on completing the learning object

Example:

"PT1H30M45S"

​
content_external_reference
string | null
deprecated

The external reference associated with this content

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1-CONTENT"

​
content_id
string | null
deprecated

The content ID associated with this completion

Example:

"16873-ENG-VIDEO-1"

​
score
object | null

The score associated with this completion

Example:
{ "percentage": 87, "raw_value": "87 / 100" }

Response

The completion was created successfully.

​
statusCode
number
required
Example:

201

​
message
string
required
Example:

"Record created successfully."

​
timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"

​
data
object
required