Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Aviso
titleImportante
  • O campo MatricularDisc deverá estar obrigatoriamente com o valor trueSim.
  • A tag Disciplinas obrigatoriamente deverá ser informada.

...

Bloco de código
languagexml
titleExemplo de XML REDUZIDO para matricular aluno no período letivo junto com as disciplinas
collapsetrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <tot:ExecuteWithXmlParams>
         <!--Optional:-->
         <tot:ProcessServerName>EduMatriculaProcData</tot:ProcessServerName>
         <!--Optional:-->
         <tot:strXmlParams><![CDATA[<?xml version="1.0" encoding="utf-16"?>
<EduMatriculaParamsProc z:Id="i1" xmlns="http://www.totvs.com.br/RM/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Context z:Id="i2" xmlns="http://www.totvs.com/" xmlns:a="http://www.totvs.com.br/RM/">
    <a:_params xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$EXERCICIOFISCAL<>$CODTIPOCURSO</b:Key>
        <b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">2<>1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODLOCPRT<>$CODCOLIGADA</b:Key>
        <b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">-1<>1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODTIPOCURSO<>$CODSISTEMA</b:Key>
        <b:Value i:type="c:intstring" xmlns:c="http://www.w3.org/2001/XMLSchema">1<>S</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$EDUTIPOUSR<>$CODUSUARIO</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">-1<>mestre</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUNIDADEBIB<>$CODFILIAL</b:Key>
        <b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">5<>1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType></a:_params>
    <a:Environment>DotNet</a:Environment>
  </Context>
  <b:Key i:type<PrimaryKeyList xmlns="c:stringhttp://www.totvs.com/" xmlns:ca="http://wwwschemas.w3.org/2001/XMLSchema">$CODCOLIGADA</b:Key>microsoft.com/2003/10/Serialization/Arrays">
    <a:ArrayOfanyType>
    <b  <a:ValueanyType i:type="cb:intshort" xmlns:cb="http://www.w3.org/2001/XMLSchema">1</ba:Value>anyType>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key <a:anyType i:type="cb:stringint" xmlns:cb="http://www.w3.org/2001/XMLSchema">$RHTIPOUSR<>4</ba:Key>anyType>
        <b<a:ValueanyType i:type="cb:string" xmlns:cb="http://www.w3.org/2001/XMLSchema">>ES-1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODIGOEXTERNO</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">-1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODSISTEMA</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">S</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUSUARIOSERVICO</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema" />
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUSUARIO</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">mestre</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$IDPRJ</b:Key>
        <b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">2</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CHAPAFUNCIONARIO</b:Key>
        <b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">-1</b:Value>
      </b:KeyValueOfanyTypeanyType>
      <b:KeyValueOfanyTypeanyType>
        <b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODFILIAL</b:Key>
        <b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
      </b:KeyValueOfanyTypeanyType>
    </a:_params>
    <a:Environment>DotNet</a:Environment>
  </Context>
  <PrimaryKeyList xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:ArrayOfanyType>
      <a:anyType i:type="b:short" xmlns:b="http://www.w3.org/2001/XMLSchema">1</a:anyType>
      <a:anyType i:type="b:int" xmlns:b="http://www.w3.org/2001/XMLSchema">4</a:anyType>
      <a:anyType i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">ES-00222</00222</a:anyType>
    </a:ArrayOfanyType>
  </PrimaryKeyList>
  <PrimaryKeyNames xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:string>CODCOLIGADA</a:string>
    <a:string>IDHABILITACAOFILIAL</a:string>
    <a:string>RA</a:string>
  </PrimaryKeyNames>
  <MatricPLParams z:Id="i3">
    <CodColigada>1</CodColigada>
    <CodFilial>1</CodFilial>
    <CodStatus>1</CodStatus>
    <CodTipoCurso>1</CodTipoCurso>
    <CodTurma>TSI-2-032</CodTurma>
    <CodUsuario>mestre</CodUsuario>
    <DataMatricula>2018-09-19T07:44:41.625612-03:00</DataMatricula>
    <Disciplinas>
      <EduMatriculaDiscParams>
        <CodColigada>1</CodColigada>
        <CodFilial>1</CodFilial>
        <CodStatus>13</CodStatus>
        <CodTipoCurso>1</CodTipoCurso>
        <CodUsuario>mestre</CodUsuario>
        <DataMatricula>2018-09-24T12:58:13.7370737-03:00</DataMatricula>		
		<GerarLogMatricPL>false</GerarLogMatricPL>
        <IdHabilitacaoFilial>4</IdHabilitacaoFilial>
        <IdPerLet>27</IdPerLet>
        <IdTurmaDisc>1128</IdTurmaDisc>
		<NumDiario>1</NumDiario>
        <RA>ES-00226</RA>
        <TipoDisciplina>Normal</TipoDisciplina>
        <TipoMat>1</TipoMat>
      </EduMatriculaDiscParams>
    </Disciplinas>    		
    <GerarLog>true</GerarLog>
    <IdHabilitacaoFilial>4</IdHabilitacaoFilial>
    <IdPerLet>27</IdPerLet>
    <Periodo>1</Periodo>
    <RA>ES-00222</RA>
  </MatricPLParams>
  <MatricularDisc>Sim</MatricularDisc>
</EduMatriculaParamsProc>]]></tot:strXmlParams>
      </tot:ExecuteWithXmlParams>
   </soapenv:Body>
