The turbo-justice-api's intro from trjate

#Healthy Aging API Documentation

This documentation will give you the various end points necessary to build a comprehensive, cross-platform application for the Healthy Aging Study. The Application will consist of a series of games: flanker, digit symbol, (x, y, z) that will collect various performance data. There will also be a host of patient data collected via survey forms.

##URL: http://healthyaging-env.elasticbeanstalk.com

##User

###Register

POST ‘/auth’ ######Required Body Params:

email - string
password - string

Example Success:

{
  "status": "success",
  "data": {
    "id": 3,
    "provider": "email",
    "uid": "[email protected]",
    "name": null,
    "nickname": null,
    "image": null,
    "email": "[email protected]",
    "created_at": "2015-11-06T16:00:37.736Z",
    "updated_at": "2015-11-06T16:00:37.853Z",
    "total_correct_flanker_guesses": 0,
    "total_incorrect_flanker_guesses": 0,
    "flanker_games_played": 0,
    "total_correct_digit_symbol_guesses": 0,
    "total_incorrect_digit_symbol_guesses": 0,
    "digit_symbol_games_played": 0,
    "total_memory_impairment_points": 0,
    "memory_impairment_games_played": 0,
    "transgender?": null,
    "race": null,
    "hispanic_or_latino?": null,
    "education_level": null,
    "married?": null,
    "employed?": null,
    "headcount_in_household": null,
    "total_pretax_household_income": null,
    "height": null,
    "weight": null,
    "writing_hand": null,
    "gender": null,
    "emory_patient?": null,
    "biological_mother_known?": null,
    "biological_father_known?": null,
    "has_biological_siblings?": null
  }
}

Status Code: :ok

After a user registers he will need to pass the following parameters in the header of every subsequent request. These will be provided in the headers of the response at '/auth'.

