...
Orientações gerais, autenticação e exemplos de consumo das API's.
Expandir |
---|
title | Atualizar Dados do AlunoExportar 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> |
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
Retorno Bloco de código |
---|
| {
"Status": "Sucesso",
"Mensagem": "Aluno Criado/Atualizado com Sucesso !",
"DadosCriados": {
"CodColigada": null,
"Ra": "00878180",
"Nome": Rafael da Silva Sauro,
"CPF": 123131331,
"CodCFO": null,
"CodFilial": 3015,
"IdHabilitacaoFilial: 7111,
"IdPerlet": 3800,
"CodTurma": "TEC-M-000152/2023",
"IdPreContrato": 266262,
"IdUnico": 10
},
"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 da Coligada utilizado no registro
- Ra: Ra criado ou atualizado para o aluno enviado.
- Nome: 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.
- IdUnico: 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.
|
...