Documentação API - FIEP

Este documento tem por objetivo a documentar as API's disponíveis no projeto Integração Loja Click SESI - SENAI - FIEP.

Orientações gerais, autenticação e exemplos de consumo das API's.

Inserir Matrícula

POST

/api/cst/v1/lojaclick/matricula/inserirMatricula

Ao executar a chamada da API, serão realizadas as seguintes operações:

Criação/Atualização do Responsavel Financeiro do Aluno;

Criação/Atualização do Aluno

Criação da Matricula do Aluno (Habilitacao, Periodo Letivo e Disicplinas)

Criação do Pré Contrato CRM no SGE.

Efetivação do contrato no ERP.

Tabelas Afetadas: FCFO, PPESSOA, SALUNO, SHABILITACAOALUNO, SMATRICPL, SMATRICULA

Interfaces RM:

TOTVS BackOffice | Gestão Financeira | Cadastros | Cliente/Fornecedor

TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

Autenticação

Authorization - Basic Auth

Username <username>

Password <password>

Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.

Exemplo de utilização - Sucesso:

Realize uma requisição POST ao endpoint http(s)://{dominio}:{porta}/api/connect/token/ via Postman, SoapUi, ou outro programa que realize requisições HTTP REST.
No corpo da requisição envie um JSON explicitando usuário e senha do RM para qual a autenticação está sendo direcionada:

• username
• password

A requisição deve parecer com a abaixo

O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.

Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:

Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:

• Authorization: Bearer {token}

Inclusão do token no cabeçalho da requisição:

Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.

Requisição realizada na API de Usuário utilizando o token gerado:

Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.

Body

Raw

