Obtener MemberMembership por ID

Descripción

Devuelve un resumen detallado de una asociación (MemberMembership) específica, identificada por su ID. La información incluye datos contractuales, estado, fechas relevantes, sesiones, congelamientos y reglas asociadas a suspensión o fidelización.

OBS. Disponible para uso con clave de acceso de filial y también con clave de acceso de ADM General.

🔑 Parámetro de Consulta (Path Param)

Parámetro	Tipo	Obligatorio	Descripción
idMemberMembership	int32	Sí	ID único del `(MemberMembership)` que se consultará.

📤 Estructura de la Respuesta

Campo	Tipo	Descripción
idMember	int32	ID del miembro.
idMembership	int32	ID del plan/membership.
idMemberMembership	int32	Identificador único del vínculo del miembro con el membership.
idMemberMembershipRenewed	int32	ID del membership renovado (si aplica).
numMembers	int32	Cantidad de miembros asociados (principal + dependientes).
startDate	date-time	Fecha de inicio del membership.
endDate	date-time	Fecha de finalización del membership.
name	string	Nombre del plan/membership.
cancelDate	date-time	Fecha efectiva de cancelación.
cancelDateOn	date-time	Fecha programada para cancelación.
cancelCreationDate	date-time	Fecha en que se creó la solicitud de cancelación.
membershipStatus	string	Estado actual del membership.
valueNextMonth	number	Valor de la próxima mensualidad.
nextCharge	date-time	Fecha del próximo cobro.
nextDateSuspension	date-time	Próxima fecha de suspensión registrada.
idSale	int32	ID de la venta asociada al membership.
saleDate	date-time	Fecha de la venta.
contractPrinting	string	Contenido o URL para impresión del contrato.
freezes	array	Lista de congelamientos del membership. Ver objeto `freezes[]`.
idCategoryMembership	int32	ID de la categoría del membership.
numberSuspensionTimes	int32	Total de suspensiones realizadas.
maxSuspensionDays	int32	Máximo de días permitidos para suspensión.
minimumSuspensionDays	int32	Mínimo de días permitidos para suspensión.
disponibleSuspensionDays	int32	Días disponibles para suspensión.
disponibleSuspensionTimes	int32	Cantidad restante de suspensiones permitidas.
daysLeftToFreeze	int32	Días restantes para congelamiento.
loyaltyEndDate	date-time	Fecha de fin del período de fidelización.
assessmentEndDate	date-time	Fecha de finalización de la evaluación física.
acceptanceDate	date-time	Fecha de aceptación/activación del contrato.
flAllowLocker	boolean	Indica si el miembro puede utilizar locker.
flAdditionalMembership	boolean	Indica si el membership es adicional.
bioimpedanceAmount	number	Cantidad de evaluaciones de bioimpedancia disponibles.
signedTerms	boolean	Indica si los términos fueron firmados.
originalValue	number	Valor original del membership al momento de la venta.
allowLesMills	boolean	Indica si el plan incluye clases Les Mills.
allowsCancellationByApp	boolean	Indica si se permite cancelación vía app.
contractSigningUrl	string	URL de firma digital disponible para aceptación de contrato.
limitless	boolean	Indica si el membership es ilimitado.
weeklyLimit	int32	Límite semanal de uso/sesiones.
concludedSessions	int32	Total de sesiones concluidas.
pendingSessions	int32	Total de sesiones pendientes.
scheduledSessions	int32	Total de sesiones agendadas.
pendingRepositions	int32	Sesiones pendientes de reposición.
repositionsTotal	int32	Total de reposiciones disponibles.
bonusSessions	int32	Total de sesiones bono disponibles.
sessions	array	Lista de sesiones vinculadas al membership. Ver objeto `sessions[]`.

🧩 Estructura del array de objetos `freezes`

