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

Items API Initialization


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

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 You will need to convert your local timezone to UTC time to set the correct value.

By utilizing the "soft" start time type, the assessment can be started at any time, you do not pass value in this scenario. The Learnosity server records the UTC time when the learner first initiates the assessment as the starting time.

The choice between "hard" and "soft" start time types depends on your specific use case and preference for either precise initial time or dynamic time capturing.

Key differences
hard is used when you want to start (and stop) the session at a controlled time.
soft is used when the session can start at any time. But, once started, the learner must complete it within max_time. They will not be able to save and resume at a later point in time.


Attribute path config.time.start_time.type

Type string

Possible values

  • "soft"
  • "hard"


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.

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

In scenarios where reading mode is employed alongside the "hard" type of start_time, 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.

Was this article helpful?

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