</soapenv:Envelope>

...

Informações
iconfalse
Expandir
titleTabela de referência das Tags do XML
Tags do item EduMatriculaParamsProc
TagObrigatório

Parâmetro

Interno

Aceita

Nulo

Tipo de

Dados

ExemploDescrição
ActionModuleNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
ActionNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
CanParallelizeNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
CanSendMailNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
CanWaitScheduleNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
CodUsuarioNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
ConnectionIdNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
ConnectionStringNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno
Expandir
titleTags do item Context

É obrigatório informar esta tag, porém com as seguintes keys: CODTIPOCURSO, CODCOLIGADA, CODSISTEMA, CODUSUARIO e CODFILIAL. Segue exemplo:

Informações
iconfalse
Expandir
titleExemplo do item Context
Bloco de código
languagexml
  <Context z:Id="i2" xmlns="http://www.totvs.com/" xmlns:a="http://www.totvs.com.br/RM/">
	<a:_params xmlns:b="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
	  <b:KeyValueOfanyTypeanyType>
		<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODTIPOCURSO</b:Key>
		<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
	  </b:KeyValueOfanyTypeanyType>
	  <b:KeyValueOfanyTypeanyType>
		<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODCOLIGADA</b:Key>
		<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
	  </b:KeyValueOfanyTypeanyType>
	  <b:KeyValueOfanyTypeanyType>
		<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODSISTEMA</b:Key>
		<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">S</b:Value>
	  </b:KeyValueOfanyTypeanyType>
	  <b:KeyValueOfanyTypeanyType>
		<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODUSUARIO</b:Key>
		<b:Value i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">mestre</b:Value>
	  </b:KeyValueOfanyTypeanyType>
	  <b:KeyValueOfanyTypeanyType>
		<b:Key i:type="c:string" xmlns:c="http://www.w3.org/2001/XMLSchema">$CODFILIAL</b:Key>
		<b:Value i:type="c:int" xmlns:c="http://www.w3.org/2001/XMLSchema">1</b:Value>
	  </b:KeyValueOfanyTypeanyType>
	</a:_params>
	<a:Environment>DotNet</a:Environment>
  </Context>
CustomDataNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
DisableIsolateProcessNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
DriverTypeNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ExecutionIdNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
FailureMessageNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
FriendlyLogsNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
HideProgressDialogNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
HostNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
InitializedNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
IpNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
IsolateProcessNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
JobIDNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
JobServerHostNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
MasterActionNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
MaximumQuantityOfPrimaryKeysPerProcessNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
MinimumQuantityOfPrimaryKeysPerProcessNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
NetworkUserNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
NotifyEmailNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
NotifyEmailListNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
NotifyFluigNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
OnlineModeNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
Expandir
titleTags do item PrimaryKeyList

É obrigatório informar esta tag. Segue exemplo:

