Disciplines

Serviço responsável pelas operações de consulta, matrícula e cancelamento de matrículas em modalidades.

GetAvailabilities

Consulta sócios e as turmas disponíveis para matrícula para um título.

Parâmetros

Nome	Tipo	Descrição
data	AvailabilitiesData	Dados para consulta de turmas disponíveis.

Retorno

Tipo	Descrição
AvailabilitiesResult[]	Retorna dados dos sócios do título e das turmas disponíveis para matrícula.

GetRegisters

Consulta os sócios de um título e suas respectivas matrículas.

Parâmetros

Nome	Tipo	Descrição
data	RegistersData	Dados para consulta de matrículas realizadas.

Retorno

Tipo	Descrição
RegistersResult[]	Retorna os dados os sócios do título e as suas matrículas.

Register

Efetua a matrícula de um sócio.

Parâmetros

Nome	Tipo	Descrição
data	RegisterData	Dados para a matrícula.

Retorno

Tipo	Descrição
RegisterResult	Retorna os dados da matrícula.

GetContract

Emite o contrato de matrícula ou cancelamento de matrícula de um sócio

Parâmetros

Nome	Tipo	Descrição
data	ContractData	Dados para a emissão do contrato.

Retorno

Tipo	Descrição
ContractResult	Retorna o arquivo PDF com o contrato.

Queue

Inserir sócio na fila de espera de uma turma.

Parâmetros

Nome	Tipo	Descrição
data	QueueData	Dados para a inclusão do sócio na fila de espera.

Retorno

Tipo	Descrição
QueueResult	Retorna os dados da inclusão na fila de espera.

Unregister

Desmatricula um sócio de uma turma.

Parâmetros

Nome	Tipo	Descrição
data	UnregisterData	Dados do cancelamento da matrícula.

Retorno

Tipo	Descrição
UnregisterResult	Retorna verdadeiro se o cancelamento ocorreu com sucesso.

Unqueue

Retira o sócio da fila de espera de uma turma.

Parâmetros

Nome	Tipo	Descrição
data	UnqueueData	Dados para retirar o sócio da fila de espera.

Retorno

Tipo	Descrição
UnqueueResult	Retorna verdadeiro se o sócio foi retirado da fila.

GetParcels

Retorna os valores por parcela

Parâmetros

Nome	Tipo	Descrição
data	ParcelData	Dados para calcular as parcelas

Retorno

Tipo	Descrição
ParcelResult[]	Os valores por parcela

Error codes

Códigos de erro retornados pelo serviço

Valores

Nome	Valor	Descrição
AutenticationKeyMissing	901	Chave de autenticação não informada.
AutenticationKeyInvalid	902	Fornecido como parâmetro uma chave de autenticação inválida. Este erro ocorre quando, a chave não é encontrada, quando a chave informada está incorreta ou quando o usuário associado a chave não possui permissão para utilizar a API.
IntegrationDisabled	903	A integração com o aplicativo está desativada. Este erro ocorre devido a configuração na administração do servidor.