Follow the question structure recommended by Dev Bot before submitting your integration questions.
idFitnessAssessment parameter is provided, the response returns the complete data of the corresponding fitness assessment, with a structure that varies according to the assessment type.idFitnessAssessment is not provided, the endpoint returns a summary list of fitness assessments without embedding the complete details of each assessment.NOTE. The idMemberparameter is required, and the query is performed within the context of the specified member.
| Parameter | Type | Required | Description |
|---|---|---|---|
idFitnessAssessment | int32 | No | Identifier of the specific fitness assessment. When provided, returns the complete assessment data. |
idMember | int32 | Yes | Identifier of the member whose fitness assessments will be retrieved. |
idEmployee | int32 | No | Filters assessments performed by a specific employee. |
dateCreatedStart | string (date-time) | No | Start date and time of the assessment creation period. |
dateCreatedEnd | string (date-time) | No | End date and time of the assessment creation period. |
idType | int32 | No | Filters assessments by fitness assessment type. |
take | int32 | No | Maximum number of records to be returned. Default: 50. |
skip | int32 | No | Number of records to skip before returning the results. Default: 0. |
idType parameter can be used to filter assessments by the following types:| Code | Type |
|---|---|
1 | Anamnesis |
2 | Bioimpedance |
3 | Circumferences |
4 | Skinfolds |
idFitnessAssessment is not provided, the response returns a summary list of the member's fitness assessments.idFitnessAssessment is provided, the response returns the complete fitness assessment data, with a specific structure according to the assessment type.| Field | Type | Description |
|---|---|---|
idFitnessAssessment | int32 | Unique identifier of the fitness assessment. |
idMember | int32 | Identifier of the assessed member. |
nameMember | string | Name of the assessed member. |
idEmployee | int32 | Identifier of the employee responsible for the assessment. |
nameEmployee | string | Name of the employee responsible for the assessment. |
cref | string | CREF of the employee responsible for the assessment. |
dateCreated | date-time | Date and time when the assessment was created. |
expiryDate | date-time | Date and time when the assessment expires. |
type | int32 | Fitness assessment type. |
nameType | string | Name of the fitness assessment type. |
type = 1)| Field | Type | Description |
|---|---|---|
basicData | object | Basic member data used in the assessment. |
healthHistory | arrayobject | Health history provided in the assessment. |
familyHealthHistory | arrayobject | Family health history provided in the assessment. |
usesMedication | boolean | Indicates whether the member uses medication. |
medications | arrayobject | List of medications provided in the assessment. |
hadSurgery | boolean | Indicates whether the member has undergone surgery. |
surgeries | arrayobject | List of surgeries provided in the assessment. |
practicesPhysicalActivity | boolean | Indicates whether the member practices physical activity. |
sleepHours | number | Number of hours of sleep. |
sleepQuality | string | Sleep quality provided in the assessment. |
professionalActivity | string | Member's professional activity. |
fitnessLevel | string | Fitness level. |
smoker | string | Smoking information. |
cigarettesPerDay | number | Number of cigarettes consumed per day, when applicable. |
yearsSmoking | number | Number of years of smoking, when applicable. |
yearsSmoked | number | Number of years the member smoked, when applicable. |
yearsSinceQuitSmoking | number | Number of years since the member quit smoking, when applicable. |
alcoholIntake | string | Alcohol intake information. |
chronicPains | arrayobject | List of chronic pains provided in the assessment. |
files | arrayobject | Files related to the health assessment. |
customQuestions | arrayobject | Custom questions and their respective answers. |
basicData Structure| Field | Type | Description |
|---|---|---|
weight | number | Member's weight. |
height | number | Member's height. |
birthDate | date-time | Member's date of birth. |
age | int32 | Member's age. |
biologicalSex | string | Member's biological sex. |
morphology | string | Morphology provided in the assessment. |
objectives | array | Objectives provided in the assessment. |
objectivesDescription | array | Descriptions of the objectives provided in the assessment. |
medications Structure| Field | Type | Description |
|---|---|---|
id | int32 | Medication identifier. |
name | string | Medication name. |
time | string | Period of medication use. |
chronicPains Structure| Field | Type | Description |
|---|---|---|
id | int32 | Chronic pain identifier. |
name | string | Name or description of the chronic pain. |
files Structure| Field | Type | Description |
|---|---|---|
name | string | File name. |
type | string | File type. |
url | string | File URL. |
customQuestions Structure| Field | Type | Description |
|---|---|---|
idQuestion | int32 | Identifier of the custom question. |
question | string | Question text. |
answer | string | Answer provided for the question. |
required | boolean | Indicates whether the question is required. |
type = 2)| Field | Type | Description |
|---|---|---|
basicData | object | Basic member data used in the assessment. |
muscleMass | number | Muscle mass. |
fatMass | number | Fat mass. |
fatFreeMass | number | Fat-free mass. |
skeletalMass | number | Skeletal mass. |
residuals | number | Residuals. |
visceralFatPercentage | number | Visceral fat percentage. |
bodyFatPercentage | number | Body fat percentage. |
basalMetabolicRate | number | Basal metabolic rate. |
waistHipRatio | number | Waist-to-hip ratio. |
metabolicAge | int32 | Metabolic age. |
obesityDegree | number | Obesity degree. |
bodyWater | number | Body water. |
muscleMassRightArm | number | Right arm muscle mass. |
muscleMassLeftArm | number | Left arm muscle mass. |
muscleMassLeftLeg | number | Left leg muscle mass. |
muscleMassRightLeg | number | Right leg muscle mass. |
muscleMassTrunk | number | Trunk muscle mass. |
fatMassRightArm | number | Right arm fat mass. |
fatMassLeftArm | number | Left arm fat mass. |
fatMassRightLeg | number | Right leg fat mass. |
fatMassLeftLeg | number | Left leg fat mass. |
fatMassTrunk | number | Trunk fat mass. |
photoFront | string | URL of the front assessment photo. |
photoBack | string | URL of the back assessment photo. |
photoLeftSide | string | URL of the left-side assessment photo. |
photoRightSide | string | URL of the right-side assessment photo. |
type = 3)| Field | Type | Description |
|---|---|---|
basicData | object | Basic member data used in the assessment. |
neck | number | Neck measurement. |
shoulders | number | Shoulder measurement. |
rightShoulder | number | Right shoulder measurement. |
leftShoulder | number | Left shoulder measurement. |
chest | number | Chest measurement. |
chestExpiration | number | Chest measurement during expiration. |
hip | number | Hip measurement. |
waist | number | Waist measurement. |
abdomen | number | Abdomen measurement. |
rightArmContracted | number | Contracted right arm measurement. |
rightArmRelaxed | number | Relaxed right arm measurement. |
leftArmContracted | number | Contracted left arm measurement. |
leftArmRelaxed | number | Relaxed left arm measurement. |
rightForearm | number | Right forearm measurement. |
leftForearm | number | Left forearm measurement. |
rightWrist | number | Right wrist measurement. |
leftWrist | number | Left wrist measurement. |
rightProximalThigh | number | Right proximal thigh measurement. |
leftProximalThigh | number | Left proximal thigh measurement. |
rightMedialThigh | number | Right medial thigh measurement. |
leftMedialThigh | number | Left medial thigh measurement. |
rightDistalThigh | number | Right distal thigh measurement. |
leftDistalThigh | number | Left distal thigh measurement. |
rightKnee | number | Right knee measurement. |
leftKnee | number | Left knee measurement. |
rightCalf | number | Right calf measurement. |
leftCalf | number | Left calf measurement. |
rightAnkle | number | Right ankle measurement. |
leftAnkle | number | Left ankle measurement. |
photoFront | string | URL of the front assessment photo. |
photoBack | string | URL of the back assessment photo. |
photoLeftSide | string | URL of the left-side assessment photo. |
photoRightSide | string | URL of the right-side assessment photo. |
type = 4)| Field | Type | Description |
|---|---|---|
basicData | object | Basic member data used in the assessment. |
skinfoldsProtocol | int32 | Identifier of the skinfold protocol used. |
triceps | number | Triceps skinfold measurement. |
subscapular | number | Subscapular skinfold measurement. |
midaxillary | number | Midaxillary skinfold measurement. |
chest | number | Chest skinfold measurement. |
abdominal | number | Abdominal skinfold measurement. |
suprailiac | number | Suprailiac skinfold measurement. |
thigh | number | Thigh skinfold measurement. |
photoFront | string | URL of the front assessment photo. |
photoBack | string | URL of the back assessment photo. |
photoLeftSide | string | URL of the left-side assessment photo. |
photoRightSide | string | URL of the right-side assessment photo. |