Get user course item result

POST

public

get-user-course-item-result

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-user-course-item-result \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "courseItemId": "<string>",
        "userId": "<string>",
        "userEmail": "[email protected]"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "result": {
          "isMarkedAsCompleted": true,
          "details": {
            "courseItemType": "Quiz",
            "quizUniqueId": "<string>",
            "questions": [
              {
                "questionUniqueId": "<string>",
                "selectedOptionIds": [
                  "<string>"
                ]
              }
            ]
          }
        }
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.courseItemId

string

required

ID of the course item.

data.data.userId

string

Internal userId you have been using for the user in your database

data.data.userEmail

string<email>

Email of the user

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.result

object

required

Result data for the course item

Show child attributes

output.data.result.isMarkedAsCompleted

boolean

required

Whether the course item has been marked as completed

output.data.result.details

object

required

Details specific to the course item result

Show child attributes

output.data.result.details.courseItemType

enum<string>

required

Type of course item, currently only Quiz is supported

Available options:

Quiz

output.data.result.details.quizUniqueId

string

required

Unique identifier for the quiz

output.data.result.details.questions

object[]

required

List of questions and their selected answers

Show child attributes

output.data.result.details.questions.questionUniqueId

string

required

Unique identifier for the question

output.data.result.details.questions.selectedOptionIds

string[]

required

Array of selected option IDs for this question

Submit user course item Submit a course item for a given user Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 60 requests in a window of 1m.

⌘I

Get user course item result

curl --request POST \
  --url https://backend.codedamn.com/api/public/get-user-course-item-result \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "courseItemId": "<string>",
        "userId": "<string>",
        "userEmail": "[email protected]"
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "result": {
          "isMarkedAsCompleted": true,
          "details": {
            "courseItemType": "Quiz",
            "quizUniqueId": "<string>",
            "questions": [
              {
                "questionUniqueId": "<string>",
                "selectedOptionIds": [
                  "<string>"
                ]
              }
            ]
          }
        }
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response