Obter MemberMembership por id

Descrição

Retorna um resumo detalhado de uma associação (MemberMembership) específica, identificada por seu ID. As informações incluem dados contratuais, status, datas relevantes, sessões, congelamentos e regras associadas à suspensão ou fidelização.

🔑 Parâmetro de Consulta (Path Param)

Este endpoint exige um parâmetro obrigatório de caminho (path parameter) para identificar o MemberMembership a ser consultado.

Parâmetro	Tipo	Obrigatório	Descrição
idMemberMembership	int32	Sim	ID único do `(MemberMembership)` que será consultado.

📤 Estrutura da Resposta

Campo	Tipo	Descrição
idMember	int32	ID do membro.
idMembership	int32	ID do plano/membership.
idMemberMembership	int32	Identificador único do vínculo do membro com o membership.
idMemberMembershipRenewed	int32	ID do membership renovado (se houver).
numMembers	int32	Quantidade de membros associados (principal + dependentes).
startDate	date-time	Data de início do membership.
endDate	date-time	Data de término do membership.
name	string	Nome do plano/membership.
cancelDate	date-time	Data efetiva de cancelamento.
cancelDateOn	date-time	Data programada para cancelamento.
cancelCreationDate	date-time	Data em que a solicitação de cancelamento foi criada.
membershipStatus	string	Status atual do membership.
valueNextMonth	number	Valor da próxima mensalidade.
nextCharge	date-time	Data da próxima cobrança.
nextDateSuspension	date-time	Próxima data de suspensão cadastrada.
idSale	int32	ID da venda associada ao membership.
saleDate	date-time	Data da venda.
contractPrinting	string	Conteúdo ou URL para impressão do contrato.
freezes	array	Lista de congelamentos do membership. Ver objeto `freezes[]`.
idCategoryMembership	int32	ID da categoria do membership.
numberSuspensionTimes	int32	Total de suspensões já realizadas.
maxSuspensionDays	int32	Máximo de dias permitidos para suspensão.
minimumSuspensionDays	int32	Mínimo de dias permitidos para suspensão.
disponibleSuspensionDays	int32	Dias disponíveis para suspensão.
disponibleSuspensionTimes	int32	Quantidade restante de suspensões permitidas.
daysLeftToFreeze	int32	Dias restantes para congelamento.
loyaltyEndDate	date-time	Data de fim do período de fidelidade.
assessmentEndDate	date-time	Data de validade da avaliação física.
acceptanceDate	date-time	Data de aceite/ativação do contrato.
flAllowLocker	boolean	Indica se o membro pode utilizar locker.
flAdditionalMembership	boolean	Indica se o membership é adicional.
bioimpedanceAmount	number	Quantidade de avaliações de bioimpedância disponíveis.
signedTerms	boolean	Indica se os termos foram assinados.
originalValue	number	Valor original do membership no momento da venda.
allowLesMills	boolean	Indica se o plano inclui aulas Les Mills.
allowsCancellationByApp	boolean	Se permite cancelamento via aplicativo.
contractSigningUrl	string	URL de assinatura digital do contrato.
limitless	boolean	Indica se o membership é ilimitado.
weeklyLimit	int32	Limite semanal de utilização/sessões.
concludedSessions	int32	Total de sessões concluídas.
pendingSessions	int32	Total de sessões pendentes.
scheduledSessions	int32	Número de sessões agendadas.
pendingRepositions	int32	Sessões pendentes de reposição.
repositionsTotal	int32	Quantidade total de reposições disponíveis.
bonusSessions	int32	Total de sessões bônus disponíveis.
sessions	array	Lista de sessões vinculadas ao membership. Ver objeto `sessions[]`.

🧩 Estrutura do array de objetos `freezes`

Campo	Tipo	Descrição
startSuspend	date-time	Data de início da suspensão.
endSuspend	date-time	Data de término da suspensão.
unlockDate	date-time	Data em que o membership será reativado.
idEmployee	int32	ID do colaborador que registrou o congelamento.
reason	string	Motivo informado para a suspensão.
flUseMembershipFreezeDays	boolean	Se utiliza os dias permitidos pelo membership.
daysFreeze	int32	Quantidade de dias congelados.
idFreeze	int32	ID do registro de congelamento.

🧩 Estrutura do array de objetos `sessions`

Campo	Tipo	Descrição
idSession	int32	ID da sessão.
expirationDate	date-time	Data de expiração da sessão.
flBonusSession	boolean	Indica se a sessão é bônus.

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

Obter MemberMembership por id

Descrição

🔑 Parâmetro de Consulta (Path Param)

📤 Estrutura da Resposta

🧩 Estrutura do array de objetos `freezes`

🧩 Estrutura do array de objetos `sessions`

Requisição

Exemplos de Requisição

Respostas

Get summary of MemberMemberships by id

Obter MemberMembership por id#

Descrição#

🔑 Parâmetro de Consulta (Path Param)#

📤 Estrutura da Resposta#

🧩 Estrutura do array de objetos freezes#

🧩 Estrutura do array de objetos sessions#

Requisição

Exemplos de Requisição

Respostas

Obter MemberMembership por id

Descrição

🔑 Parâmetro de Consulta (Path Param)

📤 Estrutura da Resposta

🧩 Estrutura do array de objetos `freezes`

🧩 Estrutura do array de objetos `sessions`