Recuperar Detalhes do Protocolo de Avaliação Física

Descrição

Retorna os detalhes e a configuração dos campos de um protocolo específico de avaliações físicas cadastradas EXCLUSIVAMENTE pelo EVO APP.

A estrutura da resposta varia de acordo com o tipo de avaliação informado no parâmetro type. Os identificadores dos protocolos não são únicos entre os diferentes tipos de avaliação; por isso, o parâmetro type determina em qual tipo o protocolo será consultado.

Quando o parâmetro type não for informado, a consulta considera Bioimpedância (type = 2) como padrão.

🚧 Observações
Os tipos disponíveis para consulta são: 1 (Anamnese), 2 (Bioimpedância) e 3 (Circunferências).
Avaliações de Dobras Cutâneas (type = 4) não possuem protocolo personalizado.
Os campos com sufixo Enabled indicam se determinado campo está habilitado no protocolo.
Os campos com sufixo Required indicam se o preenchimento do respectivo campo é obrigatório no protocolo.

🔑 Parâmetros de Rota (Path Parameters)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idProtocol`	int32	Sim	Identificador do protocolo personalizado dentro do respectivo tipo de avaliação física.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatoriedade	Descrição
`type`	int32	Não	Tipo de avaliação física do protocolo. Valores disponíveis: `1` = Anamnese, `2` = Bioimpedância e `3` = Circunferências. Quando não informado, considera `2` (Bioimpedância).

📤 Estrutura da Resposta

A estrutura da resposta é dinâmica e varia conforme o type do protocolo consultado.

🧩 Estrutura da Resposta — Anamnese (`type = 1`)

Campo	Tipo	Descrição
`idProtocol`	int32	Identificador do protocolo de Anamnese.
`nameProtocol`	string	Nome do protocolo.
`description`	string	Descrição do protocolo.
`isEvoDefault`	boolean	Indica se o protocolo é um protocolo padrão do EVO.
`morphologyEnabled`	boolean	Indica se o campo de morfologia está habilitado.
`objectivesEnabled`	boolean	Indica se o campo de objetivos está habilitado.
`healthHistoryEnabled`	boolean	Indica se o campo de histórico de saúde está habilitado.
`familyHealthHistoryEnabled`	boolean	Indica se o campo de histórico de saúde familiar está habilitado.
`medicationUseEnabled`	boolean	Indica se o campo de uso de medicamentos está habilitado.
`surgeriesEnabled`	boolean	Indica se o campo de cirurgias está habilitado.
`physicalActivityEnabled`	boolean	Indica se o campo de atividade física está habilitado.
`sleepHoursEnabled`	boolean	Indica se o campo de horas de sono está habilitado.
`sleepQualityEnabled`	boolean	Indica se o campo de qualidade do sono está habilitado.
`professionalActivityEnabled`	boolean	Indica se o campo de atividade profissional está habilitado.
`fitnessLevelEnabled`	boolean	Indica se o campo de nível de condicionamento físico está habilitado.
`smokerEnabled`	boolean	Indica se o campo relacionado ao tabagismo está habilitado.
`alcoholIntakeEnabled`	boolean	Indica se o campo relacionado ao consumo de álcool está habilitado.
`chronicPainsEnabled`	boolean	Indica se o campo de dores crônicas está habilitado.
`healthFilesEnabled`	boolean	Indica se o campo de arquivos relacionados à saúde está habilitado.
`morphologyRequired`	boolean	Indica se o preenchimento da morfologia é obrigatório.
`objectivesRequired`	boolean	Indica se o preenchimento dos objetivos é obrigatório.
`healthHistoryRequired`	boolean	Indica se o preenchimento do histórico de saúde é obrigatório.
`familyHealthHistoryRequired`	boolean	Indica se o preenchimento do histórico de saúde familiar é obrigatório.
`medicationUseRequired`	boolean	Indica se o preenchimento do uso de medicamentos é obrigatório.
`surgeriesRequired`	boolean	Indica se o preenchimento das cirurgias é obrigatório.
`physicalActivityRequired`	boolean	Indica se o preenchimento da atividade física é obrigatório.
`sleepHoursRequired`	boolean	Indica se o preenchimento das horas de sono é obrigatório.
`sleepQualityRequired`	boolean	Indica se o preenchimento da qualidade do sono é obrigatório.
`professionalActivityRequired`	boolean	Indica se o preenchimento da atividade profissional é obrigatório.
`fitnessLevelRequired`	boolean	Indica se o preenchimento do nível de condicionamento físico é obrigatório.
`smokerRequired`	boolean	Indica se o preenchimento das informações de tabagismo é obrigatório.
`alcoholIntakeRequired`	boolean	Indica se o preenchimento das informações de consumo de álcool é obrigatório.
`chronicPainsRequired`	boolean	Indica se o preenchimento das dores crônicas é obrigatório.
`healthFilesRequired`	boolean	Indica se o envio de arquivos relacionados à saúde é obrigatório.
`customQuestions`	arrayobject	Lista de perguntas personalizadas configuradas no protocolo. Ver mais abaixo.

🧩 Estrutura de `customQuestions`

Campo	Tipo	Descrição
`idQuestion`	int32	Identificador da pergunta personalizada.
`question`	string	Texto da pergunta personalizada.
`required`	boolean	Indica se a resposta à pergunta é obrigatória.

🧩 Estrutura da Resposta — Bioimpedância (`type = 2`)

Campo	Tipo	Descrição
`idProtocol`	int32	Identificador do protocolo de Bioimpedância.
`nameProtocol`	string	Nome do protocolo.
`description`	string	Descrição do protocolo.
`isEvoDefault`	boolean	Indica se o protocolo é um protocolo padrão do EVO.
`fatMassEnabled`	boolean	Indica se o campo de massa de gordura está habilitado.
`fatFreeMassEnabled`	boolean	Indica se o campo de massa livre de gordura está habilitado.
`muscleMassEnabled`	boolean	Indica se o campo de massa muscular está habilitado.
`skeletalMassEnabled`	boolean	Indica se o campo de massa esquelética está habilitado.
`residualsEnabled`	boolean	Indica se o campo de resíduos está habilitado.
`visceralFatPercentageEnabled`	boolean	Indica se o campo de percentual de gordura visceral está habilitado.
`bodyWaterEnabled`	boolean	Indica se o campo de água corporal está habilitado.
`bodyWaterPercentageEnabled`	boolean	Indica se o campo de percentual de água corporal está habilitado.
`bodyWaterLitersEnabled`	boolean	Indica se o campo de água corporal em litros está habilitado.
`bodyFatPercentageEnabled`	boolean	Indica se o campo de percentual de gordura corporal está habilitado.
`basalMetabolicRateEnabled`	boolean	Indica se o campo de taxa metabólica basal está habilitado.
`waistHipRatioEnabled`	boolean	Indica se o campo de relação cintura-quadril está habilitado.
`metabolicAgeEnabled`	boolean	Indica se o campo de idade metabólica está habilitado.
`obesityDegreeEnabled`	boolean	Indica se o campo de grau de obesidade está habilitado.
`muscleMassRightArmEnabled`	boolean	Indica se o campo de massa muscular do braço direito está habilitado.
`muscleMassLeftArmEnabled`	boolean	Indica se o campo de massa muscular do braço esquerdo está habilitado.
`muscleMassRightLegEnabled`	boolean	Indica se o campo de massa muscular da perna direita está habilitado.
`muscleMassLeftLegEnabled`	boolean	Indica se o campo de massa muscular da perna esquerda está habilitado.
`muscleMassTrunkEnabled`	boolean	Indica se o campo de massa muscular do tronco está habilitado.
`fatMassRightArmEnabled`	boolean	Indica se o campo de massa de gordura do braço direito está habilitado.
`fatMassLeftArmEnabled`	boolean	Indica se o campo de massa de gordura do braço esquerdo está habilitado.
`fatMassRightLegEnabled`	boolean	Indica se o campo de massa de gordura da perna direita está habilitado.
`fatMassLeftLegEnabled`	boolean	Indica se o campo de massa de gordura da perna esquerda está habilitado.
`fatMassTrunkEnabled`	boolean	Indica se o campo de massa de gordura do tronco está habilitado.
`fatMassRequired`	boolean	Indica se o preenchimento da massa de gordura é obrigatório.
`fatFreeMassRequired`	boolean	Indica se o preenchimento da massa livre de gordura é obrigatório.
`muscleMassRequired`	boolean	Indica se o preenchimento da massa muscular é obrigatório.
`skeletalMassRequired`	boolean	Indica se o preenchimento da massa esquelética é obrigatório.
`residualsRequired`	boolean	Indica se o preenchimento de resíduos é obrigatório.
`visceralFatPercentageRequired`	boolean	Indica se o preenchimento do percentual de gordura visceral é obrigatório.
`bodyWaterRequired`	boolean	Indica se o preenchimento da água corporal é obrigatório.
`bodyFatPercentageRequired`	boolean	Indica se o preenchimento do percentual de gordura corporal é obrigatório.
`basalMetabolicRateRequired`	boolean	Indica se o preenchimento da taxa metabólica basal é obrigatório.
`waistHipRatioRequired`	boolean	Indica se o preenchimento da relação cintura-quadril é obrigatório.
`metabolicAgeRequired`	boolean	Indica se o preenchimento da idade metabólica é obrigatório.
`obesityDegreeRequired`	boolean	Indica se o preenchimento do grau de obesidade é obrigatório.
`muscleMassRightArmRequired`	boolean	Indica se o preenchimento da massa muscular do braço direito é obrigatório.
`muscleMassLeftArmRequired`	boolean	Indica se o preenchimento da massa muscular do braço esquerdo é obrigatório.
`muscleMassRightLegRequired`	boolean	Indica se o preenchimento da massa muscular da perna direita é obrigatório.
`muscleMassLeftLegRequired`	boolean	Indica se o preenchimento da massa muscular da perna esquerda é obrigatório.
`muscleMassTrunkRequired`	boolean	Indica se o preenchimento da massa muscular do tronco é obrigatório.
`fatMassRightArmRequired`	boolean	Indica se o preenchimento da massa de gordura do braço direito é obrigatório.
`fatMassLeftArmRequired`	boolean	Indica se o preenchimento da massa de gordura do braço esquerdo é obrigatório.
`fatMassRightLegRequired`	boolean	Indica se o preenchimento da massa de gordura da perna direita é obrigatório.
`fatMassLeftLegRequired`	boolean	Indica se o preenchimento da massa de gordura da perna esquerda é obrigatório.
`fatMassTrunkRequired`	boolean	Indica se o preenchimento da massa de gordura do tronco é obrigatório.

🧩 Estrutura da Resposta — Circunferências (`type = 3`)

Campo	Tipo	Descrição
`idProtocol`	int32	Identificador do protocolo de Circunferências.
`nameProtocol`	string	Nome do protocolo.
`description`	string	Descrição do protocolo.
`isEvoDefault`	boolean	Indica se o protocolo é um protocolo padrão do EVO.
`neckEnabled`	boolean	Indica se a medida do pescoço está habilitada.
`shouldersEnabled`	boolean	Indica se a medida dos ombros está habilitada.
`rightShoulderEnabled`	boolean	Indica se a medida do ombro direito está habilitada.
`leftShoulderEnabled`	boolean	Indica se a medida do ombro esquerdo está habilitada.
`chestEnabled`	boolean	Indica se a medida do tórax está habilitada.
`chestExpirationEnabled`	boolean	Indica se a medida do tórax em expiração está habilitada.
`hipEnabled`	boolean	Indica se a medida do quadril está habilitada.
`waistEnabled`	boolean	Indica se a medida da cintura está habilitada.
`abdomenEnabled`	boolean	Indica se a medida do abdômen está habilitada.
`rightArmContractedEnabled`	boolean	Indica se a medida do braço direito contraído está habilitada.
`rightArmRelaxedEnabled`	boolean	Indica se a medida do braço direito relaxado está habilitada.
`leftArmContractedEnabled`	boolean	Indica se a medida do braço esquerdo contraído está habilitada.
`leftArmRelaxedEnabled`	boolean	Indica se a medida do braço esquerdo relaxado está habilitada.
`rightForearmEnabled`	boolean	Indica se a medida do antebraço direito está habilitada.
`leftForearmEnabled`	boolean	Indica se a medida do antebraço esquerdo está habilitada.
`rightWristEnabled`	boolean	Indica se a medida do punho direito está habilitada.
`leftWristEnabled`	boolean	Indica se a medida do punho esquerdo está habilitada.
`rightProximalThighEnabled`	boolean	Indica se a medida proximal da coxa direita está habilitada.
`leftProximalThighEnabled`	boolean	Indica se a medida proximal da coxa esquerda está habilitada.
`rightMedialThighEnabled`	boolean	Indica se a medida medial da coxa direita está habilitada.
`leftMedialThighEnabled`	boolean	Indica se a medida medial da coxa esquerda está habilitada.
`rightDistalThighEnabled`	boolean	Indica se a medida distal da coxa direita está habilitada.
`leftDistalThighEnabled`	boolean	Indica se a medida distal da coxa esquerda está habilitada.
`rightKneeEnabled`	boolean	Indica se a medida do joelho direito está habilitada.
`leftKneeEnabled`	boolean	Indica se a medida do joelho esquerdo está habilitada.
`rightCalfEnabled`	boolean	Indica se a medida da panturrilha direita está habilitada.
`leftCalfEnabled`	boolean	Indica se a medida da panturrilha esquerda está habilitada.
`rightAnkleEnabled`	boolean	Indica se a medida do tornozelo direito está habilitada.
`leftAnkleEnabled`	boolean	Indica se a medida do tornozelo esquerdo está habilitada.
`neckRequired`	boolean	Indica se a medida do pescoço é obrigatória.
`shouldersRequired`	boolean	Indica se a medida dos ombros é obrigatória.
`rightShoulderRequired`	boolean	Indica se a medida do ombro direito é obrigatória.
`leftShoulderRequired`	boolean	Indica se a medida do ombro esquerdo é obrigatória.
`chestRequired`	boolean	Indica se a medida do tórax é obrigatória.
`chestExpirationRequired`	boolean	Indica se a medida do tórax em expiração é obrigatória.
`hipRequired`	boolean	Indica se a medida do quadril é obrigatória.
`waistRequired`	boolean	Indica se a medida da cintura é obrigatória.
`abdomenRequired`	boolean	Indica se a medida do abdômen é obrigatória.
`rightArmContractedRequired`	boolean	Indica se a medida do braço direito contraído é obrigatória.
`rightArmRelaxedRequired`	boolean	Indica se a medida do braço direito relaxado é obrigatória.
`leftArmContractedRequired`	boolean	Indica se a medida do braço esquerdo contraído é obrigatória.
`leftArmRelaxedRequired`	boolean	Indica se a medida do braço esquerdo relaxado é obrigatória.
`rightForearmRequired`	boolean	Indica se a medida do antebraço direito é obrigatória.
`leftForearmRequired`	boolean	Indica se a medida do antebraço esquerdo é obrigatória.
`rightWristRequired`	boolean	Indica se a medida do punho direito é obrigatória.
`leftWristRequired`	boolean	Indica se a medida do punho esquerdo é obrigatória.
`rightProximalThighRequired`	boolean	Indica se a medida proximal da coxa direita é obrigatória.
`leftProximalThighRequired`	boolean	Indica se a medida proximal da coxa esquerda é obrigatória.
`rightMedialThighRequired`	boolean	Indica se a medida medial da coxa direita é obrigatória.
`leftMedialThighRequired`	boolean	Indica se a medida medial da coxa esquerda é obrigatória.
`rightDistalThighRequired`	boolean	Indica se a medida distal da coxa direita é obrigatória.
`leftDistalThighRequired`	boolean	Indica se a medida distal da coxa esquerda é obrigatória.
`rightKneeRequired`	boolean	Indica se a medida do joelho direito é obrigatória.
`leftKneeRequired`	boolean	Indica se a medida do joelho esquerdo é obrigatória.
`rightCalfRequired`	boolean	Indica se a medida da panturrilha direita é obrigatória.
`leftCalfRequired`	boolean	Indica se a medida da panturrilha esquerda é obrigatória.
`rightAnkleRequired`	boolean	Indica se a medida do tornozelo direito é obrigatória.
`leftAnkleRequired`	boolean	Indica se a medida do tornozelo esquerdo é obrigatória.

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 de Caminho

Parâmetros de Consulta

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.

Recuperar Detalhes do Protocolo de Avaliação Física

Descrição

🔑 Parâmetros de Rota (Path Parameters)

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta

🧩 Estrutura da Resposta — Anamnese (`type = 1`)

🧩 Estrutura de `customQuestions`

🧩 Estrutura da Resposta — Bioimpedância (`type = 2`)

🧩 Estrutura da Resposta — Circunferências (`type = 3`)

Requisição

Exemplos de Requisição

Respostas

Get a protocol detail (field configuration) of any type (RF-2). The response shape is dynamic per type. Ids are not unique across types, so type selects the source.

Recuperar Detalhes do Protocolo de Avaliação Física#

Descrição#

🔑 Parâmetros de Rota (Path Parameters)#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura da Resposta#

🧩 Estrutura da Resposta — Anamnese (type = 1)#

🧩 Estrutura de customQuestions#

🧩 Estrutura da Resposta — Bioimpedância (type = 2)#

🧩 Estrutura da Resposta — Circunferências (type = 3)#

Requisição

Exemplos de Requisição

Respostas

Recuperar Detalhes do Protocolo de Avaliação Física

Descrição

🔑 Parâmetros de Rota (Path Parameters)

🔑 Parâmetros de Consulta (Query Params)

📤 Estrutura da Resposta

🧩 Estrutura da Resposta — Anamnese (`type = 1`)

🧩 Estrutura de `customQuestions`

🧩 Estrutura da Resposta — Bioimpedância (`type = 2`)

🧩 Estrutura da Resposta — Circunferências (`type = 3`)