Follow the question structure recommended by Dev Bot before submitting your integration questions.
π§ Notes The submitted data must comply with the configuration of the protocol provided in idProtocol, including the enabled and required fields defined for the protocol.Assessment photos can be provided using a URL. The URL must have public access, with no authentication required.
| Parameter | Type | Required | Description |
|---|---|---|---|
idMember | int32 | Yes | Identifier of the member for whom the Bioimpedance assessment will be created. |
idProtocol | int32 | Yes | Identifier of the Bioimpedance protocol used for the assessment. |
idEmployee | int32 | Yes | Identifier of the employee responsible for the assessment. |
basicData | object | Yes | Basic member data used in the assessment. See below. |
muscleMass | number | Situational | Muscle mass. |
fatMass | number | Situational | Fat mass. |
fatFreeMass | number | Situational | Fat-free mass. |
skeletalMass | number | Situational | Skeletal mass. |
residuals | number | Situational | Residuals. |
visceralFatPercentage | number | Situational | Visceral fat percentage. |
bodyFatPercentage | number | Situational | Body fat percentage. |
basalMetabolicRate | number | Situational | Basal metabolic rate. |
waistHipRatio | number | Situational | Waist-to-hip ratio. |
metabolicAge | int32 | Situational | Metabolic age. |
obesityDegree | number | Situational | Obesity degree. |
bodyWater | number | Situational | Body water. |
muscleMassRightArm | number | Situational | Right arm muscle mass. |
muscleMassLeftArm | number | Situational | Left arm muscle mass. |
muscleMassLeftLeg | number | Situational | Left leg muscle mass. |
muscleMassRightLeg | number | Situational | Right leg muscle mass. |
muscleMassTrunk | number | Situational | Trunk muscle mass. |
fatMassRightArm | number | Situational | Right arm fat mass. |
fatMassLeftArm | number | Situational | Left arm fat mass. |
fatMassRightLeg | number | Situational | Right leg fat mass. |
fatMassLeftLeg | number | Situational | Left leg fat mass. |
fatMassTrunk | number | Situational | Trunk fat mass. |
photoFront | string | No | Public URL of the front assessment photo. |
photoBack | string | No | Public URL of the back assessment photo. |
photoLeftSide | string | No | Public URL of the left-side assessment photo. |
photoRightSide | string | No | Public URL of the right-side assessment photo. |
NOTE. The required status of assessment data classified as Situational depends on the configuration of the protocol provided in idProtocol. Enabled and required fields can be retrieved through the protocol details endpoint.
basicData Object Structure| Field | Type | Required | Description |
|---|---|---|---|
weight | number | Yes | Member's weight. |
height | number | Yes | Member's height. |
birthDate | date-time | Yes | Member's date of birth. |
age | int32 | Yes | Member's age. |
biologicalSex | string | Yes | Member's biological sex. |
morphology | string | No | Morphology provided in the assessment. |
objectives | array | No | List of member objectives. |
objectivesDescription | array | No | List of descriptions of the member's objectives. |
{
"idMember": 4567,
"idProtocol": 12,
"idEmployee": 89,
"basicData": {
"weight": 78.5,
"height": 1.80,
"birthDate": "1992-05-10T00:00:00",
"age": 34,
"biologicalSex": "M",
"morphology": "Mesomorfo",
"objectives": [
"Hipertrofia"
],
"objectivesDescription": []
},
"muscleMass": 38.2,
"fatMass": 12.4,
"fatFreeMass": 66.1,
"skeletalMass": 34.0,
"residuals": 5.1,
"visceralFatPercentage": 8.0,
"bodyFatPercentage": 15.8,
"basalMetabolicRate": 1780,
"waistHipRatio": 0.85,
"metabolicAge": 29,
"obesityDegree": 105.0,
"bodyWater": 48.3,
"muscleMassRightArm": 3.1,
"muscleMassLeftArm": 3.0,
"muscleMassLeftLeg": 9.3,
"muscleMassRightLeg": 9.4,
"muscleMassTrunk": 24.0,
"fatMassRightArm": 0.6,
"fatMassLeftArm": 0.6,
"fatMassRightLeg": 1.9,
"fatMassLeftLeg": 1.9,
"fatMassTrunk": 6.0,
"photoFront": "https://.../front.jpg",
"photoBack": null,
"photoLeftSide": null,
"photoRightSide": null
}| Field | Type | Description |
|---|---|---|
idFitnessAssessment | int32 | Unique identifier of the created Bioimpedance fitness assessment. |