{
   "respFinanceiro":{
      "codColigada":3,
      "classificacao":1,
      "categoria":"F",
      "nome":"Braian Veloz De Mais",
      "dataNascimento":"2000-08-20",
      "email":"[email protected]",
      "estadoCivil":null,
      "nacionalidade":0,
      "cgcCfo":"30780320000",
      "cI_Orgao":null,
      "cI_UF":"PR",
      "cI_numero":null,
      "telefone":"41985742365",
      "celular":"000000",
      "telefoneComercial":"000000",
      "tipoBairro":1,
      "tipoRua":1,
      "bairro":"Conjunto Habitacional Boa Vista",
      "logradouro":"Rua Mário Cardoso Júnior",
      "numero":"12",
      "complemento":null,
      "cep":"38180733",
      "estado":"PR",
      "codMunicipio":"02109",
      "idPais":1
   },
   "aluno":{
      "codColigada":3,
      "codTipoAluno":1,
      "codFilial":3016,
      "codTipoCurso":1,
      "nome":"Vei Do Rio",
      "nomeSocial":"Veio",
      "sexo":"F",
      "dataNascimento":"1988-05-23T00:00:00",
      "corRaca":"2",
      "nacionalidade":"10",
      "email":"[email protected]",
      "estadoCivil":"S",
      "estadoNatal":"PR",
      "naturalidade":"01903",
      "telefone1":"42999377381",
      "telefone2":"31993424866",
      "telefone3":null,
      "ci_numero":"13.379.055-1",
      "ci_uf":null,
      "ci_dtemissao":null,
      "ci_emissor":"SSP",
      "cpf":"50784804044",
      "tipoBairro":1,
      "tipoRua":1,
      "bairro":"Birim Birim",
      "logradouro":"Rua Ze Cardoso Júnior",
      "numero":"1158",
      "complemento":null,
      "cep":"38180733",
      "codMunicipio":"01903",
      "estado":"PR",
      "idPais":1,
      "codProfissao":1,
      "grauInstrucao":"5",
      "situacaoOcupacional":"1",
      "tipoEscolaOrigem":"1",
      "pai":{
         "nome":"TESTE PAI",
         "nomeSocial":"PAPA",
         "sexo":"M",
         "dataNascimento":"1988-05-19T00:00:00",
         "corRaca":null,
         "nacionalidade":"10",
         "email":null,
         "estadoCivil":null,
         "estadoNatal":"PR",
         "naturalidade":"4120705",
         "telefone1":"42999377381",
         "telefone2":null,
         "cI_numero":"13.379.055-1",
         "cI_UF":null,
         "cI_dtEmissao":null,
         "cI_Orgao":"SSP",
         "cpf":"455.351.820-10",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Conjunto Habitacional Boa Vista",
         "logradouro":"Rua Mário Cardoso Júnior",
         "numero":1158,
         "complemento":null,
         "cep":"38180733",
         "codMunicipio":"4120705",
         "estado":"PR",
         "idPais":55,
         "codProfissao":null,
         "grauInstrucao":null
      },
      "mae":{
         "nome":"MAE TESTE",
         "nomeSocial":"MAMA",
         "sexo":"F",
         "dataNascimento":"1988-05-19T00:00:00",
         "corRaca":null,
         "nacionalidade":"10",
         "email":null,
         "estadoCivil":null,
         "estadoNatal":"PR",
         "naturalidade":"4120705",
         "telefone1":"42999377381",
         "telefone2":null,
         "cI_numero":"13.379.055-1",
         "cI_UF":null,
         "cI_dtEmissao":null,
         "cI_Orgao":"SSP",
         "cpf":"455.351.820-10",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Conjunto Habitacional Boa Vista",
         "logradouro":"Rua Mário Cardoso Júnior",
         "numero":1158,
         "complemento":null,
         "cep":"38180733",
         "codMunicipio":"4120705",
         "estado":"PR",
         "idPais":55,
         "codProfissao":null,
         "grauInstrucao":null,
         "situacaoOcupacional":"1",
         "tipoEscolaOrigem":"1"
      }
   },
   "matricula":{
      "codcoligada":3,
      "codFilial":3016,
      "codTipoCurso":1,
      "idHabilitacaoFilial":66620,
      "codTurma":"APP-I-G00455/2022",
      "idPerlet":3658,
      "periodo":"1",
      "campusPolo":"1",
      "tipoMatricula":1,
      "dataMatricula":"2022-08-08",
      "camposComplementares":{
         "dataPrevistaSaida":"2022-12-20",
         "tipoGrat":"0",
         "codFinanc":"1",
         "categoria":"5",
         "viraVida":"0",
         "seloOds":"0",
         "ebep":"0",
         "tempoIntegral":"0",
         "gratuidade":"0",
         "baixaRenda":"0",
         "portalTransp":"0"
      },
      "preContratoCrm":{
         "tipoContrato":"7",
         "modContrato":"002",
         "desContrato":"Descrição Modelo Contrato",
         "valorTotal":1150.00,
         "qtDeParcelas":1,
         "valorDesconto":234.00,
         "tipoDesconto":"V",
         "obsDesconto":"Obs. Desconto",
         "workload":"180",
         "valorAplicadoCurso":0,
         "dtInicioContrato":"2022-05-30T00:00:00",
         "dtFimContrato":"2022-11-30T00:00:00",
         "adesaoOdonto":true,
         "itemVendaodonto":"Item Venda Odonto",
         "valorItemOdonto":150,
         "itemVendaOfertada":"Item Venda Ofertada",
         "numPreContrato":"9876543999"
      }
   }
}

Content

Responsável Financeiro

