Initialization Option Items API

start_time

Defines the initial commencement time of a learner's assessment.

This option adds an additional layer of integrity for use in high-stakes assessments where learners must complete an assessment within a strictly enforced time frame.

You would want to specify this option so that you can schedule assessments within predetermined time frames, such as an assessment that is required to start at 3pm and end at 5pm on an exact date, when combined with the max_time initialization option and the "hard" start time value.

Examples

// Using "20230815-1305" as the date time would make it "August 15th, 2023 at 1:05pm UTC time"
// The specified UTC start time will automatically be converted to the corresponding
// local time for learners when the assessment is initialized using the Items API.
// For learners in different time zones, the converted local start time will be displayed.
// For example, learners in New York will see that the test is scheduled to begin on August 15th, 2023 at 09:05 AM local time.
var initializationOptions = {
    "config": {
        "time": {
            "start_time": {
                "type": "hard",
                "value": "20230815-1305"
            }
        }
    }
    // ...
};

Values

Request object key config.time.start_time

Type object

This object has the following properties which can be configured.

  • type string

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

  • value string

    Sets the start time of the assessment.

Caveats

Overriding the start_time option within sections is not supported.

When using the start_time configuration, it's important to note that pausing the assessment will not halt the timer. This design ensures the assessment's integrity and consistency.

If max_time is 0, or omitted, no automatic submission will occur, because this represents an unlimited session duration.

Versioning

Version added: v2023.3.LTS.

Was this article helpful?