Informações
iconfalse
Expandir
titleExemplo do item PrimaryKeyList
Bloco de código
languagexml
  <PrimaryKeyList xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:ArrayOfanyType>
      <a:anyType i:type="b:short" xmlns:b="http://www.w3.org/2001/XMLSchema">1</a:anyType>
      <a:anyType i:type="b:int" xmlns:b="http://www.w3.org/2001/XMLSchema">4</a:anyType>
      <a:anyType i:type="b:string" xmlns:b="http://www.w3.org/2001/XMLSchema">ES-00222</a:anyType>
    </a:ArrayOfanyType>
  </PrimaryKeyList>
Expandir
titleTags do item PrimaryKeyNames

É obrigatório informar esta tag. Segue exemplo:

Informações
iconfalse
Expandir
titleExemplo do item PrimaryKeyName
Bloco de código
languagexml
  <PrimaryKeyNames xmlns="http://www.totvs.com/" xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <a:string>CODCOLIGADA</a:string>
    <a:string>IDHABILITACAOFILIAL</a:string>
    <a:string>RA</a:string>
  </PrimaryKeyNames>
PrimaryKeyTableNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ProcessNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
QuantityOfSplitsNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SaveLogInDatabaseNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SaveParamsExecutionNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ScheduleDateTimeNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SchedulerNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SendMailNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ServerNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ServiceInterfaceNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ShouldParallelizeNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
ShowReExecuteButtonNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
StatusMessageNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SuccessMessageNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
SyncExecutionNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
UseJobMonitorNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
UserNameNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
WaitScheduleNãoSimSimN/ANão é necessário informar no XML.Parâmetro interno.
CadastrarDisciplinasNãoSimSimBooleanoNão é necessário informar no XML.Carregamento das disciplinas na tela do processo de matrícula.
Expandir
titleTags do item MatricPLParams

Esta tag é obrigatória, segue referência de todos os itens.

TagObrigatório

Parâmetro

Interno

Aceita

Nulo

Tipo de

Dados

ExemploDescrição
AlteraMatrizContratoOriginalNãoSimSimBooleanoNão é necessário informar no XML.Altera matriz do contrato original na transferência interna.
ApagarNumeroDiarioNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para apagar o número do diário da matrícula no período letivo e/ou na disciplina de origem na mudança de turma.
CRNãoSimSimDecimalNão é necessário informar no XML.Coeficiente de rendimento.
CadastrarContratoNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para cadastrar contrato.
CancelarLancamentosNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para cancelar lançamentos.
CarteiraEmitidaNãoNãoSimBooleanofalseIndica se a carteirinha foi emitida. Campo exclusivo para o Ensino Básico.
ClientIPNãoSimSimStringNão é necessário informar no XML.Número de IP da máquina onde foi originada a chamada para a matrícula.
CobrarDocsTipoIngressoRematriculaEBNãoSimSimBooleanoNão é necessário informar no XML.

Indica se na rematrícula do ensino básico será considerado documentos do tipo ingresso.

CodColigadaSimNãoNãoInteiro1Código da coligada.
CodContratoNãoNãoSimString655Código do contrato caso o aluno já possua.
CodFilialSimNãoNãoInteiro1Código da filial.
CodFormulaNãoSimSimString

Não é necessário informar no XML.

Código da fórmula.
CodInstDestinoNãoSimSimStringNão é necessário informar no XML.Código da instituição de destino.
CodMotivoNãoSimSimInteiroNão é necessário informar no XML.Código do motivo.
CodMotivoTransferenciaNãoSimSimInteiroNão é necessário informar no XML.Código do motivo da transferência.
CodPlanoPgtoNãoNãoSimStringSIPPCódigo do plano de pagamento.
CodStatusSimNãoNãoInteiro1Código da situação de matrícula.
CodStatusNovoNãoSimSimInteiroNão é necessário informar no XML.Novo código da situação de matrícula.
CodStatusResNãoSimSimInteiroNão é necessário informar no XML.Código da situação de resultado.
CodTipoCursoSimNãoNãoInteiro1Código do tipo de curso (nível de ensino).
CodTipoMatNãoNãoSimInteiro1Código do tipo de matrícula.
CodTurmaNãoNãoSimStringTSI-2-032Código da turma do período letivo.
CodTurmaAnteriorNãoSimSimStringNão é necessário informar no XML.Código da turma anterior.
CodUsuarioSimNãoNãoStringmestreCódigo do usuário.
ColigadaRelatBoletoNãoNãoSimInteiro1Código da coligada do relatório do boleto. Para o seu preenchimento a situação de matrícula tem que exigir contrato financeiro e o campo IdRelatBoleto deverá estar preenchido.
ColigadaRelatContratoNãoNãoSimInteiro1Código da coligada do relatório do contrato. Para o seu preenchimento a situação de matrícula tem que exigir contrato financeiro e o campo IdRelatContrato deverá estar preenchido.
ContratosTempNãoSimSimObjetoNão é necessário informar no XML.Lista de contratos
CopiarDescontoPorAntecipacaoNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para copiar descontos por antecipação do contrato antigo na criação de um novo contrato.
CopiarRespFinanceiroContratoNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para copiar responsável financeiro do contrato.
CopiarVencimentosNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para copiar os vencimentos.
CotaFinalNãoNãoSimInteiro1

