Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEPa API chamada “Moodle - Exportação de Matrículas de Alunos da Loja” que irá disparar automaticamente o processo do Moodle de Exportação de Matrículas e Docentes/Professores para o aluno que teve a matrícula e contrato efetivados com sucesso.
Orientações gerais, autenticação e exemplos de consumo das API's.
Expandir |
---|
title | Exportar para Moodle Matrículas de Alunos da Loja Click |
---|
|
HTML |
---|
<div class="post">POST</div>
<div class="endereco">/api/cst/v1/intmoodle/aluno/exportarMatricAluno</div> |
Ao executar a chamada da API, serão realizadas as seguintes operações: - Inserir usuários no Moodle, caso não exista;
- Inscrever usuário no Curso;
- Inserir Grupo do usuário (Turma e Matriz Curricular - SESI);
- Inserir Plano de Aprendizagem do Aluno;
- Devolve para Loja/Ace o status do processamento (Response).
Informações |
---|
title | Informações Relevantes |
---|
| - A nova API irá registrar os dados no mesmo Monitor de log de exportação do Moodle, da mesma forma como acontece com o processo original de exportação do Moodle.
- A API de importação de matrículas já existente foi atualizada para devolver um identificador único ao ACE, facilitando a chamada da nova API.
- Não será possível reenviar esse registro com erro através do Monitor de log, já que dessa forma a Loja não será avisada da integração com sucesso.
|
Aviso |
---|
Será responsabilidade do ACE acionar a nova API para disparar o processo de exportação do Moodle, que enviará os dados do aluno e da matrícula efetuada para o Moodle. | code
Autenticação
Content Aluno - codColigada: Código da Coligada no SGE (Campo Obrigatório);
- codTipoAluno: Campo Tipo do Aluno no SGE; Valores possíveis: Campo CODTIPOALUNO da tabela STIPOALUNO
- codFilial: Código da Filial em que o Aluno será inserido no SGE;
- codTipoCurso: Nível de Ensino em que o Aluno será inserido no SGE;
- nome: Nome completo do Aluno no SGE;
- nomeSocial: Nome social do Aluno no SGE;
- sexo: Sexo do Aluno no SGE; Valores possíveis: M = Masculino; F = Feminino
- dataNascimento: Data de Nascimento do Aluno no SGE; Valores possíveis:
- corRaca: Cor/Raça do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCORRACA
- nacionalidade: Nacionalidade do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO
- email: Email do Aluno no SGE; Valores possíveis:
- estadoCivil: Estado Civil do Cliente/Fornecedor; Valores possíveis: C= Casado; D = Desquitado; E = União Estável; I = Divorciado; O = Outros; P = Separado; S = Solteiro; V = Viúvo
- naturalidade: Naturalidade do Aluno no SGE; Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
- telefone1: Telefone residencial do Aluno no SGE;
- telefone2: Celular do Aluno no SGE;
- telefone3: Telefone comercial do Aluno no SGE;
- ci_numero: Numero da identidade do Aluno no SGE;
- ci_uf: Estado emissor da identidade do Aluno no SGE;
- ci_dtemissao: Data de emissão da identidade do Aluno no SGE;
- ci_emissor: Órgão emissor da identidade do Aluno no SGE;
- cpf: CPF do Aluno no SGE (Campo Obrigatório);
- tipoBairro: Tipo de Bairro do Cliente/Fornecedor; Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
- tipoRua: Tipo de Rua do Cliente/Fornecedor; Valores possíveis: Campo CODIGO da tabela DTIPORUA
- bairro: Bairro do endereço do Aluno no SGE;
- logradouro: Rua do endereço do Aluno no SGE;
- numero: Numero do endereço do Aluno no SGE;
- complemento: Complemento do endereço do Aluno no SGE;
- cep: CEP do endereço do Aluno no SGE;
- codMunicipio: Código da Cidade do Endereço Principal do Cliente/Fornecedor; Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
- estado: Estado do Endereço Principal do Cliente/Fornecedor; Valores possíveis: Campo CODETD da tabela GETD
- idPais: Id. do Pais do Endereço Principal do Cliente/Fornecedor; Valores possíveis: Campo IDPAIS da tabela GPAIS
- codProfissao: Campo Tipo do Aluno no SGE; Valores possíveis:
- grauInstrucao: Grau de Instrução do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO
- situacaoOcupacional: Campo complementar de Situação Ocupacional do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica SITOCUP
- tipoEscolaOrigem: Campo complementar de Tipo de Escola Origem Tipo do Aluno no SGE; Valores possíveis: Campo CODCLIENTE da tabela dinâmica TIPOESCOLA
| Authorization - Basic AuthUsername <username> Password <password>
|
Bloco de código |
---|
| {
"codColigada": 3,
"idUnico": 1
} |
Content - codColigada: Código da Coligada no SGE (Campo Obrigatório);
- idUnico: Identificador da Matrícula realizada no SGE pela Loja Click;
Retorno Bloco de código |
---|
| {
"Status": "Sucesso",
"Mensagem": "Usuário do aluno Exportado com Sucesso! Matrícula do Aluno Criado/Atualizado Exportada com Sucesso! Grupo Turma Exportado com Sucesso! Plano de Ensino Exportado para o Moodle com Sucesso!",
"DadosCriados": {
"CodColigada": null3,
"Ra": "00878180",
"NomeIdPerlet": Rafael da Silva Sauro, 3800,
"CPFIdHabilitacaoFilial": 12313133171177,
"CodCFO": null,
"CodFilial": 3015,
"IdHabilitacaoFilial: 7111,
"IdPerlet": 3800,
"CodTurma": "TEC-M-000152/2023" "IdSalaMoodle":[
24054,
23537,
23538,
23539,
23540,
23541,
23542
],
"IdPreContratoIdUsuarioMoodle": 266262,
"IdUnico": 10
110687
},
"DetalheErros": {
"IdErro": null,
"ExceptionType": null,
"InnerException": null
}
} |
Content - Status: Situação do processamento da requisição; Valores possíveis: "Sucesso" = Quando todas as etapas foram inseridas com sucesso; "Erro" = Quando ocorre um erro na integração com o SGE até a etapa de Criação de Matricula do Aluno; "Alerta" = Quando ocorre um erro na etapa de Efetivação do Contrato no ERP;
- Mensagem: Mensagem de retorno do consumo da requisição;
- Dados Criados:
- CodColigada: Codigo Código da Coligada utilizado no registro
- Ra: Ra criado ou atualizado para o aluno enviado.
- NomeIdPerlet: Nome do aluno enviado na API.
- CPF: Cpf do aluno enviado na API.
- CodCFO: Codigo do Cliente/Fornecedor para o responsável financeiro criado ou atualizado.
- IdPreContrato: Id interno no criado para o Pré Contrato CRM.
- Id do Período Letivo da matricula do aluno no SGE
- IdSalaMoodle: Lista das salas em que o aluno está matriculado no Moodle.
- IdUsuarioMoodle: Identificador do usuário do aluno no MoodleIdUnico: Numero único atribuído a efetivação da matricula com sucesso pela API. Somente é gerado em caso de efetivação do contrato com sucesso.
- DetalheErros:
- IdErro: Identificador da região da API que ocorreu o erro. Valores possíveis: 1 = Responsável Financeiro; 2 = Aluno; 3 = Matricula; 4 = Pré Contrato CRM; 5 = Efetivação Contrato ERP
- ExceptionType: Tipo da exceção lançada pela API.
- InnerException: Conteúdo extra da exceção lançada pela API.
|
...