home api list

Hexostore API Documentation

studysubject

/api/studysubject/

List methods: post, get

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

Endpoint to see for subjects of a study

posting a subject with an email address will make them receive an email notification related to their newly created subject account , if no email adress is provided, the owner of the study will receive the mail

example of POST :

POST /api/studysubject/,
    {
        "user": {
            "password": "Ax2i6nBs22",
            "profile": {
                "fitness": {"weight": 75, "height": 1.75},
                "date_of_birth": "1970-1-1",
                "gender": "M",
            },
        },
        "study": "/api/study/[study_id]/",
        "study_group":  "/api/studygroup/[studygroup_id]/",
        "status": "",
        "metrics": "{}",
        "start_date": "2025-01-01"
    },

by adding bulk=True an array of subject can be posted instead to do multiple user creation

By adding expand_profile=1 for filtering in the url, the profile will be expanded instead returning the resource_url By adding expand_profile=1&short_metrics=1 the profile will be expanded with limited fields to improve speed By adding last_modified__gte=YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ] for filtering in the url, only the profile with recently modified kpi are returned By adding last_modified__lte=YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ] for filtering in the url, only the profile with old modified kpi are returned

Fields

user: PrimaryKeyRelatedField

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

study: RelatedUrlField

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

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

id: IntegerField

This field is readonly.

study_group: RelatedUrlField

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

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

study_group_name: CharField

This field is readonly.

resource_uri: RelatedUrlField

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

This field is readonly.

subject_uuid: CharField

This field may be blank

This field will default to: 043a809c

timezone: TimeZoneSerializerField

This field may be blank

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

compliance_kpi: StudySubjectComplianceKPISerializer

This field is readonly.

metrics: JSONField

Latest values of metrics of interest

This field may be blank

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

status: ChoiceField

This field may be blank

Choices : [(0, 'inactive'), (1, 'active')]

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

start_date: DateField

Determines when the schedule associated with this study is begun for this user. The individual calendar is based on this dateand the study planning

This field may be blank

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

Filtering Options

start_date: exact, in, gt, gte, lt, lte, range
status: exact
study: exact, in, isnull
study_group: exact, in
subject_uuid: exact, contains, icontains, iexact
user: exact, in, gt, gte, lt, lte

Sorting Options

No sorting supported