access-token: string (ex. cUmnxi-0LYWyfPuD6CrMYQ)
client: string (ex. HavPTZL6KZIYu3eZqwwbLw)
uid: string (user's email address)
token Bearer (token is always 'Bearer')
expiry: string (ex. 7492950878)

###Update User Survey Data PUT '/user/:id/survey'

This endpoint should be called only after a user has been registered at POST '/auth'.

A few important things to note:

A FamilyQuestion table can only be created for a user if he indicates true on at least one of following three attributes on the User table:
- biological_mother_known?
- biological_father_known?
- has_biological_siblings?
An example of this output can be seen below. If the user does not indicate true on any of those fields it will not create a new FamilyQuestion record. All remaining Models will be applicable to every user, and they should have only one associated with their ID.
You can see the remaining survey params with their associated data type below. The params are categorized according to the model they belong to. Each model is associated with only one user.

#####Family Question

Table name: 'family_questions'

All are strings except birthyear (integer).

relation
birthyear
still_living?
diagnosed_with_MCI?
diagnosed_with_AD?
diagnosed_with_memory_loss_or_dementia?
diagnosed_with_Parkinsons?
ever_had_coronary_heart_disease_or_heart_attack?
diagnosed_with_diabetes?
diagnosed_with_hypertension?
diagnosed_with_high_cholesterol_or_triglycerides?
diagnosed_with_stroke_or_TIA?

#####User

Table name: 'users'

  	   ```      transgender?``` - ```boolean```

```
   ```      race``` - ```string```
```

   ```      hispanic_or_latino?``` - ```boolean```

   ```      education_level``` - ```string```

```
   ```      married?``` - ```string```
```

   ```      employed?``` - ```boolean```

   ```      headcount_in_household``` - ```integer```

   ```      total_pretax_household_income``` - ```integer```

```
   ```      height``` - ```integer```
```
```
   ```      weight``` - ```integer```
```

   ```      writing_hand``` - ```string```

```
   ```      gender``` - ```string```
```

   ```      emory_patient?``` - ```string```

   ```      biological_mother_known?``` - ```boolean```

   ```      biological_father_known?``` - ```boolean```

   ```      has_biological_siblings?``` - ```boolean```

   ```      get_help_completing_survey?``` - ```boolean```

   ```      willing_to_have_blood_drawn?``` - ```boolean```

   ```      able_to_have_MRI?``` - ```boolean```

   ```      willing_to_have_lumbar_puncture?``` - ```string```

#####Activities and Habit

Table name: 'activities_and_habits'

All are strings except ever_had_music_instruction_or_training? (boolean).

   ```    frequency_of_10_plus_minute_nonstop_walks_outside```

   ```    length_of_10_plus_minute_nonstop_walks_outside```

```
   ```    usual_walking_speed?```
```

   ```    frequency_of_nonwalking_moderate_or_strenuous_exercise```

   ```   length_of_nonwalking_moderate_or_strenuous_exercise```

   ```    frequency_of_mild_exercise```

```
   ```   length_of_mild_exercise```
```

   ```    frequency_of_reading_newspaper_last_year```

   ```    frequency_of_reading_magazines_last_year```

   ```    frequency_of_reading_books_last_year```

   ```    frequency_of_writing_letters_or_sending_emails_last_year```

   ```    frequency_of_playing_games_or_solving_puzzles_last_year```

   ```    ever_had_music_instruction_or_training?```

#####General Health and Activities Over Last Two Week

Table name: 'general_health_and_activities_over_last_two_weeks'

All are strings.

little_interest_or_pleasure_in_doing_things?
feeling_down_depressed_or_hopeless?
trouble_falling_or_staying_asleep_or_sleeping_too_much?
feeling_tired_or_having_little_energy?
poor_appetite_or_overeating?
feeling_like_a_failure_or_bad_about_yourself?
trouble_concentrating_while_reading_or_watching_tv?
moving_or_speaking_noticeably_slowly_or_being_extra_fidgety?
feeling_nervous_anxious_or_on_edge?
being_unable_to_control_worrying?
worrying_too_much_about_things?
trouble_relaxing?
being_so_restless_you_cannot_sit_still?
becoming_easily_annoyed_or_irritable?
feeling_afraid_something_bad_might_happen?

#####General Health and Activity

Table name: 'general_health_and_activities'

overall_physical_health? - string
overall_mental_health? - string
trouble_remembering_things? - string
memory_compared_to_decade_ago? - string
average_number_of_alcoholic_drinks_each_week_over_past_year? - string
ever_smoked_cigarettes_regularly? - boolean
currently_smoke? - boolean
typical_bedtime? - string
typical_waketime? - string
typical_sleeptime? - integer

#####General Health and Activity Vs Last Year

Table name: 'general_health_and_activity_vs_last_years'

All strings.

substantially_declined_memory?
others_tell_that_you_repeat_questions?
misplace_things_more_often?
rely_more_on_written_reminders?
need_more_help_to_remember_appointments_or_holidays?
have_more_trouble_recalling_names_or_finding_right_word?
have_more_trouble_driving?
have_difficulty_managing_money?
less_involved_in_social_activities?
work_performance_declined_significantly?
have_more_trouble_following_news_book_plots_movies_or_shows?
activities_that_are_substantially_more_difficult?
more_apt_to_get_lost_in_another_city?
more_difficulty_using_household_appliances?

#####Job

Table name: 'jobs'

All are booleans.

ever_work_for_6_plus_months_with_regular_solvent_exposure?
ever_work_for_6_plus_months_with_regular_metal_fume_exposure?
ever_work_for_6_plus_months_with_regular_pesticide_exposure?

#####Medical History

Table name: 'medical_histories'

ever_had_hypertension? - boolean
age_when_diagnosed_with_hypertension? - string
currently_taking_hypertension_medication? - boolean
ever_had_TIA? - boolean
age_when_TIA_occurred? - string
currently_taking_TIA_medication? - boolean
ever_had_heart_attack? - boolean
age_when_heart_attack_occurred? - string
currently_taking_heart_attack_medication? - boolean
ever_had_coronary_heart_disease_or_angina? - boolean
age_when_diagnosed_with_coronary_heart_disease_or_angina? - string
currently_taking_coronary_heart_disease_or_angina_medication? - boolean
ever_had_congestive_heart_failure? - boolean
age_when_diagnosed_with_congestive_heart_failure? - string
currently_taking_congestive_heart_failure_medication? - boolean
ever_had_high_cholesterol_or_triglycerides? - boolean
age_when_diagnosed_with_high_cholesterol_or_triglycerides? - string
currently_taking_high_cholesterol_or_triglycerides_medication? - boolean
ever_had_pulmonary_embolism_DVT_or_blood_clots? - boolean
age_when_diagnosed_with_pulmonary_embolism_DVT_or_blood_clots? - string
currently_taking_pulmonary_embolism_DVT_or_blood_clots_meds? - boolean
ever_had_other_vascular_or_circulatory_system_problems? - boolean
age_when_diagnosed_with_other_vascular_or_circulatory_problems? - string
currently_taking_other_vascular_or_circulatory_system_meds? - boolean
ever_had_migraine_headaches? - boolean
age_when_diagnosed_with_migraine_headaches? - string
currently_taking_migraine_headaches_medication? - boolean
ever_had_MCI_or_memory_loss? - boolean
age_when_diagnosed_with_MCI_or_memory_loss? - string
currently_taking_MCI_or_memory_loss_medication? - boolean
ever_had_AD? - boolean
age_when_diagnosed_with_AD? - string
currently_taking_AD_medication? - boolean
ever_had_other_dementia? - boolean
age_when_diagnosed_with_other_dementia? - string
currently_taking_other_dementia_medication? - boolean
had_concussion_or_traumatic_brain_injury_with_unconsciousness? - boolean
age_when_concussion_or_traumatic_brain_injury_occurred? - string
currently_taking_concussion_or_traumatic_brain_injury_meds? - boolean
ever_had_spinal_cord_injury_or_impairment? - boolean
age_when_spinal_cord_injury_or_impairment_occurred? - string
currently_taking_spinal_cord_injury_or_impairment_medication? - boolean
ever_had_epilepsy? - boolean
age_when_diagnosed_with_epilepsy? - string
currently_taking_epilepsy_medication? - boolean
ever_had_parkinsons? - boolean
age_when_diagnosed_with_parkinsons? - string
currently_taking_parkinsons_medication? - boolean
ever_had_ALS? - boolean
age_when_diagnosed_with_ALS?
currently_taking_ALS_medication? - boolean
ever_had_MS? - boolean
age_when_diagnosed_with_MS? - string
currently_taking_MS_medication? - boolean
ever_had_other_nervous_system_problems? - boolean
age_when_diagnosed_with_other_nervous_system_problems? - string
currently_taking_medication_for_other_nervous_system_problems? - boolean
ever_had_PTSD? - boolean
ever_had_depression_or_bipolar_disorder? - boolean
ever_had_schizophrenia? - boolean
ever_had_other_mental_health_disorder? - boolean
ever_had_tuberculosis? - boolean
ever_had_hepatitis_B_or_C? - boolean
ever_had_HIV_or_AIDS? - boolean
ever_had_breast_cancer? - boolean
ever_had_colon_or_rectal_cancer? - boolean
ever_had_lung_cancer? - boolean
ever_had_prostate_cancer? - boolean
ever_had_melanoma? - boolean
ever_had_other_skin_cancer? - boolean
ever_had_leukemia? - boolean
ever_had_lymphoma? - boolean
ever_had_other_cancer? - boolean
ever_had_kidney_disease_without_dialysis? - boolean
ever_had_kidney_disease_with_dialysis? - boolean
ever_had_chronic_lung_disease? - boolean
ever_had_sleep_apnea? - boolean
ever_had_thyroid_problems? - boolean
ever_had_diabetes? - boolean
ever_had_vision_problems_that_interfered_with_daily_stuff? - boolean
ever_had_physical_disabilities_that_interfered_with_daily_stuff? - boolean

#####Medication and Maintenance Rx

Table name: 'medication_and_maintenance_rxes'

Both are booleans.

currently_taking_Coumadin_Warfarin_or_anti_coagulants?
currently_taking_other_rx_medications?

#####Reference

Table name: 'references'

All are strings.

relationship
first_name
last_name
email
contact_number

###Index Family Questions GET '/family_questions'

{
  "family_questions": [
    {
      "id": 1,
      "user_id": 1,
      "relation": mother,
      "birthyear": 1948,
      "still_living": yes,
      "diagnosed_with_MCI": null,
      "diagnosed_with_AD": null,
      "diagnosed_with_memory_loss_or_dementia": null,
      "diagnosed_with_Parkinsons": null,
      "ever_had_coronary_heart_disease_or_heart_attack": null,
      "diagnosed_with_diabetes": null,
      "diagnosed_with_hypertension": null,
      "diagnosed_with_high_cholesterol_or_triglycerides": null,
      "diagnosed_with_stroke_or_TIA": null
    },
    {
      "id": 2,
      "user_id": 2,
      "relation": brother,
      "birthyear": 1986,
      "still_living": yes,
      "diagnosed_with_MCI": null,
      "diagnosed_with_AD": null,
      "diagnosed_with_memory_loss_or_dementia": null,
      "diagnosed_with_Parkinsons": null,
      "```currently_had_coronary_heart_disease_or_heart_attack": null,
      "diagnosed_with_diabetes": null,
      "diagnosed_with_hypertension": null,
      "diagnosed_with_high_cholesterol_or_triglycerides": null,
      "diagnosed_with_stroke_or_TIA": null
    }
  ]
}

###Index All Users

GET ‘/users’

Example Success:

{
  "user": [
    {
      "id": 1,
      "uid": "[email protected]",
      "total_correct_flanker_guesses": 25,
      "total_incorrect_flanker_guesses": 1,
      "flanker_games_played": 7,
      "total_correct_digit_symbol_guesses": 123,
      "total_incorrect_digit_symbol_guesses": 7,
      "digit_symbol_games_played": 9,
      "total_memory_impairment_points": 24,
      "memory_impairment_games_played": 3,
      "transgender": null,
      "race": null,
      "hispanic_or_latino": null,
      "education_level": null,
      "married": null,
      "employed": null,
      "headcount_in_household": null,
      "total_pretax_household_income": null,
      "height": null,
      "weight": null,
      "writing_hand": null,
      "gender": null,
      "emory_patient": null,
      "biological_mother_known": null,
      "biological_father_known": null,
      "has_biological_siblings": null
    },
    {
      "id": 2,
      "uid": "[email protected]",
      "total_correct_flanker_guesses": 62,
      "total_incorrect_flanker_guesses": 4,
      "flanker_games_played": 2,
      "total_correct_digit_symbol_guesses": 81,
      "total_incorrect_digit_symbol_guesses": 16,
      "digit_symbol_games_played": 3,
      "total_memory_impairment_points": 12,
      "memory_impairment_games_played": 2,
      "transgender": null,
      "race": "white",
      "hispanic_or_latino": null,
      "education_level": null,
      "married": null,
      "employed": null,
      "headcount_in_household": null,
      "total_pretax_household_income": null,
      "height": null,
      "weight": 122,
      "writing_hand": null,
      "gender": null,
      "emory_patient": null,
      "biological_mother_known": null,
      "biological_father_known": true,
      "has_biological_siblings": true
    }
  ]
}

###Index Flanker Games For User GET ‘/user/:id/flankers’

The first clicktime records the time it took the user to record his first answer after pressing start. The rest record the time between each click in milliseconds.

Example Success:

{
  "user": [
    {
      "id": 1,
      "correct_guesses": 27,
      "incorrect_guesses": 4,
      "user_id": 2,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 2,
      "correct_guesses": 144,
      "incorrect_guesses": 3,
      "user_id": 2,
      "clicktimes": "1343, 1734, 1888, 1001"
    },
    {
      "id": 3,
      "correct_guesses": 66,
      "incorrect_guesses": 9,
      "user_id": 2,
      "clicktimes": "1245, 1100, 988, 682"

    }
  ]
}

###Index Digit Symbol Games For User GET ‘/user/:id/digit_symbols’

Example Success:

{
  "user": [
    {
      "id": 1,
      "correct_guesses": 17,
      "incorrect_guesses": 9,
      "user_id": 2,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 2,
      "correct_guesses": 93,
      "incorrect_guesses": 15,
      "user_id": 2,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 3,
      "correct_guesses": 44,
      "incorrect_guesses": 21,
      "user_id": 3,
      "clicktimes": "1445, 1400, 1299, 1001"
    }
  ]
}

###Show User GET '/user/:id'

Example Success:

{
  "user": {
    "id": 5,
    "uid": "[email protected]",
    "total_correct_flanker_guesses": 0,
    "total_incorrect_flanker_guesses": 0,
    "flanker_games_played": 0,
    "total_correct_digit_symbol_guesses": 0,
    "total_incorrect_digit_symbol_guesses": 0,
    "digit_symbol_games_played": 0,
    "total_memory_impairment_points": 0,
    "memory_impairment_games_played": 0,
    "transgender": null,
    "race": "white",
    "hispanic_or_latino": null,
    "education_level": null,
    "married": null,
    "employed": null,
    "headcount_in_household": null,
    "total_pretax_household_income": null,
    "height": null,
    "weight": 184,
    "writing_hand": null,
    "gender": null,
    "emory_patient": null,
    "biological_mother_known": false,
    "biological_father_known": true,
    "has_biological_siblings": true
  }
}

##Flanker ###Create Flanker POST '/flankers'

######Required Params:

correct_guesses - integer
incorrect_guesses - integer
clicktimes - integer

######Clicktimes should be passed as an array of integers in Unix timestamp milliseconds.

Example Success:

{
  "flanker": {
    "id": 8,
    "correct_guesses": 30,
    "incorrect_guesses": 5,
    "user_id": 3,
    "clicktimes": "1445, 1400, 1299, 1001, 741, 902"
  }
}

###Index All Flanker Games GET '/flankers'

Example Success:

{
  "flankers": [
    {
      "id": 1,
      "correct_guesses": 15,
      "incorrect_guesses": 2,
      "user_id": 1,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 2,
      "correct_guesses": 201,
      "incorrect_guesses": 35,
      "user_id": 2,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 3,
      "correct_guesses": 105,
      "incorrect_guesses": 0,
      "user_id": 3,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 4,
      "correct_guesses": 88,
      "incorrect_guesses": 21,
      "user_id": 3,
      "clicktimes": "1445, 1400, 1299, 1001"
    }
  ]
}

###Show Flanker GET '/flankers/:id'

Example Success:

{
  "flanker": {
    "id": 1,
    "correct_guesses": 50,
    "incorrect_guesses": 5,
    "user_id": 2,
    "clicktimes": "1445, 1400, 1299, 1001"
  }
}

##Digit Symbol ###Create Digit Symbol POST '/digit_symbols'

######Required Params:

correct_guesses
incorrect_guesses
clicktimes

Example Success:

{
  "digit_symbol": {
    "id": 2,
    "correct_guesses": 10,
    "incorrect_guesses": 1,
    "user_id": 4
    "clicktimes": "1445, 1400, 1299, 1001"
  }
}

###Index All Digit Symbol Games GET '/digit_symbols'

Example Success:

{
  "digit_symbols": [
    {
      "id": 1,
      "correct_guesses": 10,
      "incorrect_guesses": 0,
      "user_id": 1,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 2,
      "correct_guesses": 88,
      "incorrect_guesses": 22,
      "user_id": 2,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 3,
      "correct_guesses": 77,
      "incorrect_guesses": 31,
      "user_id": 3,
      "clicktimes": "1445, 1400, 1299, 1001"
    },
    {
      "id": 4,
      "correct_guesses": 100,
      "incorrect_guesses": 5,
      "user_id": 3,
      "clicktimes": "1445, 1400, 1299, 1001"
    }
  ]
}

Show Digit Symbol

GET '/digit_symbols/:id'

Example Success:

{
  "digit_symbol": {
    "id": 12,
    "correct_guesses": 38,
    "incorrect_guesses": 13,
    "user_id": 4,
    "clicktimes": "1445, 1400, 1299, 1001"
  }
}

trjate / turbo-justice-api Goto Github PK

turbo-justice-api's Introduction

Show Digit Symbol

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent