Retornar Matrículas em Atividades

Descrição

Retorna a lista de matrículas de atividades para um determinado aluno, considerando filtros como plano, data e filial. Ideal para exibir agendas, histórico de reservas e status de participação em atividades no aplicativo, site ou sistemas integrados.

🔑 Parâmetros de Consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
idMember	int32	Sim	ID do aluno (membro) que deseja consultar as matrículas.
idMemberMemberShip	int32	Não	ID do plano do aluno (membership).
date	date-time	Não	Data de referência para filtrar as atividades.
idBranch	int32	Não	ID da filial para filtrar os resultados.

📤 Estrutura de Resposta

A resposta retorna uma lista de atividades nas quais o aluno está matriculado, incluindo informações da sessão, instrutor, horários, ocupação, status e recursos adicionais como vagas e periodização.

Campo	Tipo	Descrição
idConfigurationEnroll	int32	ID da configuração de matrícula.
idConfiguration	int32	ID da configuração da atividade.
idActivitie	int32	ID da atividade.
idActivitieSession	int32	ID da sessão da atividade.
idGroupActivity	int32	ID do grupo da atividade.
activitieName	string	Nome da atividade.
description	string	Descrição da atividade.
imageURL	string	URL da imagem da atividade.
area	string	Nome da área onde a atividade ocorre.
idArea	int32	ID da área.
capacity	int32	Capacidade máxima da atividade.
ocupation	int32	Quantidade de vagas ocupadas.
allowChoosingSpot	boolean	Indica se é permitido escolher vaga/posição.
startTime	string	Horário de início da atividade.
endTime	string	Horário de término da atividade.
bookingStartTime	string	Horário de abertura para reservas.
bookingEndTime	string	Horário de encerramento das reservas.
instructor	string	Nome do instrutor responsável.
instructorPhoto	string	URL da foto do instrutor.
date	date-time	Data da atividade.
audience	string	Público-alvo da atividade.
idAudience	int32	ID do público-alvo.
code	string	Código da atividade.
confirmed	boolean	Indica se a matrícula está confirmada.
spots	arrayobject	Lista de vagas/posições disponíveis ou ocupadas. Veja mais a seguir.
periodization	arrayobject	Informações de periodização da atividade. Veja mais a seguir.
status	int32	Código do status da matrícula.
statusName	string	Nome descritivo do status da matrícula.
memberStatus	string	Status do aluno na atividade (ex.: confirmado, lista de espera, etc.).

🧩 Estrutura de `spots`

Campo	Tipo	Descrição
number	int32	Número identificador da vaga.
available	boolean	Indica se a vaga está disponível.
nameSpot	string	Nome ou identificação da vaga.

🧩 Estrutura de `periodization`

Campo	Tipo	Descrição
name	string	Nome da periodização.
characteristics	string	Características da periodização.
color	string	Cor associada à periodização (ex.: para exibição UI).
intensityNumber	int32	Nível numérico de intensidade.
type	string	Tipo da periodizaçã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

[
    {
        "idConfigurationEnroll": 0,
        "idConfiguration": 0,
        "idActivitie": 0,
        "idActivitieSession": 0,
        "idGroupActivity": 0,
        "activitieName": "string",
        "description": "string",
        "imageURL": "string",
        "area": "string",
        "idArea": 0,
        "capacity": 0,
        "ocupation": 0,
        "allowChoosingSpot": true,
        "startTime": "string",
        "endTime": "string",
        "bookingStartTime": "string",
        "bookingEndTime": "string",
        "instructor": "string",
        "instructorPhoto": "string",
        "date": "2019-08-24T14:15:22.123Z",
        "audience": "string",
        "idAudience": 0,
        "code": "string",
        "confirmed": true,
        "spots": [
            {
                "number": 0,
                "available": true,
                "nameSpot": "string"
            }
        ],
        "periodization": [
            {
                "name": "string",
                "characteristics": "string",
                "color": "string",
                "intensityNumber": 0,
                "type": "string"
            }
        ],
        "status": 0,
        "statusName": "string",
        "memberStatus": "string"
    }
]

🟠400

/api/v2/activities/enroll

Retornar Matrículas em Atividades#

Descrição#

🔑 Parâmetros de Consulta (Query Params)#

📤 Estrutura de Resposta#

🧩 Estrutura de spots#

🧩 Estrutura de periodization#

Requisição