home api list

Hexostore API Documentation

study

/api/study/

List methods: post, get

Detail methods: options, post, get, put, patch, delete

Example usage

Create a study from a study template

It is possible to create a study from an existing studytemplate. To do so, the study template id must be posted with the other mandatory fields. Only a study admin can create a new study from a template. To create a new study from a template, make a POST to /api/study/ with the following json data:

{
    template_id: <id>,
    name: "<new study name>",
    description: "<new study description>",
    uuid: "<new study uuid>"
}

Fields

id: IntegerField

This field is readonly.

duration_in_days: IntegerField

This field may be blank

This field will default to: '' (empty string)

owner: UserSerializerMinimal

This field is readonly.

owner_id: IntegerField

This field will default to: '' (empty string)

icon: CharField

This field may be blank

This field will default to: '' (empty string)

timezone: TimeZoneSerializerField

This field will default to: '' (empty string)

resource_uri: RelatedUrlField

A reference to the resource. Maybe specified by URI or ID

This field is readonly.

cloneable: BooleanField

This field may be blank

This field will default to: '' (empty string)

unit_system: ChoiceField

Preferred unit

This field may be blank

Choices : [(1, 'metric'), (2, 'imperial')]

This field will default to: '' (empty string)

name: CharField

This field will default to: '' (empty string)

uuid: CharField

A unique identifier for study. Used as prefix in subject username

This field may be blank

This field will default to: '' (empty string)

description: CharField

This field may be blank

This field will default to: '' (empty string)

type: CharField

This field may be blank

This field will default to: '' (empty string)

status: ChoiceField

This field may be blank

Choices : [(0, 'disabled'), (1, 'normal'), (2, 'frozen'), (3, 'extended'), (4, 'deleted')]

This field will default to: '' (empty string)

start_date: DateField

This field may be blank

This field will default to: '' (empty string)

end_date: DateField

This field may be blank

This field will default to: '' (empty string)

planning: JSONField

Planning in a JSON format.

This field may be blank

This field will default to: '' (empty string)

scheduled_reports: JSONField

Reports in a JSON format. Do not edit it directly because of the risk on that it is misformatted.

This field may be blank

This field will default to: '' (empty string)

purchase_options: JSONField

Options In a JSON format.Do not edit it directly because of therisk on that it is misformatted

This field may be blank

This field will default to: '' (empty string)

parameters: JSONField

This field may be blank

This field will default to: '' (empty string)

metrics: JSONField

Lists the metrics associated to the study in a JSON FORMAT.CAUTION : Double-check the JSON because of the risk on that it is misformatted.

Name	Variable name used in JSON
Subject UUID	subject_uuid
Subject group name	group
Subject status (active or inactive)	status
Total number of tasks not performed to date that should have been done.	total_tasks_missed
Total number of activities not performed to date that should have been done.	total_activities_missed
Total number of manual entries not entered to date that should have been entered.	total_entries_missed
Total number of surveys not answered to date that should have been answered.	total_surveys_missed
Total tasks done by the subject since the beginning of the study.	total_tasks_done
Total tasks that should have been done by the subject since the beginning of the study.	total_tasks_to_date
Total surveys answered by the subject for the study.	total_surveys_done
Total surveys that should have been answered by the subject since the beginning of the study.	total_surveys_to_date
Heart rate signal quality.	hr_quality
Breathing rate signal quality.	br_quality
Total tasks (surveys, activities, entries) the subject has to do in the study.	total_tasks
Total surveys to answer by the subject for the study.	total_surveys
Total entries done by the subject for the study.	total_entries_done
Total activities to do by the subject for the study.	total_activities
Total entries that should be done by the subject since the beginning of the study.	total_entries_to_date
Total activities done by the subject for the study.	total_activities_done
Total activities that should be done by the subject since the beginning of the study.	total_activities_to_date
total_entries	Total entries to do by the subject for the study.
Total recording time done by the subject for the study.	total_recording_time
Total records uploaded by the subject based on statistics.	total_records
Total records uploaded by the subject based on records count.	number_of_records
Date and time of the beginning of the first recording done by the subject.	first_record
Date and time of the beginning of the last recording done by the subject.	last_record
Total time with activity range (training routine)	total_range_time
Total time with activity range (training routine) with no associated record	total_unsynced_range_time

This field may be blank

This field will default to: '' (empty string)

sync_users: ManyRelatedField

Users that may sync data for this study.

This field may be blank

This field will default to: '' (empty string)

admin_users: ManyRelatedField

Users able view/modify data for this study.

This field may be blank

This field will default to: '' (empty string)

trainingroutines: ManyRelatedField

Training routines related to a study.

This field may be blank

This field will default to: '' (empty string)

surveys: ManyRelatedField

Surveys related to a study.

This field may be blank

This field will default to: '' (empty string)

reports: ManyRelatedField

Reports related to a study.

This field may be blank

This field will default to: '' (empty string)

clients: ManyRelatedField

This field may be blank

This field will default to: '' (empty string)

Filtering Options

end_date: exact, in, gt, gte, lt, lte, range
id: exact, in, gt, gte, lt, lte, range
start_date: exact, in, gt, gte, lt, lte, range

Sorting Options

id

© 2024 by Carré Technologies Inc.