config.time.start_time.value - Initialization - Items API

Items API Initialization

value

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

You would want to use this option to require learners to start an exam at a specific date and time, for example.

A valid UTC time string is required in the following format: {Full year}{Month}{Date}-{Hours}{Minute}. For example, 20230815-1305 represents August 15th, 2023 at 13:05pm in UTC.

If the value set in the future, learners attempting to begin the assessment earlier 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.

Note When setting this value, ensure your local timezone has been converted to UTC time to set the correct value.

Note This option is required when using the "hard" start time type.

Examples

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

Values

Attribute path config.time.start_time.value

Type string

Versioning

Version added: v2023.3.LTS.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.