Siga a estrutura de pergunta recomendada pelo Dev Bot antes de enviar suas dúvidas de integração.
OBS. Este endpoint está disponível exclusivamente para uso com chave de acesso de ADM Geral.
OBS. Quando o parâmetro idProtocolfor informado, as avaliações do tipo4(Dobras Cutâneas) não serão incluídas no resultado, pois esse tipo de avaliação não possui protocolo personalizado.
| Parâmetro | Tipo | Obrigatoriedade | Descrição |
|---|---|---|---|
idBranch | array[int32] | Não | Lista de identificadores das filiais pelas quais as avaliações serão filtradas. |
createdDateStart | string (date-time) | Não | Data e hora inicial do período de criação das avaliações. |
createdDateEnd | string (date-time) | Não | Data e hora final do período de criação das avaliações. |
expiryDateStart | string (date-time) | Não | Data e hora inicial do período de expiração das avaliações. |
expiryDateEnd | string (date-time) | Não | Data e hora final do período de expiração das avaliações. |
expired | boolean | Não | Filtra as avaliações de acordo com o status de expiração. |
idMember | int32 | Não | Filtra pelo identificador de um membro específico. |
idEmployee | int32 | Não | Filtra pelo identificador de um colaborador específico. |
idProtocol | int32 | Não | Filtra pelo identificador de um protocolo específico. Quando informado, avaliações do tipo 4 (Dobras Cutâneas) são excluídas do resultado. |
type | int32 | Não | Filtra pelo tipo de avaliação física. |
take | int32 | Não | Número máximo de registros a serem retornados. Padrão: 200. |
skip | int32 | Não | Quantidade de registros a serem ignorados antes do retorno dos resultados. Padrão: 0. |
type permite filtrar as avaliações conforme seu tipo:| Código | Tipo |
|---|---|
1 | Anamnese |
2 | Bioimpedância |
3 | Circunferências |
4 | Dobras Cutâneas |
| Campo | Tipo | Descrição |
|---|---|---|
idFitnessAssessment | int32 | Identificador único da avaliação física. |
idProtocol | int32 | Identificador do protocolo utilizado na avaliação física. |
idMember | int32 | Identificador do membro avaliado. |
nameMember | string | Nome do membro avaliado. |
dateCreated | date-time | Data e hora em que a avaliação física foi criada. |
idEmployee | int32 | Identificador do colaborador responsável pela avaliação. |
nameEmployee | string | Nome do colaborador responsável pela avaliação. |
expiryDate | date-time | Data e hora de expiração da avaliação física. |
editedDate | date-time | Data e hora da última edição da avaliação física. |
type | int32 | Tipo da avaliação física. |
nameType | string | Nome do tipo da avaliação física. |