Obter Grade de Atividades pelo idService ou idMembership

Descrição

Este endpoint retorna os horários de atividades disponíveis para agendamento, considerando as regras de disponibilidade e ocupação de aulas.

🔑 Parâmetros de Consulta (Query Param)

A consulta pode ser feita a partir de um ID de serviço ou um ID de matrícula (membership), sempre limitando o período a no máximo 7 dias.

É OBRIGATÓRIO informar idService ou idMembership (um dos dois).

Parâmetro	Tipo	Obrigatoriedade	Descrição
idService	int32	Situacional	Filtrar pela identificação de um serviço. Obrigatório se `idMembership` não for informado.
idMembership	int32	Situacional	Filtrar pela identificação de uma matrícula. Obrigatório se `idService` não for informado.
startDate	string(date-time)	Sim	Data inicial da consulta.
endDate	string(date-time)	Não	Data final da consulta. Caso não informado, assume `startDate + 7 dias`. Sempre limitado a um período máximo de 7 dias.
idBranch	int32	Não	Filtrar pela filial. Recomendado para cenários de múltiplas filiais.
idActivities	string	Não	Um ou mais IDs de atividade separados por vírgula (ex.: `101,102,103`).
AlowEnrollment	boolean	Não	Filtre todos os horários futuros, retornando apenas as atividades/horários que possuem vagas disponíveis.

Estrutura da Resposta

A resposta retorna uma lista de atividades disponíveis no período solicitado. Trazendo apenas os horários ainda disponíveis para agendamento, respeitando restrições de capacidade, filial e atividade.

Campo	Tipo	Descrição
idConfiguration	int32	Identificador da configuração da atividade.
idActivity	int32	Identificador da atividade.
name	string	Nome da atividade.
idGroupActivity	int32	Identificador do grupo da atividade.
activityGroup	string	Nome do grupo da atividade.
description	string	Descrição da atividade.
activityDate	string(date-time)	Data da atividade.
startTime	string	Horário de início da atividade.
endTime	string	Horário de término da atividade.
area	string	Nome da área/local onde a atividade ocorre.
idArea	int32	Identificador da área.
allowChoosingSpot	boolean	Indica se é permitido escolher o lugar na atividade.
capacity	int32	Capacidade total da atividade.
ocupation	int32	Número de vagas já ocupadas.
idActivitySession	int32	Identificador da sessão da atividade.
availableOnHoliday	boolean	Indica se a atividade está disponível em feriados.
status	int32	Código de status da atividade.
statusName	string	Nome do status da atividade.
spots	array	Lista de lugares disponíveis.

🧩 Estrutura do Objeto `spots`

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

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

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idConfiguration": 0,
        "idActivity": 0,
        "name": "string",
        "idGroupActivity": 0,
        "activityGroup": "string",
        "description": "string",
        "activityDate": "2019-08-24T14:15:22.123Z",
        "startTime": "string",
        "endTime": "string",
        "area": "string",
        "idArea": 0,
        "allowChoosingSpot": true,
        "capacity": 0,
        "ocupation": 0,
        "idActivitySession": 0,
        "availableOnHoliday": true,
        "status": 0,
        "statusName": "string",
        "spots": [
            {
                "number": 0,
                "available": true,
                "nameSpot": "string"
            }
        ]
    }
]

🟠400Bad Request

Get activities schedule by idService or idMembership

Obter Grade de Atividades pelo idService ou idMembership#

Descrição#

🔑 Parâmetros de Consulta (Query Param)#

Estrutura da Resposta#

🧩 Estrutura do Objeto spots#