Save weighing results

Required Scopes(any of): CUSTOMER_WRITE, CUSTOMER_WEIGHING_WRITE

Saves weighing details for given customer

SecurityApiKeyAuth

Request

path Parameters

customerId

required

integer <int64>

Unique ID of the customer

query Parameters

benefitKey

string

Key of the benefit to use

Request Body schema: application/json
required

databaseId	integer <int64> Database id of the weighing
basalMetabolicRate	number Basal metabolic rate
bodyFatMass	number Body fat mass in kg
bodyMassIndex	number Body mass index in kg/m^2
fatFreeMass	number Total fat free mass (aka Lean Body Mass) in kg
percentBodyFat	number Body fat in percent
percentSkeletalMuscleMass	number Skeletal muscle mass in percent
skeletalMuscleMass	number Skeletal muscle mass in kg
totalBodyWater	number Total body water in liters
visceralFatLevel	integer <int32> Visceral fat level (1-9)
weight	number Body weight in kg
height	number Body height in cm
bfmLeftArm	number Body Fat Mass of the left arm in kg
bfmLeftLeg	number Body Fat Mass of the left leg in kg
bfmPercentLeftArm	number Body Fat Mass of the left arm in percent
bfmPercentLeftLeg	number Body Fat Mass of the left leg in percent
bfmPercentRightArm	number Body Fat Mass of the right arm in percent
bfmPercentRightLeg	number Body Fat Mass of the right leg in percent
bfmPercentTrunk	number Body Fat Mass of the trunk in percent
bfmRightArm	number Body Fat Mass of the right arm in kg
bfmRightLeg	number Body Fat Mass of the right leg in kg
bfmTrunk	number Body Fat Mass of the trunk in kg
ffmLeftArm	number Fat Free Mass of the left arm in kg
ffmLeftLeg	number Fat Free Mass of the left leg in kg
ffmPercentLeftArm	number Fat Free Mass of the left arm in percent
ffmPercentLeftLeg	number Fat Free Mass of the left leg in percent
ffmPercentRightArm	number Fat Free Mass of the right arm in percent
ffmPercentRightLeg	number Fat Free Mass of the right leg in percent
ffmPercentTrunk	number Fat Free Mass of the trunk in percent
ffmRightArm	number Fat Free Mass of the right arm in kg
ffmRightLeg	number Fat Free Mass of the right leg in kg
ffmTrunk	number Fat Free Mass of the trunk in kg
rawResults required	string The raw results. Might be passed back to partner-provided widgets

Responses

200

400

Validation of the request failed.

401

Authentication failed. No api-key, wrong api-key or wrong header name.

403

Authorization failed. The caller has no privilege to the given resource.

404

Entity does not exists.

409

Conflict

429

Access denied - rate limit is exceeded.

500

Unexpected system error.

post/v1/customers/{customerId}/weighing

Request samples

Payload
curl

application/json

{"databaseId": 0,
"basalMetabolicRate": 0,
"bodyFatMass": 0,
"bodyMassIndex": 0,
"fatFreeMass": 0,
"percentBodyFat": 0,
"percentSkeletalMuscleMass": 0,
"skeletalMuscleMass": 0,
"totalBodyWater": 0,
"visceralFatLevel": 0,
"weight": 0,
"height": 0,
"bfmLeftArm": 0,
"bfmLeftLeg": 0,
"bfmPercentLeftArm": 0,
"bfmPercentLeftLeg": 0,
"bfmPercentRightArm": 0,
"bfmPercentRightLeg": 0,
"bfmPercentTrunk": 0,
"bfmRightArm": 0,
"bfmRightLeg": 0,
"bfmTrunk": 0,
"ffmLeftArm": 0,
"ffmLeftLeg": 0,
"ffmPercentLeftArm": 0,
"ffmPercentLeftLeg": 0,
"ffmPercentRightArm": 0,
"ffmPercentRightLeg": 0,
"ffmPercentTrunk": 0,
"ffmRightArm": 0,
"ffmRightLeg": 0,
"ffmTrunk": 0,
"rawResults": "string"
}

Response samples

application/json

{"databaseId": 0,
"basalMetabolicRate": 0,
"bodyFatMass": 0,
"bodyMassIndex": 0,
"fatFreeMass": 0,
"percentBodyFat": 0,
"percentSkeletalMuscleMass": 0,
"skeletalMuscleMass": 0,
"totalBodyWater": 0,
"visceralFatLevel": 0,
"weight": 0,
"height": 0,
"bfmLeftArm": 0,
"bfmLeftLeg": 0,
"bfmPercentLeftArm": 0,
"bfmPercentLeftLeg": 0,
"bfmPercentRightArm": 0,
"bfmPercentRightLeg": 0,
"bfmPercentTrunk": 0,
"bfmRightArm": 0,
"bfmRightLeg": 0,
"bfmTrunk": 0,
"ffmLeftArm": 0,
"ffmLeftLeg": 0,
"ffmPercentLeftArm": 0,
"ffmPercentLeftLeg": 0,
"ffmPercentRightArm": 0,
"ffmPercentRightLeg": 0,
"ffmPercentTrunk": 0,
"ffmRightArm": 0,
"ffmRightLeg": 0,
"ffmTrunk": 0,
"rawResults": "string"
}