Cota final. Deverá ser preenchido obrigatoriamente caso a situação de matrícula exigir contrato financeiro, o campo GerarLancamento = true e o campo TipoSelecaoParcela = Parcela.

CotaInicialNãoNãoSimInteiro1Cota inicial. Deverá ser preenchido obrigatoriamente caso a situação de matrícula exigir contrato financeiro, o campo GerarLancamento = true e o campo TipoSelecaoParcela = Parcela.
DataCancelamentoContratoNãoSimSimDataNão é necessário informar no XMLData de cancelamento do contrato.
DataCancelamentoParcelasNãoSimSimDataNão é necessário informar no XMLData de cancelamento das parcelas.
DataFinalParcNãoNãoSimData2018-09-30Data final da parcela. Deverá ser preenchido obrigatoriamente caso a situação de matrícula exigir contrato financeiro, o campo GerarLancamento = true e o campo TipoSelecaoParcela = Data.
DataIngressoNãoSimSimDataNão é necessário informar no XML.Data de ingresso.
DataInicialParcNãoNãoSimData2018-09-11

Data inicial da parcela. Deverá ser preenchido obrigatoriamente caso a situação de matrícula exigir contrato financeiro, o campo GerarLancamento = true e o campo TipoSelecaoParcela = Data.

DataMatriculaSimNãoNãoData2018-09-17Data da matrícula.
DataMatriculaAnteriorNãoSimSimDataNão é necessário informar no XML.Data da matrícula anterior.
DataMatriculaEncerraNãoSimSimDataNão é necessário informar no XML.Data de encerramento da matrícula para efeitos do Educacenso.
DataMatriculaEncerraAnteriorNãoSimSimDataNão é necessário informar no XML.Data anterior de encerramento da matricula para efeitos do Educacenso.
DataMatriculaEncerraNovaNãoSimSimDataNão é necessário informar no XML.Data nova de encerramento da matricula para efeitos do Educacenso.
DataMatriculaNovaNãoSimSimDataNão é necessário informar no XML.Data nova de matrícula.
DiaFixoNãoSimSimEnumeradoNão é necessário informar no XML.Indica se o dia é fixo.
DiaVencimentoNãoSimSimDataNão é necessário informar no XML.Dia do vencimento.
Expandir
titleTags do item Disciplinas

Esta tag é obrigatória. Segue referência de todos os itens.

Informações
iconfalse

Para cada disciplina que deseja que o aluno seja matriculado é necessário criar um novo EduMatriculaDiscParams.

Expandir
titleItens da tag EduMatriculaDiscParams
TagObrigatório

Parâmetro

Interno

Aceita

Nulo

Tipo de

Dados

