POST api/HealthScore/Calculate

Get the current score

Request Information

URI Parameters

None.

Body Parameters

HealthScoreParameters
NameDescriptionTypeAdditional information
ExternalID

ID for the user

string

None.

Smoker

Smoking Status 11 - Never smoked 9 - Quit smoking 3 - Smoke 1 pack a day 0 - Smoke more than 1 pack a day

decimal number

None.

Alcohol

Weekly alcohol consumption 11 - None 9 - 1 to 2 units 3 - 3 to 10 units 1 - over 10 units

decimal number

None.

Diet

How often do you eat foods containing refined sugar or oil? 6 - Almost every day 8 - Once in a while 10 - Rarely or Never

decimal number

None.

FoodType

How often do you eat only plant-based foods? (No meat or dairy products) 11 - Almost Every Day 9 - Sometimes 5 - Rarely or Never

decimal number

None.

Height

Height in meters

decimal number

None.

Weight

Weight in Kg

decimal number

None.

Gender

Gender Male / Female / Other

string

None.

Emotional

Emotional wellbeing 11 - Happy 9 - Content 5 - Unhappy

decimal number

None.

Waist

Waist measurement in Inches

decimal number

None.

Age

Age of the individual

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "ExternalID": "sample string 1",
  "Smoker": 2.1,
  "Alcohol": 3.1,
  "Diet": 4.1,
  "FoodType": 5.1,
  "Height": 6.1,
  "Weight": 7.1,
  "Gender": "sample string 8",
  "Emotional": 9.1,
  "Waist": 10.1,
  "Age": 11.1
}

application/xml, text/xml

Sample:
<HealthScoreParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <Age>11.1</Age>
  <Alcohol>3.1</Alcohol>
  <Diet>4.1</Diet>
  <Emotional>9.1</Emotional>
  <ExternalID>sample string 1</ExternalID>
  <FoodType>5.1</FoodType>
  <Gender>sample string 8</Gender>
  <Height>6.1</Height>
  <Smoker>2.1</Smoker>
  <Waist>10.1</Waist>
  <Weight>7.1</Weight>
</HealthScoreParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HealthScoreResult
NameDescriptionTypeAdditional information
TotalScore

Overall score

integer

None.

NutritionScore

Score for nutritional behaviour

integer

None.

ActivityScore

Score for activity

integer

None.

SleepScore

Score for your quality of sleep

integer

None.

MentalHealthScore

Score for your mental health

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalScore": 1,
  "NutritionScore": 2,
  "ActivityScore": 3,
  "SleepScore": 4,
  "MentalHealthScore": 5
}

application/xml, text/xml

Sample:
<HealthScoreResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tekasco.HealthStream.Models">
  <ActivityScore>3</ActivityScore>
  <MentalHealthScore>5</MentalHealthScore>
  <NutritionScore>2</NutritionScore>
  <SleepScore>4</SleepScore>
  <TotalScore>1</TotalScore>
</HealthScoreResult>