Items API Initialization

Defines how the assessment's start time is recorded by the server.

You would want to use this depending on your specific use case and preference for either having a precise initial time or dynamic time capturing.

The "hard" start time type will use the clock on the Learnosity server as the single source of time for the assessment. The start_time.value must be provided in the format of a UTC (Coordinated Universal Time) time string, for example, "20230815-0305", representing August 15th, 2023 at 3:05am UTC time.

Note When using the "hard" start time type, the show_intro initialization option will be automatically enabled. This ensures that learners are informed about the scheduled assessment start time.

With the "soft" start time type, the assessment can be started at any time and the start_time.value is not required. The Learnosity server records the UTC time when the learner first initiates the assessment as the starting time.

Important Pausing an assessment will not halt the timer when using this option. This design ensures the assessment's integrity and consistency.

Examples

// Using the "hard" option
var initializationOptions = {
    "config": {
        "time": {
            "start_time": {
                "type": "hard",
                "value": "20230815-1305"
            }
        }
    }
    // ...
};

// Using the "soft" option
var initializationOptions = {
    "config": {
        "time": {
            "start_time": {
                "type": "soft"
            }
        }
    }
    // ...
};

Values

Attribute path config.time.start_time.type

Type string

Possible values

• "hard" - start (and stop) the session at a controlled time.
• "soft" - the session can start at any time but, once started, the learner must complete it within the defined max_time. They will not be able to save and resume at a later point in time.

Caveats

In scenarios where reading mode is used with the "hard" option, the remaining reading time will be determined by calculating the difference between the provided UTC time value and the current UTC time on the server.

Versioning

Version added: v2023.3.LTS.