Criar Avaliação Física de Bioimpedância

Descrição

Cria uma nova avaliação física de Bioimpedância para um membro no EVO.

O endpoint permite registrar os dados coletados durante uma avaliação de bioimpedância, incluindo informações básicas do membro, composição corporal, distribuição de massa muscular e gordura por segmento corporal e fotos da avaliação.

A avaliação é vinculada ao membro, ao colaborador responsável e ao protocolo de Bioimpedância informado.

🚧 Observações
Os dados enviados devem respeitar a configuração do protocolo informado em idProtocol, incluindo os campos habilitados e obrigatórios definidos para o protocolo.
As fotos da avaliação podem ser informadas por URL. A URL deve possuir acesso público, sem necessidade de autenticação.

📨 Corpo da Requisição (Request Body)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idMember`	int32	Sim	Identificador do membro para o qual a avaliação de Bioimpedância será criada.
`idProtocol`	int32	Sim	Identificador do protocolo de Bioimpedância utilizado na avaliação.
`idEmployee`	int32	Sim	Identificador do colaborador responsável pela avaliação.
`basicData`	object	Sim	Dados básicos do membro utilizados na avaliação. Ver mais abaixo.
`muscleMass`	number	Situacional	Massa muscular.
`fatMass`	number	Situacional	Massa de gordura.
`fatFreeMass`	number	Situacional	Massa livre de gordura.
`skeletalMass`	number	Situacional	Massa esquelética.
`residuals`	number	Situacional	Resíduos.
`visceralFatPercentage`	number	Situacional	Percentual de gordura visceral.
`bodyFatPercentage`	number	Situacional	Percentual de gordura corporal.
`basalMetabolicRate`	number	Situacional	Taxa metabólica basal.
`waistHipRatio`	number	Situacional	Relação cintura-quadril.
`metabolicAge`	int32	Situacional	Idade metabólica.
`obesityDegree`	number	Situacional	Grau de obesidade.
`bodyWater`	number	Situacional	Água corporal.
`muscleMassRightArm`	number	Situacional	Massa muscular do braço direito.
`muscleMassLeftArm`	number	Situacional	Massa muscular do braço esquerdo.
`muscleMassLeftLeg`	number	Situacional	Massa muscular da perna esquerda.
`muscleMassRightLeg`	number	Situacional	Massa muscular da perna direita.
`muscleMassTrunk`	number	Situacional	Massa muscular do tronco.
`fatMassRightArm`	number	Situacional	Massa de gordura do braço direito.
`fatMassLeftArm`	number	Situacional	Massa de gordura do braço esquerdo.
`fatMassRightLeg`	number	Situacional	Massa de gordura da perna direita.
`fatMassLeftLeg`	number	Situacional	Massa de gordura da perna esquerda.
`fatMassTrunk`	number	Situacional	Massa de gordura do tronco.
`photoFront`	string	Não	URL pública da foto frontal da avaliação.
`photoBack`	string	Não	URL pública da foto posterior da avaliação.
`photoLeftSide`	string	Não	URL pública da foto lateral esquerda da avaliação.
`photoRightSide`	string	Não	URL pública da foto lateral direita da avaliação.

OBS. A obrigatoriedade dos dados da avaliação classificados como Situacional depende da configuração do protocolo informado em idProtocol. Os campos habilitados e obrigatórios podem ser consultados através do endpoint de detalhes do protocolo.

🧩 Estrutura do Objeto `basicData`

Campo	Tipo	Obrigatoriedade	Descrição
`weight`	number	Sim	Peso do membro.
`height`	number	Sim	Altura do membro.
`birthDate`	date-time	Sim	Data de nascimento do membro.
`age`	int32	Sim	Idade do membro.
`biologicalSex`	string	Sim	Sexo biológico do membro.
`morphology`	string	Não	Morfologia informada na avaliação.
`objectives`	array	Não	Lista de objetivos do membro.
`objectivesDescription`	array	Não	Lista de descrições dos objetivos do membro.

📥 Exemplo de Requisição

{
  "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
}

📤 Estrutura da Resposta

Em caso de sucesso, o endpoint retorna HTTP 200 (OK) com o identificador da avaliação física criada.

Campo	Tipo	Descrição
`idFitnessAssessment`	int32	Identificador único da avaliação física de Bioimpedância criada.

Requisição

Authorization

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Parâmetros Body

application/json-patch+json

Exemplo

{
    "idMember": 0,
    "idProtocol": 0,
    "idEmployee": 0,
    "basicData": {
        "weight": 0,
        "height": 0,
        "birthDate": "2019-08-24T14:15:22.123Z",
        "age": 0,
        "biologicalSex": "string",
        "morphology": "string",
        "objectives": [
            "string"
        ],
        "objectivesDescription": [
            "string"
        ]
    },
    "muscleMass": 0,
    "fatMass": 0,
    "fatFreeMass": 0,
    "skeletalMass": 0,
    "residuals": 0,
    "visceralFatPercentage": 0,
    "bodyFatPercentage": 0,
    "basalMetabolicRate": 0,
    "waistHipRatio": 0,
    "metabolicAge": 0,
    "obesityDegree": 0,
    "bodyWater": 0,
    "muscleMassRightArm": 0,
    "muscleMassLeftArm": 0,
    "muscleMassLeftLeg": 0,
    "muscleMassRightLeg": 0,
    "muscleMassTrunk": 0,
    "fatMassRightArm": 0,
    "fatMassLeftArm": 0,
    "fatMassRightLeg": 0,
    "fatMassLeftLeg": 0,
    "fatMassTrunk": 0,
    "photoFront": "string",
    "photoBack": "string",
    "photoLeftSide": "string",
    "photoRightSide": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add a bioimpedance fitness assessment for the member (RF-5). Returns the created id.

Criar Avaliação Física de Bioimpedância

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `basicData`

📥 Exemplo de Requisição

📤 Estrutura da Resposta

Requisição

Exemplos de Requisição

Respostas

Add a bioimpedance fitness assessment for the member (RF-5). Returns the created id.

Criar Avaliação Física de Bioimpedância#

Descrição#

📨 Corpo da Requisição (Request Body)#

🧩 Estrutura do Objeto basicData#

📥 Exemplo de Requisição#

📤 Estrutura da Resposta#

Requisição

Exemplos de Requisição

Respostas

Criar Avaliação Física de Bioimpedância

Descrição

📨 Corpo da Requisição (Request Body)

🧩 Estrutura do Objeto `basicData`

📥 Exemplo de Requisição

📤 Estrutura da Resposta