Consultar Últimos Treinos dos Membros

Descrição

Este endpoint permite realizar uma consulta gerencial dos últimos treinos dos membros ativos de uma unidade, com filtros por status do treino, instrutor e períodos de criação, validade, edição e última execução.

A consulta considera apenas treinos da nova versão de prescrição de treino. Quando um membro não possui nenhum treino da nova versão, inclusive nos casos em que possui apenas treinos da versão legada, ele será considerado sem treino (workoutStatus = 0).

A resposta retorna as informações cadastrais e gerenciais do último treino considerado para cada membro, sem incluir os dados detalhados do treino, como exercícios e séries.

🔑 Parâmetros de Consulta

Parâmetro	Tipo	Obrigatoriedade	Descrição
`idBranch`	int32	Situacional	Identificador da filial para a qual os treinos serão consultados. Para uma chave de ADM Geral, é opcional e, quando não informado, a consulta considera todas as filiais. Para uma chave multifilial, é obrigatório. Para uma chave de filial, a consulta considera exclusivamente a filial da chave; informar uma filial diferente resulta em erro `400`.
`workoutStatus`	int32	Não	Filtra pelo status do último treino considerado para o membro. Valores: `0` = sem treino, `1` = expirado, `2` = ativo e `4` = data de início futura.
`idInstructor`	int32	Não	Filtra pelo identificador do instrutor que prescreveu o treino.
`createdDateStart`	string (date-time)	Não	Data e hora inicial do período de criação do treino. O início do período é inclusivo.
`createdDateEnd`	string (date-time)	Não	Data e hora final do período de criação do treino. O final do período é inclusivo e considera o dia completo.
`expiryDateStart`	string (date-time)	Não	Data e hora inicial do período de expiração do treino. O início do período é inclusivo.
`expiryDateEnd`	string (date-time)	Não	Data e hora final do período de expiração do treino. O final do período é inclusivo e considera o dia completo.
`editDateStart`	string (date-time)	Não	Data e hora inicial do período da última edição do treino. O início do período é inclusivo. Treinos que nunca foram editados não são retornados quando este filtro é utilizado.
`editDateEnd`	string (date-time)	Não	Data e hora final do período da última edição do treino. O final do período é inclusivo e considera o dia completo.
`lastSessionDateStart`	string (date-time)	Não	Data e hora inicial do período da última sessão concluída pelo membro. O início do período é inclusivo.
`lastSessionDateEnd`	string (date-time)	Não	Data e hora final do período da última sessão concluída pelo membro. O final do período é inclusivo e considera o dia completo.
`take`	int32	Não	Quantidade de registros por página. O limite máximo é `50`. Valores maiores que `50` ou não positivos utilizam `50`. Padrão: `50`.
`skip`	int32	Não	Quantidade de registros a serem ignorados antes do retorno dos resultados. Padrão: `0`.

🔷 Status do Treino

O parâmetro workoutStatus permite filtrar os membros de acordo com o status do último treino considerado na consulta.

Código	Status	Descrição
`0`	Sem treino	O membro não possui um treino da nova versão de prescrição. Também se aplica quando todos os treinos do membro pertencem à versão legada.
`1`	Expirado	O último treino da nova versão está expirado.
`2`	Ativo	O último treino da nova versão está ativo.
`4`	Data de início futura	O último treino da nova versão possui data de início posterior à data da consulta.

📤 Estrutura da Resposta

A resposta retorna uma lista com o último treino da nova versão de cada membro ativo considerado na consulta.

Os dados retornados são de caráter gerencial e cadastral. As informações detalhadas do treino, como exercícios, séries e demais configurações da prescrição, não fazem parte deste retorno.

