Save weighing results

Deprecated

Required Scopes(any of): `CUSTOMER_WRITE`, `CUSTOMER_WEIGHING_WRITE` Saves weighing details for given customer

Endpoint

POST /v1/customers/{customerId}/weighing

Path Parameters

customerId required integer (int64)

Unique ID of the customer

Query Parameters

benefitKey string

Key of the benefit to use

Request Body application/json

required

Customer weighing details

databaseId integer(int64)

Database id of the weighing

basalMetabolicRate

Basal metabolic rate

bodyFatMass

Body fat mass in kg

bodyMassIndex

Body mass index in kg/m^2

fatFreeMass

Total fat free mass (aka Lean Body Mass) in kg

percentBodyFat

Body fat in percent

percentSkeletalMuscleMass

Skeletal muscle mass in percent

skeletalMuscleMass

Skeletal muscle mass in kg

totalBodyWater

Total body water in liters

visceralFatLevel integer(int32)

Visceral fat level (1-9)

weight

Body weight in kg

height

Body height in cm

bfmLeftArm

Body Fat Mass of the left arm in kg

bfmLeftLeg

Body Fat Mass of the left leg in kg

bfmPercentLeftArm

Body Fat Mass of the left arm in percent

bfmPercentLeftLeg

Body Fat Mass of the left leg in percent

bfmPercentRightArm

Body Fat Mass of the right arm in percent

bfmPercentRightLeg

Body Fat Mass of the right leg in percent

bfmPercentTrunk

Body Fat Mass of the trunk in percent

bfmRightArm

Body Fat Mass of the right arm in kg

bfmRightLeg

Body Fat Mass of the right leg in kg

bfmTrunk

Body Fat Mass of the trunk in kg

ffmLeftArm

Fat Free Mass of the left arm in kg

ffmLeftLeg

Fat Free Mass of the left leg in kg

ffmPercentLeftArm

Fat Free Mass of the left arm in percent

ffmPercentLeftLeg

Fat Free Mass of the left leg in percent

ffmPercentRightArm

Fat Free Mass of the right arm in percent

ffmPercentRightLeg

Fat Free Mass of the right leg in percent

ffmPercentTrunk

Fat Free Mass of the trunk in percent

ffmRightArm

Fat Free Mass of the right arm in kg

ffmRightLeg

Fat Free Mass of the right leg in kg

ffmTrunk

Fat Free Mass of the trunk in kg

rawResults required

The raw results. Might be passed back to partner-provided widgets

Responses

OK

Response Body application/json

Customer weighing details

databaseId integer(int64)

Database id of the weighing

basalMetabolicRate

Basal metabolic rate

bodyFatMass

Body fat mass in kg

bodyMassIndex

Body mass index in kg/m^2

fatFreeMass

Total fat free mass (aka Lean Body Mass) in kg

percentBodyFat

Body fat in percent

percentSkeletalMuscleMass

Skeletal muscle mass in percent

skeletalMuscleMass

Skeletal muscle mass in kg

totalBodyWater

Total body water in liters

visceralFatLevel integer(int32)

Visceral fat level (1-9)

weight

Body weight in kg

height

Body height in cm

bfmLeftArm

Body Fat Mass of the left arm in kg

bfmLeftLeg

Body Fat Mass of the left leg in kg

bfmPercentLeftArm

Body Fat Mass of the left arm in percent

bfmPercentLeftLeg

Body Fat Mass of the left leg in percent

bfmPercentRightArm

Body Fat Mass of the right arm in percent

bfmPercentRightLeg

Body Fat Mass of the right leg in percent

bfmPercentTrunk

Body Fat Mass of the trunk in percent

bfmRightArm

Body Fat Mass of the right arm in kg

bfmRightLeg

Body Fat Mass of the right leg in kg

bfmTrunk

Body Fat Mass of the trunk in kg

ffmLeftArm

Fat Free Mass of the left arm in kg

ffmLeftLeg

Fat Free Mass of the left leg in kg

ffmPercentLeftArm

Fat Free Mass of the left arm in percent

ffmPercentLeftLeg

Fat Free Mass of the left leg in percent

ffmPercentRightArm

Fat Free Mass of the right arm in percent

ffmPercentRightLeg

Fat Free Mass of the right leg in percent

ffmPercentTrunk

Fat Free Mass of the trunk in percent

ffmRightArm

Fat Free Mass of the right arm in kg

ffmRightLeg

Fat Free Mass of the right leg in kg

ffmTrunk

Fat Free Mass of the trunk in kg

rawResults required

The raw results. Might be passed back to partner-provided widgets

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"
Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value
type
Allowed values:
TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST
reference

Reference to validation error

Example:  "parent.child"