AdherenceRecord
A record describing the performance state of a scheduled session or assessment, as requested in a Timeline. Each record describes the state of a session or an assessment.
Parameters
The session or assessment instance GUID from the timeline that led to the generation of this record. There can be more than one record under a given instance GUID if that guid is for a persistent assessment, which can be performed more than once. In this case, each record must have a unique startedOn timestamp (time zone differences are not enough to make it unique, it must be a unique instant in time).
The client-supplied time when the activity was started (this time comes from the client and is not validated by the server). Since adherence records only includes activities that have been started, this value is required.
The client-supplied time when the activity was recorded as finished (this time comes from the client and is not validated by the server).
The event timestamp (at the time of recording this record) that triggered the sequence of sessions and assessments which includes the scheduling item for this record. For mutable event IDs, this timestamp can change, and each time value groups a separate series of instance GUID records.
An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted. If present, this field will be validated to be a valid time zone name.
The timestamp when an uploaded was recorded as successfully uploaded. If this timestamp is missing, the upload has not yet reached the server.
An arbitrary JSON structure that the client can use to record information about this schedule item (maximum size 65k).
AdherenceRecord