ExemploDescrição
AlunoRegularNãoSimSimBooleanoNão é necessário informar no XML.Indica se o aluno é regular.
ApagarNumeroDiarioNãoSimSimBooleanoNão é necessário informar no XML.Apagar número do diário na matrícula da disciplina.
AtendeuCreditoMinimoNãoSimSimBooleanoNão é necessário informar no XML.Indica se atendeu a quantidade de créditos mínimos (utilizado para processo seletivo terceirizado).
CargaHorariaNãoSimSimDecimalNão é necessário informar no XML.Carga horária.
ClientIPNãoSimSimStringNão é necessário informar no XML.Número de IP da máquina onde foi originada a chamada para a matrícula.
CobPosteriorMatricNãoSimSimStringNão é necessário informar no XML.Cobrança posterior a matrícula.
CodCampusNãoSimSimStringNão é necessário informar no XML.Código do campus.
CodColigadaSimNãoNãoInteiro1Código da coligada.
CodCursoNãoSimSimStringNão é necessário informar no XML.Código do curso.
CodDiscNãoSimSimStringNão é necessário informar no XML.Código da disciplina.
CodFilialSimNãoNãoInteiro1Código da filial.
CodFormulaSimNãoSimStringNão é necessário informar no XML.Código da fórmula.
CodGradeSimNãoSimStringNão é necessário informar no XML.Código da matriz curricular.
CodHabilitacaoSimNãoSimStringNão é necessário informar no XML.Código da habilitação.
CodMotivoNãoSimSimInteiroNão é necessário informar no XML.Código do motivo.
CodPerLetNãoSimSimStringNão é necessário informar no XML.Código do período letivo.
CodSituacaoMatriculaEsperaNãoSimSimInteiroNão é necessário informar no XML.Código da situação de matrícula da lista de espera.
CodStatusSimNãoNãoInteiro13Código da situação de matrícula.
CodStatusNovoNãoSimSimInteiroNão é necessário informar no XML.Código nova da situação de matrícula.
CodStatusPLNãoSimSimInteiroNão é necessário informar no XML.Código da situação de matrícula do período letivo.
CodStatusResNãoSimSimInteiroNão é necessário informar no XML.Código da situação de resultado.
CodSubturmaNãoNãoSimStringACódigo da subturma.
CodTipoCursoSimNãoNãoInteiro1Código do tipo de curso (nível de ensino).
CodTurmaNãoSimSimStringTSI-2-032Código da turma.
CodTurnoNãoSimSimStringNão é necessário informar no XML.Código do turno.
CodUsuarioSimNãoNãoStringmestreCódigo do usuário.
CoeficienteRendimetoNãoSimSimDecimalNão é necessário informar no XML.Coeficiente de rendimento.
DataMatriculaSimNãoNãoData2018-09-19Data de matrícula.
DescStatusNovoNãoSimSimStringNão é necessário informar no XML.Descrição da situação de matrícula nova.
DtAlteracaoNãoSimSimDataNão é necessário informar no XML.Data de alteração.
EnturmandoTurmaMistaNãoSimSimBooleanoNão é necessário informar no XML.Indica se está enturmando em turma mista.
ExcluirMatriculaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para excluir a matrícula se não tiver vaga e não for colocar na lista de espera
GerarLogMatricPLNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para gerar log da matrícula no período letivo.
IdHabilitacaoFilialSimNãoNãoInteiro4Id. da habilitação filial (matriz aplicada).
IdHabilitacaoFilialOrigemNãoSimSimInteiroNão é necessário informar no XML.Id. origem da habilitação filial (matriz aplicada).
IdPerLetSimNãoNãoInteiro27Id. do período letivo.
IdTurmaDiscSimNãoNãoInteiro1128Id. da turma/disciplina.
IdTurmaDiscOrigemNãoSimSimInteiroNão é necessário informar no XML.Id. origem da turma/disciplina.
IdTurmaDiscSubstNãoSimSimInteiroNão é necessário informar no XML.

Id. de substituição da turma/disciplina.

IncluirListaEsperaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para incluir em lista de espera.
IsEnturmacaoNãoSimSimBooleanoNão é necessário informar no XML.Indica se a matrícula está sendo feita pelo processo de enturmação.
LogExcecoesNãoSimSimObjetoNão é necessário informar no XML.Log de exceções.
LogInformacoesNãoSimSimObjetoNão é necessário informar no XML.Log de informações.
MatriculaNoUltimoPeriodoNãoSimSimBooleanoNão é necessário informar no XML.Indica se o aluno está tentando se matricular no último período de seu curso.
MatriculaSubstituicaoAtivaNãoSimSimBooleanoNão é necessário informar no XML.Indica se a substituição da matrícula será incluída na lista de espera.
MatriculaViaProcessoSeletivoRMNãoSimSimBooleanoNão é necessário informar no XML.Indica matrícula realizada via Processo Seletivo RM.
MatriculaViaProcessoSeletivoTerceirizadoNãoSimSimBooleanoNão é necessário informar no XML.Indica matrícula realizada via Processo Seletivo Terceirizado.
MatriculaWebNãoSimSimBooleanoNão é necessário informar no XML.Indica matrícula realizada via web.
MatrizAlunoNãoSimSimInteiroNão é necessário informar no XML.Id. da habilitação filial (matriz aplicada).
MediaGlobalNãoSimSimDecimalNão é necessário informar no XML.Média global.
MudancaStatusNãoSimSimBooleanoNão é necessário informar no XML.Indica se é mudança de situação de matrícula.
MudancaTurmaNãoSimSimBooleanoNão é necessário informar no XML.Indica se á mudança de turma.
NomeAlunoNãoSimSimStringNão é necessário informar no XML.Nome do aluno
NomeCampusNãoSimSimStringNão é necessário informar no XML.Nome do campus.
NomeCursoNãoSimSimStringNão é necessário informar no XML.Nome do curso.
NomeDiscNãoSimSimStringNão é necessário informar no XML.Nome da disciplina.
NomeFilialNãoSimSimStringNão é necessário informar no XML.Nome da filial.
NomeHabilitacaoNãoSimSimStringNão é necessário informar no XML.Nome da habilitação.
NomeMatrizCurricularNãoSimSimStringNão é necessário informar no XML.Nome da matriz curricular.
NomeTurnoNãoSimSimStringNão é necessário informar no XML.Nome do turno.
NumCreditosNãoSimSimDecimalNão é necessário informar no XML.Número de créditos.
NumCreditosCobNãoSimSimDecimalNão é necessário informar no XML.Número de créditos de cobrança.
NumDiarioNãoNãoSimInteiro1Número do diário na matrícula da disciplina.
NumDiarioAnteriorNãoSimSimInteiroNão é necessário informar no XML.Número do diário anterior.
ObsHistoricoNãoSimSimStringNão é necessário informar no XML.Observação do histórico.
OrdemPriorMatriculaNãoSimSimStringNão é necessário informar no XML.Ordem de prioridade de matrícula.
OrigemNãoSimSimEnumeradoNão é necessário informar no XML.Indica se a turma/disciplina teve origem no produto ou na customização.
ParamDiversosNãoSimSimObjetoNão é necessário informar no XML.Parâmetros para auxílio na matrícula.
PeriodoNãoSimSimInteiroNão é necessário informar no XML.Código do período da matriz curricular.
PeriodoDeMatriculaNãoSimSimInteiroNão é necessário informar no XML.Indica o período que o aluno está tentando se matricular.
PermiteAlterarDadosNãoSimSimBooleanoNão é necessário informar no XML.Indica se permite a alteração dos dados.
PermiteTransfInternaAlunoInadimplenteNãoSimSimBooleanoNão é necessário informar no XML.Permite a transferência interna de alunos inadimplentes.
PodeRodarNumeracaoAutomaticaNãoSimSimBooleanoNão é necessário informar no XML.Utilizado na enturmação para otimização da movimentação de Enturmação e Desenturmação.
PossivelFormandoNãoSimSimBooleanoNão é necessário informar no Não é necessário informar no XML.XML.Possível Formando.
ProcessoListaEsperaPrioridadeNãoSimSimBooleanoNão é necessário informar no XML.Indica se é o processo de lista de espera por prioridade.
ProcurarOutraTurmaNãoSimSimBooleanoNão é necessário informar no XML.Indica se não tiver vagas, procurar outra turma da mesma disciplina e horário.
RASimNãoNãoStringES-00222Registro acadêmico.
RematriculaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é rematrícula.
SalvouMatriculaNãoSimSimBooleanoNão é necessário informar no XML.Indica se salvou a matrícula.
TipoDiscGradeNãoSimSimEnumeradoNão é necessário informar no XML.Tipo de disciplina da grade.
TipoDisciplinaSimNãoNãoEnumeradoNormal

Tipo de disciplina. Valores permitidos:

  • Normal
  • Interna
  • Extra
  • Dependencia