Campo	Tipo	Descripción
startSuspend	date-time	Fecha de inicio de la suspensión.
endSuspend	date-time	Fecha de finalización de la suspensión.
unlockDate	date-time	Fecha en que el membership será reactivado.
idEmployee	int32	ID del colaborador que registró el congelamiento.
reason	string	Motivo informado para la suspensión.
flUseMembershipFreezeDays	boolean	Indica si se usan los días permitidos por el membership.
daysFreeze	int32	Cantidad de días congelados.
idFreeze	int32	ID del registro de congelamiento.

🧩 Estructura del array de objetos `sessions`

Campo	Tipo	Descripción
idSession	int32	ID de la sesión.
expirationDate	date-time	Fecha de expiración de la sesión.
flBonusSession	boolean	Indica si la sesión es bono.

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

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idMember": 0,
    "idMembership": 0,
    "idMemberMembership": 0,
    "idMemberMembershipRenewed": 0,
    "numMembers": 0,
    "startDate": "2019-08-24T14:15:22.123Z",
    "endDate": "2019-08-24T14:15:22.123Z",
    "name": "string",
    "cancelDate": "2019-08-24T14:15:22.123Z",
    "cancelDateOn": "2019-08-24T14:15:22.123Z",
    "cancelCreationDate": "2019-08-24T14:15:22.123Z",
    "membershipStatus": "string",
    "valueNextMonth": 0,
    "nextCharge": "2019-08-24T14:15:22.123Z",
    "nextDateSuspension": "2019-08-24T14:15:22.123Z",
    "idSale": 0,
    "saleDate": "2019-08-24T14:15:22.123Z",
    "contractPrinting": "string",
    "freezes": [
        {
            "startSuspend": "2019-08-24T14:15:22.123Z",
            "endSuspend": "2019-08-24T14:15:22.123Z",
            "unlockDate": "2019-08-24T14:15:22.123Z",
            "idEmployee": 0,
            "reason": "string",
            "flUseMembershipFreezeDays": true,
            "daysFreeze": 0,
            "idFreeze": 0
        }
    ],
    "idCategoryMembership": 0,
    "numberSuspensionTimes": 0,
    "maxSuspensionDays": 0,
    "minimumSuspensionDays": 0,
    "disponibleSuspensionDays": 0,
    "disponibleSuspensionTimes": 0,
    "daysLeftToFreeze": 0,
    "loyaltyEndDate": "2019-08-24T14:15:22.123Z",
    "assessmentEndDate": "2019-08-24T14:15:22.123Z",
    "acceptanceDate": "2019-08-24T14:15:22.123Z",
    "flAllowLocker": true,
    "flAdditionalMembership": true,
    "bioimpedanceAmount": 0,
    "signedTerms": true,
    "originalValue": 0,
    "allowLesMills": true,
    "allowsCancellationByApp": true,
    "contractSigningUrl": "string",
    "limitless": true,
    "weeklyLimit": 0,
    "concludedSessions": 0,
    "pendingSessions": 0,
    "scheduledSessions": 0,
    "pendingRepositions": 0,
    "repositionsTotal": 0,
    "bonusSessions": 0,
    "sessions": [
        {
            "idSession": 0,
            "expirationDate": "2019-08-24T14:15:22.123Z",
            "flBonusSession": true
        }
    ]
}

🟠400Bad Request

Get summary of MemberMemberships by id

Obtener MemberMembership por ID

Descripción

🔑 Parámetro de Consulta (Path Param)

📤 Estructura de la Respuesta

🧩 Estructura del array de objetos `freezes`

🧩 Estructura del array de objetos `sessions`

Requisição

Exemplos de Requisição

Respostas

Get summary of MemberMemberships by id

Obtener MemberMembership por ID#

Descripción#

🔑 Parámetro de Consulta (Path Param)#

📤 Estructura de la Respuesta#

🧩 Estructura del array de objetos freezes#

🧩 Estructura del array de objetos sessions#

Requisição

Exemplos de Requisição

Respostas

Obtener MemberMembership por ID

Descripción

🔑 Parámetro de Consulta (Path Param)

📤 Estructura de la Respuesta

🧩 Estructura del array de objetos `freezes`

🧩 Estructura del array de objetos `sessions`