codColigada: Código da Coligada no SGE (Campo Obrigatório);
classificacao: Classificação do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: 1 = Cliente; 2 = Fornecedor; 3 = Ambos;
categoria: Categoria do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: F = Pessoa Física; J = Pessoa Jurídica
nome Nome do Cliente/Fornecedor (Campo Obrigatório);
dataNascimento: Data de Nascimento do Cliente/Fornecedor;
email: Email do Cliente/Fornecedor (Campo Obrigatório);
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
nacionalidade: Nacionalidade do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: 0 = Brasileira; 1 = Estrangeira
cgcCfo: CPF ou CNPJ do Cliente/Fornecedor (Campo Obrigatório);
cI_Orgao: Orgão emissor da carteira de identidade do Cliente/Fornecedor;
cI_UF: Estado emissor do Cliente/Fornecedir.
cI_numero: Numero da identidade do Cliente/Fornecedor.
telefone: Telefone do Cliente/Fornecedor (Campo Obrigatório);
celular: Celular do Cliente/Fornecedor;
telefoneComercial: Telefone comercial do Cliente/Fornecedor;
tipoBairro: Tipo de Bairro do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
tipoRua: Tipo de Rua do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
bairro: Bairro do Endereço Principal Cliente/Fornecedor (Campo Obrigatório);
logradouro: Rua do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
numero: Numero do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
complemento: Complemento do Endereço Principal do Cliente/Fornecedor;
cep: CEP do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório);
estado: Estado do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD
codMunicipio: Código da Cidade do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
idPais: Id. do Pais do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS

Aluno

