Recupera uma agenda detalhada de atividades, incluindo informações como data, hora, local, capacidade e detalhes específicos sobre o instrutor e a configuração da atividade.
Parâmetros de Consulta
Este endpoint pode incluir parâmetros opcionais para filtrar a agenda de atividades. Em um cenário de grande número de filiais, recomendamos informar o idBranch da filial associada às atividades desejadas. Continue lendo essa seção da documentação para mais detalhes sobre os parâmetros disponíveis.
Parâmetro
Tipo
Obrigatório
Descrição
idMember
int32
Não
Filtra por membro
take
int32
Não
Total de registros a serem retornados
onlyAvailables
boolean
Não
Filtra por atividades disponíveis. false por padrão.
date
date-time
Não
Filtra por uma data específica.
showFullWeek
boolean
Não
Mostra todas as atividades da semana.
idBranch
int32
Recomendável
Filtra por filial.
idActivities
string
Não
Filtra pelo ID de atividades. Informar os IDs separados por vírgulas.
idAudiences
string
Não
Filtra pelo ID de audiências. Informar os IDs separados por vírgulas.
idBranchToken
string
Não
Filtrar por filial diferente da atual.
Resposta
A resposta é um array de objetos de atividades agendadas com a seguinte estrutura:
Campo
Tipo
Descrição
idConfiguration
inteiro
Identificador único da configuração da atividade.
idActivity
inteiro
Identificador único para a atividade.
idGroupActivity
inteiro
Identificador do grupo de atividades ao qual pertence.
name
string
Nome da atividade.
description
string
Descrição detalhada da atividade.
imageUrl
string
URL da imagem da atividade.
area
string
Área onde a atividade será realizada.
idArea
inteiro
Identificador da área da atividade.
capacity
inteiro
Capacidade máxima de participantes para a atividade.
ocupation
inteiro
Quantidade de vagas ocupadas.
allowChoosingSpot
booleano
Indica se é permitido escolher o local específico (true ou false).
startTime
string
Hora de início da atividade (formato HH:MM).
endTime
string
Hora de término da atividade (formato HH:MM).
bookingStartTime
string
Hora de início para reservas (formato HH:MM).
bookingEndTime
string
Hora de término para reservas (formato HH:MM).
instructor
string
Nome do instrutor responsável pela atividade.
instructorPhoto
string
URL da foto do instrutor.
activityDate
datetime
Data da atividade (formato ISO 8601).
audience
string
Público-alvo da atividade.
idAudience
inteiro
Identificador do público-alvo.
code
string
Código identificador da atividade.
confirmed
booleano
Indica se a atividade está confirmada (true ou false).
spots
array
Lista de assentos/vagas disponíveis para a atividade (detalhado abaixo).
periodization
array
Lista de configurações de periodização (detalhado abaixo).
status
inteiro
Código de status da atividade.
statusName
string
Nome do status da atividade.
Estrutura do Objeto spots
Campo
Tipo
Descrição
number
inteiro
Número do assento ou vaga.
available
booleano
Indica se o assento está disponível (true ou false).
nameSpot
string
Nome ou identificação do assento.
Estrutura do Objeto periodization
Campo
Tipo
Descrição
name
string
Nome da periodização.
characteristics
string
Características específicas da periodização.
color
string
Código de cor associado à periodização.
intensityNumber
inteiro
Nível de intensidade associado à periodização.
type
string
Tipo de periodização.
Status da atividade
Status
Descrição
Valor
Livre
Aula configurada como livre no sistema (Evo).
0
Disponível
Aula pode ser agendada.
1
Lotada
Aula lotada, não é possível agendar, a fila de espera está ativa.
2
Reserva Encerada
Aula não pode mais ser agendada porque já passou do horário.
3
Restrita
Aluno sem direito a participar, precisa comprar um contrato para ter direito.
4
Cadastrado
Aluno já está cadastrado na aula.
5
Finalizada
Aula marcada como finalizada no Evo.
6
Cancelada
Aula cancelada no Evo.
7
Na Fila
Aula estava lotada e o aluno entrou na fila de espera.
8
Livre Encerrada
Aula configurada como livre no Evo e já foi finalizada.
10
Restrita Encerrada
Aula restrita e já foi finalizada no Evo.
11
Restrita Não Permite Participar
Aula não permite agendamento, apenas participação presencial.
12
Lotada Sem Fila de Espera
Aula lotada e não permite que o aluno entre na fila de espera.