Obtener Programación de Actividades por idService o idMembership

Descripción

Este endpoint devuelve los horarios de actividades disponibles para agendamiento, considerando las reglas de disponibilidad y ocupación de clases.

🔑 Parámetros de Consulta (Query Param)

La consulta puede realizarse a partir de un ID de servicio o un ID de matrícula (membership), siempre limitando el período a un máximo de 7 días.

Es OBLIGATORIO informar idService o idMembership (uno de los dos).

Parâmetro	Tipo	Obligatoriedad	Descripción
idService	int32	Situacional	Filtrar por la identificación de un servicio. Obligatorio si `idMembership` no se informa.
idMembership	int32	Situacional	Filtrar por la identificación de una matrícula. Obligatorio si `idService` no se informa.
startDate	string(date-time)	Sí	Fecha inicial de la consulta.
endDate	string(date-time)	No	Fecha final de la consulta. Si no se informa, se asume `startDate + 7 días`. Siempre limitado a un período máximo de 7 días.
idBranch	int32	No	Filtrar por la sucursal. Recomendado para escenarios con múltiples sucursales.
idActivities	string	No	Uno o más IDs de actividad separados por coma (ej.: `101,102,103`).
allowEnrollment	boolean	No	Filtra todos los horarios futuros, devolviendo solo las actividades/horarios que tienen plazas disponibles.

Estructura de la Respuesta

La respuesta devuelve una lista de actividades disponibles en el período solicitado. Incluye únicamente los horarios aún disponibles para agendamiento, respetando restricciones de capacidad, sucursal y actividad.

Campo	Tipo	Descripción
idConfiguration	int32	Identificador de la configuración de la actividad.
idActivity	int32	Identificador de la actividad.
name	string	Nombre de la actividad.
idGroupActivity	int32	Identificador del grupo de la actividad.
activityGroup	string	Nombre del grupo de la actividad.
description	string	Descripción de la actividad.
activityDate	string(date-time)	Fecha de la actividad.
startTime	string	Horario de inicio de la actividad.
endTime	string	Horario de finalización de la actividad.
area	string	Nombre del área/lugar donde ocurre la actividad.
idArea	int32	Identificador del área.
allowChoosingSpot	boolean	Indica si está permitido elegir el lugar en la actividad.
capacity	int32	Capacidad total de la actividad.
ocupation	int32	Número de plazas ya ocupadas.
idActivitySession	int32	Identificador de la sesión de la actividad.
availableOnHoliday	boolean	Indica si la actividad está disponible en días festivos.
status	int32	Código de estado de la actividad.
statusName	string	Nombre del estado de la actividad.
spots	array	Lista de lugares disponibles.

🧩 Estructura del Objeto `spots`

Campo	Tipo	Descripción
number	int32	Número del lugar.
available	boolean	Indica si el lugar está disponible.
nameSpot	string	Nombre o identificador del 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

Obtener Programación de Actividades por idService o idMembership#

Descripción#

🔑 Parámetros de Consulta (Query Param)#

Estructura de la Respuesta#

🧩 Estructura del Objeto spots#