codColigada: Código da Coligada no SGE (Campo Obrigatório);
codTipoAluno: Campo Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODTIPOALUNO da tabela STIPOALUNO
codFilial: Código da Filial em que o Aluno será inserido no SGE (Campo Obrigatório);
codTipoCurso: Nível de Ensino em que o Aluno será inserido no SGE (Campo Obrigatório);
nome: Nome completo do Aluno no SGE (Campo Obrigatório);
nomeSocial: Nome social do Aluno no SGE;
sexo: Sexo do Aluno no SGE (Campo Obrigatório); Valores possíveis: M = Masculino; F = Feminino
dataNascimento: Data de Nascimento do Aluno no SGE (Campo Obrigatório); 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 (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODNACAO
email: Email do Aluno no SGE (Campo Obrigatório); 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 (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
telefone1: Telefone residencial do Aluno no SGE;
telefone2: Celular do Aluno no SGE (Campo Obrigatório);
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:Orgão emissor da identidade do Aluno no SGE;
cpf: CPF do Aluno no SGE (Campo Obrigatório);
tipoBairro: Tipo de Bairro do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPOBAIRRO
tipoRua: Tipo de Rua do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODIGO da tabela DTIPORUA
bairro: Bairro do endereço do Aluno no SGE (Campo Obrigatório);
logradouro: Rua do endereço do Aluno no SGE (Campo Obrigatório);
numero: Numero do endereço do Aluno no SGE (Campo Obrigatório);
complemento: Complemento do endereço do Aluno no SGE;
cep: CEP do endereço do Aluno no SGE (Campo Obrigatório);
codMunicipio: Código da Cidade do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODMUNICIPIO da tabela GMUNICIPIO
estado: Estado do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo CODETD da tabela GETD
idPais: Id. do Pais do Endereço Principal do Cliente/Fornecedor (Campo Obrigatório); Valores possíveis: Campo IDPAIS da tabela GPAIS
codProfissao: Campo Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis:
grauInstrucao: Grau de Instrução do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela PCODINSTRUCAO
situacaoOcupacional: Campo complementar de Situação Ocupacional do Aluno no SGE (Campo Obrigatório Somente SENAI/IEL); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SITOCUP
tipoEscolaOrigem: Campo complementar de Tipo de Escola Origem Tipo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica TIPOESCOLA
pai: Dados do pai do aluno no SGE (Não implementado);
mãe: Dados da mãe do aluno no SGE (Não implementado);

Matricula

codColigada: Código da Coligada no SGE (Campo Obrigatório);
codFilial: Código da filial da matricula do aluno no SGE (Campo Obrigatório);
codTipoCurso: Nível de ensino da matricula do aluno no SGE (Campo Obrigatório);
idHabiltiacaoFilial: Id da Matriz Aplicada da matricula do aluno no SGE (Campo Obrigatório);
codTurma: Código da Turma da matricula do aluno no SGE (Campo Obrigatório);
idPerlet: Id do Período Letivo da matricula do aluno no SGE (Campo Obrigatório);
periodo: Campo Período da Matricula no Período Letivo do aluno no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
campusPolo: Campus Polo no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
tipoMatricula: Tipo da Matricula no Período Letivo do Aluno no SGE (Campo Obrigatório); Valores possíveis: Campo CODTIPOMAT da tabela STIPOMATRICULA
dataMatricula: Data da matricula da matricula do aluno no SGE (Campo Obrigatório);
camposComplementares: Dados dos campos complementares da matricula do aluno no SGE (Campo Obrigatório);
preContratoCrm: Dados do pré contrato crm da matrícula do aluno no SGE (Campo Obrigatório);

Campos Complementares

dataPrevistaSaida: Campo complementar Data de Previsão de Saída da habilitação do aluno no SGE (Campo Obrigatório SOMENTE SENAI/IEL);
tipoGrat: Campo complementar Condição do Aluno da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SENAI/IEL); Valores possíveis: Campo CODCLIENTE da tabela dinâmica TIPOGRAT
codFinanc: Campo complementar Código do Financiamento (SCAE) da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SCODFINANC
articulacao: Código da Coligada no SGE (Campo Obrigatório); ?!!??!?!?!
categoria: Campo complementar Categoria da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SCATEGORIA
viraVida: Campo complementar Vira Vida ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
seloOds: Campo complementar Selo EJA da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
ebep: Campo complementar EBEP ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
tempoIntegral: Campo complementar Tempo Integral ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
gratuidade: Campo complementar Gratuidade da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
baixaRenda: Campo complementar Portal Transparência da matricula do periodo letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO
portalTransp: Campo complementar Possui comprovação de Gratuidade Reg ? da matricula do período letivo no SGE (Campo Obrigatório SOMENTE SESI); Valores possíveis: Campo CODCLIENTE da tabela dinâmica SIMOUNAO

Pré Contrato CRM

numPreContrato: Número do Pré Contrato (Campo Obrigatório);
tipoContrato: Tipo do contrato(Campo Obrigatório); Valores possíveis:
modContrato: Modelo do contrato (Campo Obrigatório); Valores possíveis: Campo CODCLIENTE da tabela dinâmica ZMODCONTRATOSETRMOAX
desContrato: Descrição do contrato (Campo Obrigatório);
valorTotal: Valor total do contrato considerando os descontos (Campo Obrigatório);
qtDeParcelas: Quantidade de parcelas que será gerada para o pagamento (Campo Obrigatório);
valorDesconto: Valor desconto, caso exista (Campo Obrigatório);
tipoDesconto: Tipo de desconto utilizado, caso exista (Campo Obrigatório); Valores possíveis: P = Percentual; V = Valor
obsDesconto: Motivo da concessão do desconto (Campo Obrigatório);
worload: Carga horária (Campo Obrigatório);
valorAplicadoCurso: Valor aplicado ao curso (Campo Obrigatório);
dtInicioContrato: Data de início do contrato, deve estar dentro do período do mês vigente ou no futuro, respeitando o início da prestação do serviço. (Campo Obrigatório);
dtFimContrato: Data final do contrato. (Campo Obrigatório);
adesaoOdonto: Caso o haja adesão ao plano escolar de odonto. (Campo Obrigatório); Valores possíveis: 1 = true;
itemVendaodonto: Caso o haja adesão ao plano escolar de odonto deverá ser enviado o código do item odonto ofertado. (Campo Obrigatório);
valorItemOdonto: Caso Adesão Odonto seja 1 (verdadeiro) deverá ser enviado o valor do item odonto. (Campo Obrigatório);
itemVendaOfertada: Item de venda foi utilizado para geração do contrato. (Campo Obrigatório);

Retorno

Console

{
        "Status": "Sucesso",
        "Mensagem": "Responsável Financeiro Criado/Atualizado com Sucesso !\r\nAluno Criado/Atualizado com Sucesso !\r\nMatricula Criada/Atualizada com Sucesso !",
        "DadosCriados": {
            "CodColigada": 3,
            "Ra": "00878180",
			"CPF": 123131331,
            "Nome": Rafael da Silva Sauro,
             "CodCFO": "01737437",
            "IdPreContrato": null
        },
        "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: Código 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: Código do Cliente/Fornecedor para o responsável financeiro criado ou atualizado.
- IdPreContrato: Id interno no criado para o Pré Contrato CRM.
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.

Atualizar Dados do Aluno

POST

/api/cst/v1/lojaclick/aluno/atualizaDadosAluno

Ao executar a chamada do webservice, se for inclusão de um serviço novo, o método irá:

Atualizar os dados do aluno no SGE, identificado através do CPF enviado.

Tabela Afetada: PPESSOA, SALUNO

Interface RM: TOTVS Educacional | Educacional | Currículo e Oferta | Alunos

Autenticação

Authorization - Basic Auth

Username <username>

Password <password>

Abaixo estão as instruções de como buscar um bearer token, tanto com base em um certificado embutido automaticamente na aplicação quanto um inserido manualmente.

Exemplo de utilização - Sucesso:

Realize uma requisição POST ao endpoint http(s)://{dominio}:{porta}/api/connect/token/ via Postman, SoapUi, ou outro programa que realize requisições HTTP REST.
No corpo da requisição envie um JSON explicitando usuário e senha do RM para qual a autenticação está sendo direcionada:

• username
• password

A requisição deve parecer com a abaixo

O token de segurança será gerado e já poderá ser utilizado no cabeçalho das requisições subsequentes às API's disponibilizadas pela TOTVS.

Exemplo de Token de Segurança gerado com sucesso e pronto para ser utilizado:

Utilize o token gerado incluindo-o no cabeçalho da requisição através da diretiva:

• Authorization: Bearer {token}

Inclusão do token no cabeçalho da requisição:

Após a inclusão do cabeçalho de autorização, realize uma requisição HTTP em uma das API's disponibilizadas pela TOTVS e verifique o resultado.

Requisição realizada na API de Usuário utilizando o token gerado:

Verifique que a requisição foi realizada com sucesso e os dados foram apresentados corretamente.

Body

Raw

{
		 "codColigada": 3,
         "codTipoAluno": 1,
         "codFilial": 3016,
         "codTipoCurso": 1,
         "nome":"Vei Do Rio",
		 "nomeSocial": "Veio",
         "sexo":"F",
         "dataNascimento":"1988-05-23T00:00:00",
         "corRaca": "2",
         "nacionalidade":"10",
         "email": "[email protected]",
         "estadoCivil": "S",
         "estadoNatal":"PR",
         "naturalidade":"01903",
		 "telefone1":"42999377381",
         "telefone2": "31993424866",
         "telefone3": null,
         "ci_numero":"13.379.055-1",
         "ci_uf":null,
         "ci_dtemissao":null,
         "ci_emissor":"SSP",
         "cpf": "50784804044",
         "tipoBairro":1,
         "tipoRua":1,
         "bairro":"Birim Birim",
         "logradouro":"Rua Ze Cardoso Júnior",
         "numero": "1158",
         "complemento": null,
         "cep": "38180733",
         "codMunicipio": "01903",
         "estado": "PR",
         "idPais": 1,
         "codProfissao": 1,
         "grauInstrucao": "5",
		 "situacaoOcupacional": "1",
		 "tipoEscolaOrigem": "1"
}

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

Console

{
    "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.

Atalhos

Páginas filhas

Autenticação

Authorization - Basic Auth

Body

Retorno

Autenticação

Authorization - Basic Auth

Body

Retorno