TipoMatSimNãoNãoInteiro1Tipo de matrícula.
TransferenciaInternaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é transferência interna.
ValidadoTurmaMistaNãoSimSimBooleanoNão é necessário informar no XML.Indica se foi validado a turma mista.
ValidarInadimplenciaNãoSimSimBooleanoNão é necessário informar no XML.Indica se vai validar a inadimplência.
ValidarIntegracaoBibliotecaNãoSimSimBooleanoNão é necessário informar no XML.Indica se vai validar a inadimplência na integração com a biblioteca.
DtCompetenciaFinalNãoNãoSimString03/2018Data de competência final.
DtCompetenciaInicialNãoNãoSimString01/2018Data de competência inicial.
DtMatriculaPagNãoSimSimDataNão é necessário informar no XML.Data de pagamento da matrícula.
DtResultadoNãoSimSimDataNão é necessário informar no XML.Data do resultado da matrícula.
DtSolicitacaoAlteracaoNãoSimSimDataNão é necessário informar no XML.Data da solicitação de alteração.
EmTransacaoNãoSimSimBooleanoEmTransacaoIndica o status da transação.
GerarLancamentoNãoNãoSimBooleanofalse

Indica se é para gerar lançamento. Somente irá gerar lançamento se a situação de matrícula exigir contrato financeiro e o obedecer os critérios abaixo:

  • Preencher o campo CodPlanoPgto;
  • Preencher o campo TipoSelecaoParcela, ver valores permitidos pertinentes a este campo.
GerarLogNãoNãoSimBooleanotrueIndica se é para gerar log ao matricular aluno.
GerouContratoComPlanoNãoSimSimBooleanoNão é necessário informar no XML.

Indica se gerou contrato com plano de pagamento.

IDPSNãoSimSimInteiroNão é necessário informar no XML.Id. do processo seletivo.
IdHabilitacaoFilialSimNãoNãoInteiro4Id. da habilitação filial (matriz aplicada).
IdHabilitacaoFilialOrigemNãoSimSimInteiroNão é necessário informar no XML.Id. origem da habilitação filial (matriz aplicada).
IdPerLetSimNãoNãoInteiro27Id. do período letivo.
IdRelatBoletoNãoNãoSimInteiro1

Id. do relatório do boleto. Para o seu preenchimento a situação de matrícula tem que exigir contrato financeiro e o campo ColigadaRelatBoleto deverá estar preenchido.

IdRelatContratoNãoNãoSimInteiro1Id. do relatório do contrato. Para o seu preenchimento a situação de matrícula tem que exigir contrato financeiro e o campo ColigadaRelatContrato deverá estar preenchido.
IdentificadorNãoSimSimStringNão é necessário informar no XML.Identificador.
IsDesenturmacaoNãoSimSimBooleanoNão é necessário informar no XML.Indica se é desenturmação.
IsEnturmacaoNãoSimSimBooleanoNão é necessário informar no XML.Indica se é enturmação.
IsRematriculaSimSimNãoBooleanofalseIndica se é rematrícula. Sempre informar false.
LogContratoNãoSimSimObjetoNão é necessário informar no XML.Log referênte a informações impactam no cancelamento  do contrato.
LogExcecoesNãoSimSimObjetoNão é necessário informar no XML.Log de exceções.
MatriculaWebNãoSimSimBooleanoNão é necessário informar no XML.Indica se é matrícula web.
MudancaStatusNãoSimSimBooleanoNão é necessário informar no XML.Indica se é mudança de situação de matrícula.
MudancaTurmaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é mudança de turma.
NomeAlunoNãoSimSimStringNão é necessário informar no XML.Nome do aluno.
NumCarteiraNãoNãoSimString10Número da carteirinha. Campo exclusivo para o Ensino Básico.
NumeroInscricaoNãoSimSimInteiroNão é necessário informar no XML.Número de inscrição.
OrigemParcelaNãoSimSimEnumeradoNão é necessário informar no XML.Origem da parcela.
ParametrosDiversosNãoSimSimObjetoNão é necessário informar no XML.Parâmetros para auxílio na matrícula.
ParcelaFinalNãoNãoSimInteiro1DataInicialParc
ParcelaInicialNãoNãoSimInteiro1Parcela inicial. Deverá ser preenchido obrigatoriamente caso a situação de matrícula exigir contrato financeiro, o campo GerarLancamento = true e o campo TipoSelecaoParcela = Parcela.
PeriodoNãoNãoSimInteiro1Código do período da matriz curricular.
PermiteTransfInternaAlunoInadimplenteNãoSimSimBooleanoNão é necessário informar no XML.Indica se permite a transferência interna do aluno inadimplente.
PodeRodarNumeracaoAutomaticaNãoSimSimBooleanoNão é necessário informar no XML.Utilizado na enturmação para otimização da movimentação de Enturmação e Desenturmação.
RASimNãoNãoStringES-00222Registro acadêmico (RA) do aluno.
RematriculaEBasicoAjusteContratoHabFilialNãoSimSimBooleanoPermiteTransfInternaAlunoInadimplente

