Items API Initialization

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

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.

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 shown.

If an assessment has the start_time.value set in the future, learners attempting to begin the assessment will encounter a message indicating "This test is not available yet." Until the specified available date arrives, learners will be unable to initiate the 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.

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

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 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

Attribute path config.time.start_time

Type object

Properties

• type string

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

• value string

  Defines the assessment's start date and time in UTC (Coordinated Universal Time) format.

Caveats

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

Overriding this option within sections is not supported.

Versioning

Version added: v2023.3.LTS.