scorm.profile.suspending.attempt.schema.json

{
    "$schema": "http://json-schema.org/schema#",
    "id": "https://w3id.org/xapi/scorm/suspending-an-attempt/scorm.profile.suspending.attempt.schema",
    "description": "Profile ID: https://w3id.org/xapi/scorm/suspending-an-attempt See: https://github.com/adlnet/xAPI-SCORM-Profile/blob/master/xapi-scorm-profile.md#suspending-an-attempt",
    "type": "object",
    "required": ["actor", "verb", "object", "context", "timestamp"],
    "properties": {
        "actor": {
            "description": "Set to the learner's agent object"
        },
        "verb": {
            "description": "Set to the ADL Verb 'suspended'",
            "properties": {
                "id": {
                    "enum": ["http://adlnet.gov/expapi/verbs/suspended"]
                }
            }
        },
        "object": {
            "description": "Set to the activity object for the SCO, using the SCO IRI as the activity's ID",
            "required": ["definition"],
            "properties": {
                "id": {
                    "description": "Set to the SCO IRI"
                },
                "definition": {
                    "type": "object",
                    "required": ["type"],
                    "properties": {
                        "type": {
                            "description": "Set to 'http://adlnet.gov/expapi/activities/lesson'",
                            "enum": ["http://adlnet.gov/expapi/activities/lesson"]
                        }
                    }
                }
            }
        },
        "context": {
            "required": ["contextActivities"],
            "properties": {
                "contextActivities": {
                    "required": ["grouping", "category"],
                    "properties": {
                        "grouping": {
                            "description": "Set to include the attempt activity and the course activity",
                            "minItems": 2,
                            "items": [
                                {
                                    "properties": {
                                        "definition": {
                                            "properties": {
                                                "type": {"enum": ["http://adlnet.gov/expapi/activities/course"]}
                                            }
                                        }
                                    }
                                },
                                {
                                    "properties": {
                                        "definition": {
                                            "properties": {
                                                "type": {"enum": ["http://adlnet.gov/expapi/activities/attempt"]}
                                            }
                                        }
                                    }
                                }
                            ]
                        },
                        "category": {
                            "description": "Set to include the xAPI SCORM Profiles activity",
                            "minItems": 1,
                            "items": [
                                {
                                    "properties": {
                                        "id": {
                                            "enum": ["https://w3id.org/xapi/scorm"]
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            }
        },
        "timestamp": {
            "description": "Set to the time the attempt was suspended"
        },
        "result": {
            "description": "Set to the overall result for the SCO",
            "properties": {
                "success": {
                    "description": "If success_status of the SCO is known, success is true if success_status is passed, and false if success_status is failed"
                },
                "completion": {
                    "description": "If completion_status of the SCO is known, completion is true if completion_status is completed, and false if completion_status is incomplete"
                },
                "score": {
                    "description": "If score of the SCO is known, use the appropriate score property to store SCORM score data model elements, such as score.scaled for cmi.score.scaled"
                }
            }
        }
    }
}