Adobe Captivate · JSON Structure

Prime Api Enrollment Create Request Structure

Request body for creating an enrollment

Type: object Properties: 1 Required: 1
AuthoringEducationeLearningLMSSCORMTrainingxAPI

EnrollmentCreateRequest is a JSON Structure definition published by Adobe Captivate, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-captivate/refs/heads/main/json-structure/prime-api-enrollment-create-request-structure.json",
  "name": "EnrollmentCreateRequest",
  "description": "Request body for creating an enrollment",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "object",
      "required": [
        "type",
        "attributes"
      ],
      "properties": {
        "type": {
          "type": "string",
          "const": "enrollment"
        },
        "attributes": {
          "type": "object",
          "properties": {
            "loInstanceId": {
              "type": "string",
              "description": "ID of the learning object instance to enroll in"
            }
          }
        },
        "relationships": {
          "type": "object",
          "properties": {
            "loInstance": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "description": "JSON:API resource identifier",
                  "required": [
                    "id",
                    "type"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Resource identifier"
                    },
                    "type": {
                      "type": "string",
                      "description": "Resource type name"
                    }
                  }
                }
              }
            },
            "learner": {
              "type": "object",
              "properties": {
                "data": {
                  "type": "object",
                  "description": "JSON:API resource identifier",
                  "required": [
                    "id",
                    "type"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Resource identifier"
                    },
                    "type": {
                      "type": "string",
                      "description": "Resource type name"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}