Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Method

Path

Description

POST

/v5/studies/{studyId}/participants/self/adherence

API for study participant to create a state information record. This can be called more than once with a record of the same GUID, but each record is required to have a unique startedOn valueor update one or more state information records.

POST

/v5/studies/{studyId}/participants/self/adherence/search

Search for records using a search parameters object, described below.

POST

/v5/studies/{studyId}/participants/self/adherence/{guid}

API for study participant to update the state of an adherence record (e.g. mark it started or finished, or save clientData related to this session run). If there is more than one record, the startedOn timestamp will be used to update the correct record (it is an error to update a record that does not have the correct timestamp).

GET

/v5/studies/{studyId}/participants/{userId}/adherence/search

API for study coordinators or other administrators to retrieve state information records. based on search criteria, defined below.

...