Indica se estamos ajustando SCONTRATO.IDHABILITACAOFILIAL na rematrícula do nível de ensino Básico.

Expandir
titleTags do item ResponsaveisFinanceirosContrato

Esta tag não é obrigatória. Segue referência de todos os itens.

Informações
iconfalse

Para cada responsável financeiro que deseja inserir é necessário criar um novo EduResponsavelContratoItem.

Expandir
titleItens da tag EduResponsavelContratoItem
TagObrigatório

Parâmetro

Interno

Aceita

Nulo

Tipo de

Dados

ExemploDescrição
InternalIdNãoSimSimInteiroNão é necessário informar no XML.InternalId.
CodCfoSimNãoNãoStringC01455Código do cliente.
CodColCfoSimNãoNãoInteiro1Código da coligada do cliente.
CodColigadaSimNãoNãoInteiro1Código da coligada.
CodContratoNãoSimSimStringNão é necessário informar no XML.Código do contrato.
IdPeriodoLetivoNãoSimSimInteiroNão é necessário informar no XML.Id. do período letivo.
NomeNãoSimSimStringNão é necessário informar no XML.Nome do cliente.
PercentualSimNãoNãoInteiroDoublePercentual.
RegistroAcademicoNãoSimSimStringNão é necessário informar no XML.Registro acadêmico.
ResponsavelMovimentoNãoNãoNãoEnumeradoNao

Indica se o responsável também é responsável pelo movimento.

Valores permitidos: Sim ou Nao.

Informações
iconfalse
Expandir
titleExemplo do item EduResponsavelContratoItem
Bloco de código
languagexml
    <ResponsaveisFinanceirosContrato xmlns:a="http://www.totvs.com/">
      <a:EduResponsavelContratoItem z:Id="i57">
        <a:InternalId i:nil="true" />
        <CodCfo>C01455</CodCfo>
        <CodColCfo>1</CodColCfo>
        <CodColigada>1</CodColigada>
        <CodContrato i:nil="true" />
        <IdPeriodoLetivo>0</IdPeriodoLetivo>
        <Nome>Felipe Paulo Novaes</Nome>
        <Percentual>100</Percentual>
        <RegistroAcademico i:nil="true" />
        <ResponsavelMovimento>Nao</ResponsavelMovimento>
      </a:EduResponsavelContratoItem>
    </ResponsaveisFinanceirosContrato>







TipoOperacaoNãoSimSimEnumerado

Não é necessário informar no XML.

Tipo de operação (Inclusão, Alteração e Exclusão).
TipoSelecaoParcelaNãoNãoSimEnumeradoParcela

Tipo de seleção de parcela. Somente preencher se o campo GerarLancamento = true. Valores permitidos:

  • Parcela
  • Data
TransferenciaInternaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é transferência interna.
TurnosDiferentesNãoSimSimBooleanoNão é necessário informar no XML.Indica que está havendo uma alteração de turno na mudança de turma.
UsarPlanoPgtoParametrizacaoCurso





ValidarInadimplenciaBibliotecaNãoSimSimBooleanoNão é necessário informar no XML.Indica se é para validar a inadimplência do aluno na biblioteca.
ViaCarteiraNãoNãoSimStringPrimeiraVia da carteirinha. Campo exclusivo para o Ensino Básico.
grupoRelatNãoSimSimInteiroNão é necessário informar no XML.Grupo de relatório.
MatricularDiscSimNãoNãoBooleanoEnumeradotrueSimIndica matrícula em disciplina. Sempre informar true Sim.
Aviso
titleImportante
  • As tags que não são obrigatórias e/ou que aceitam nulo o recomendado é não informar elas no XML.

...