Campo	Tipo	Descrição
`id`	int32	Identificador do registro retornado.
`idBranch`	int32	Identificador da filial à qual o registro está associado.
`idClient`	int32	Identificador do cliente associado ao treino.
`idProspect`	int32	Identificador do prospect associado, quando aplicável.
`idEmployee`	int32	Identificador do colaborador associado ao treino.
`name`	string	Nome associado ao registro.
`photoUrl`	string	URL da foto do cliente.
`firstName`	string	Primeiro nome do cliente.
`lastName`	string	Sobrenome do cliente.
`idWorkout`	int32	Identificador do treino.
`workoutName`	string	Nome do treino.
`observations`	string	Observações relacionadas ao treino.
`flDefaultWorkout`	boolean	Indica se o treino é o treino padrão.
`isDeleted`	boolean	Indica se o treino está marcado como excluído.
`creationDate`	date-time	Data e hora de criação do treino.
`editedDate`	date-time	Data e hora da última edição do treino.
`startDate`	date-time	Data e hora de início do treino.
`expiryDate`	date-time	Data e hora de expiração do treino.
`tags`	arrayobject	Lista de tags associadas ao treino. Ver mais abaixo.
`restrictions`	arrayobject	Lista de restrições associadas ao treino. Ver mais abaixo.
`workoutStatus`	int32	Status do treino. Ver os valores acima.
`idInstructor`	int32	Identificador do instrutor que prescreveu o treino.
`instructorName`	string	Nome do instrutor que prescreveu o treino.
`instructorPhoto`	string	URL da foto do instrutor.
`idLastWorkut`	int32	Identificador do último treino considerado.
`totalSessions`	int32	Quantidade total de sessões previstas ou registradas para o treino.
`completedSessions`	int32	Quantidade de sessões concluídas.
`lastCompletedSessionDate`	date-time	Data e hora da última sessão concluída pelo membro.
`weeklyQuantity`	int32	Quantidade semanal configurada para o treino.
`weeklyFrequency`	int32	Frequência semanal configurada para o treino.

🧩 Estrutura de `tags`

Campo	Tipo	Descrição
`idTagTreino`	int32	Identificador da tag do treino.
`nome`	string	Nome da tag.
`idFilial`	int32	Identificador da filial associada à tag.

🧩 Estrutura de `restrictions`

Campo	Tipo	Descrição
`idRestricaoTreino`	int32	Identificador da restrição do treino.
`nome`	string	Nome da restrição.
`idFilial`	int32	Identificador da filial associada à restrição.

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 *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200

application/json

Success

Body

Exemplo

[
    {
        "id": 0,
        "idBranch": 0,
        "idClient": 0,
        "idProspect": 0,
        "idEmployee": 0,
        "name": "string",
        "photoUrl": "string",
        "firstName": "string",
        "lastName": "string",
        "idWorkout": 0,
        "workoutName": "string",
        "observations": "string",
        "flDefaultWorkout": true,
        "isDeleted": true,
        "creationDate": "2019-08-24T14:15:22.123Z",
        "editedDate": "2019-08-24T14:15:22.123Z",
        "startDate": "2019-08-24T14:15:22.123Z",
        "expiryDate": "2019-08-24T14:15:22.123Z",
        "tags": [
            {
                "idTagTreino": 0,
                "nome": "string",
                "idFilial": 0
            }
        ],
        "restrictions": [
            {
                "idRestricaoTreino": 0,
                "nome": "string",
                "idFilial": 0
            }
        ],
        "workoutStatus": 0,
        "idInstructor": 0,
        "instructorName": "string",
        "instructorPhoto": "string",
        "idLastWorkut": 0,
        "totalSessions": 0,
        "completedSessions": 0,
        "lastCompletedSessionDate": "2019-08-24T14:15:22.123Z",
        "weeklyQuantity": 0,
        "weeklyFrequency": 0
    }
]

🟠400

Get the latest workout of each active member of a branch (management view). Only workouts from the new workout version are considered - a member whose workouts all come from the legacy version is reported as having no workout (workoutStatus 0).

Consultar Últimos Treinos dos Membros#

Descrição#

🔑 Parâmetros de Consulta#

🔷 Status do Treino#

📤 Estrutura da Resposta#

🧩 Estrutura de tags#

🧩 Estrutura de restrictions#

Requisição