Retornar Detalhes das Sessões de Atividades

Descrição

Retorna os detalhes completos das sessões de atividades 1:1 disponíveis ou agendadas para um membro, prospect ou colaborador, considerando filtros de data e contexto da sessão.

🔑 Parâmetros de Requisição (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
idMember	int32	Não	Filtrar as sessões vinculadas a um aluno específico.
idProspect	int32	Não	Filtrar as sessões vinculadas a um prospect específico.
idEmployee	int32	Não	Filtrar as sessões associadas a um colaborador instrutor.
idActivitySession	int32	Não	Filtrar pelo identificador específico da sessão de atividade.
startActivityDate*	date-time	Não	Data inicial para filtro de sessões (formato ISO 8601).
endActivityDate	date-time	Não	Data final para filtro de sessões (formato ISO 8601).

📤 Estrutura da Resposta

A resposta retorna uma lista de sessões de atividades, contendo informações sobre horários, instrutores, locais, recursos, status e vínculo com membros ou prospects.

Campo	Tipo	Descrição
idActivitySession	int32	Identificador único da sessão da atividade.
idGroupActivity*	int32	ID do grupo de atividade relacionado.
name	string	Nome da atividade.
date	string (date-time)	Data em que a sessão ocorre.
instructor	string	Nome do instrutor responsável.
instructorPhoto	string	URL da foto do instrutor.
area	string	Nome da área/ambiente onde a atividade será realizada.
code	string	Código identificador da atividade.
weekDay	int32	Dia da semana da sessão (0 = Domingo, 1 = Segunda, etc).
timeTick	int64	Horário da sessão representado em ticks.
durationTick	int64	Duração da sessão representada em ticks.
branchName	string	Nome da filial onde a sessão acontece.
description	string	Descrição da atividade.
imageUrl	string	URL de imagem ilustrativa da atividade.
startTime	string	Horário de início da sessão (string formatada).
endTime	string	Horário de término da sessão (string formatada).
status	int32	Status geral da sessão. Veja mais a seguir.
subStatus	int32	Substatus adicional da sessão. Veja mais a seguir.
memberStatus	string	Status do membro em relação à sessão (ex.: reservado, aguardando).
memberName	string	Nome do aluno vinculado (se aplicável).
idMember	int32	ID do aluno participante (0 se não houver).
idProspect	int32	ID do prospect vinculado (0 se não houver).
idEmployee	int32	ID do colaborador instrutor vinculado.
resources	arrayobject	Lista de recursos necessários ou associados à atividade. Veja mais a seguir.

🔷 Enum de `status`

Campo	Valor
Presente	0
Falta	1
FaltaJustificada	2

🔷 Enum de `subStatus`

Campo	Valor
Agendado	0
Confirmado	1
Presente	2
Ausente	3
Desmarcado	4
Remarcado	5
AtividadeNaAgenda	6
FaltaJustificada	7
PreAgendado	8

🧩 Estrutura de `resources`

Campo	Tipo	Descrição
idActivityResource	int32	Identificador da relação entre a sessão e o recurso.
idActivity	int32	ID da atividade vinculada ao recurso.
name	string	Nome do recurso (ex.: “Colchonete”, “Bicicleta”, “Sala 2”).
idResource	int32	ID do recurso no cadastro geral.

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

[
    {
        "idActivitySession": 0,
        "idGroupActivity": 0,
        "name": "string",
        "date": "2019-08-24T14:15:22.123Z",
        "instructor": "string",
        "instructorPhoto": "string",
        "area": "string",
        "code": "string",
        "weekDay": 0,
        "timeTick": 0,
        "durationTick": 0,
        "branchName": "string",
        "description": "string",
        "imageUrl": "string",
        "startTime": "string",
        "endTime": "string",
        "status": 0,
        "subStatus": 0,
        "memberStatus": "string",
        "memberName": "string",
        "idMember": 0,
        "idProspect": 0,
        "idEmployee": 0,
        "resources": [
            {
                "idActivityResource": 0,
                "idActivity": 0,
                "name": "string",
                "idResource": 0
            }
        ]
    }
]

🟠400Bad Request

Retrieves detailed information about scheduled appointment sessions

Retornar Detalhes das Sessões de Atividades#

Descrição#

🔑 Parâmetros de Requisição (Query Params)#

📤 Estrutura da Resposta#

🔷 Enum de status#

🔷 Enum de subStatus#

🧩 Estrutura de resources#

Requisição