Obter Detalhes da Agenda de Atividades

Descrição

Recupera os detalhes completos de uma sessão de atividade específica, incluindo informações sobre o instrutor, local, capacidade, status, inscritos, assentos e outras configurações específicas.

Parâmetros de consulta

Este endpoint requer que sejam enviados o idConfiguration e activityDate obtidos em/api/v1/activities/schedule . Ou, o idActivitySession da atividade relacionada.

Parâmetro	Tipo	Obrigatório	Descrição
idConfiguration	int32	Recomendável	Deve ser usado combinado com activityDate.
activityDate	date-time	Recomendável	Deve ser usado combinado com idConfiguration.
idActivitySession	int32	Opcional	Filtra pelo ID da sessão da atividade. Obrigatório quando os outros parâmetros citados forem nulos.

Resposta

A resposta é um objeto com os detalhes completos de uma sessão de atividade, com a seguinte estrutura:

Campo	Tipo	Descrição
`idGroupActivity`	inteiro	Identificador do grupo de atividades ao qual a sessão pertence.
`idActivitySession`	inteiro	Identificador único da sessão de atividade.
`idConfiguration`	inteiro	Identificador da configuração da atividade.
`name`	string	Nome da atividade.
`date`	datetime	Data da sessão da atividade (formato ISO 8601).
`capacity`	inteiro	Capacidade máxima de participantes para a sessão.
`ocupation`	inteiro	Quantidade de vagas ocupadas na sessão.
`instructor`	string	Nome do instrutor responsável pela sessão.
`instructorPhoto`	string	URL da foto do instrutor.
`area`	string	Área onde a sessão será realizada.
`status`	inteiro	Código de status da sessão de atividade.
`selectedSpot`	string	Identificação do local ou assento selecionado.
`code`	string	Código identificador da sessão de atividade.
`statusName`	string	Nome do status da sessão de atividade.
`weekDay`	inteiro	Dia da semana em que a sessão ocorre (0 para domingo, 1 para segunda, etc).
`allowChoosingSpot`	booleano	Indica se é permitido escolher o local específico (`true` ou `false`).
`timeTick`	inteiro	Quantidade de intervalos de tempo para configuração da sessão.
`durationTick`	inteiro	Duração total em intervalos de tempo para a sessão.
`startTime`	string	Hora de início da sessão (formato HH:MM).
`endTime`	string	Hora de término da sessão (formato HH:MM).
`branchName`	string	Nome da filial onde a sessão ocorrerá.
`color`	string	Código de cor associado à atividade.
`description`	string	Descrição detalhada da sessão de atividade.
`imageUrl`	string	URL da imagem associada à sessão de atividade.
`enrollments`	array	Lista de objetos de inscrição dos participantes (detalhado abaixo).
`spots`	array	Lista de assentos ou vagas disponíveis para a sessão (detalhado abaixo).
`title`	string	Título da sessão de atividade.
`jsonConfigVagaPersonalizada`	string	Configurações personalizadas para a vaga em formato JSON.

Estrutura do Objeto `enrollments`

Campo	Tipo	Descrição
`idMember`	inteiro	Identificador do membro inscrito na sessão.
`idEmployee`	inteiro	Identificador do funcionário inscrito na sessão.
`idProspect`	inteiro	Identificador do prospecto inscrito na sessão.
`id`	inteiro	Identificador da inscrição.
`slotNumber`	inteiro	Número do assento ou vaga ocupado pelo inscrito.
`name`	string	Nome do participante inscrito.
`photo`	string	URL da foto do participante inscrito.
`justifiedAbsence`	booleano	Indica se a ausência do participante foi justificada (`true` ou `false`).
`idSaleItem`	inteiro	Identificador do item de venda associado à inscrição.
`status`	inteiro	Código de status da inscrição.
`exclusive`	booleano	Indica se a inscrição é exclusiva (`true` ou `false`).
`idBranch`	inteiro	Identificador da filial associada ao inscrito.
`branchName`	string	Nome da filial associada ao inscrito.
`replacement`	booleano	Indica se a inscrição é uma substituição (`true` ou `false`).
`suspended`	booleano	Indica se o inscrito está suspenso (`true` ou `false`).
`removed`	booleano	Indica se o inscrito foi removido da sessão (`true` ou `false`).

Estrutura do Objeto `spots`

Campo	Tipo	Descrição
`number`	inteiro	Número do assento ou vaga.
`available`	booleano	Indica se o assento está disponível (`true` ou `false`).
`nameSpot`	string	Nome ou identificação do assento.

Exemplo de Requisição

{
  "idConfiguration": 12345,
  "activityDate": "2025-03-19",
  "idActivitySession": 67890
}