Histórico da Página
Visão Geral dos processos WebSevices de
...
Tipo de Referência
O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de tipo de alunos referência através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de tipo de alunos referência no TOTVS Gestão EducacionalBibliotecária.
Através do dataserver "EduAlunoDataBibTipoRefData" e por meio dos métodos ReadRecord, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações de tipo de alunos referência no TOTVS Gestão EducacionalBibliotecária.
Se necessário clique aqui para obter ajuda na configuração do Host.
...
Expandir | ||||
---|---|---|---|---|
| ||||
|
Método ReadRecord
Este método realiza a consulta de um alunotipo de referência. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo.
O sistema irá realizar a consulta de alunotipo de referência, caso as informações passadas estejam de acordo com algum aluno tipo de referência já existente no sistema.
Consulta de
...
tipo de referência
Para realizar a consulta de um alunotipo de referência, deve ser utilizado a operação de ReadRecord.
...
O XML deve conter os campos CODCOLIGADA e RA como informações da chave para busca do alunotipo de referência.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:ReadRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>BibTipoRefData</tot:DataServerName> <!--Optional:--> <tot:PrimaryKey>1;EB-00384<4</tot:PrimaryKey> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=2<1</tot:Contexto> </tot:ReadRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><![CDATA[<EduAluno><BibTipoRef> <SAluno><LTipoRef> <CODCOLIGADA>1</CODCOLIGADA> <RA>EB-00384</RA> <CODPESSOA>4105</CODPESSOA> <CODTIPOCURSO>2</CODTIPOCURSO> <CODIGO>4105</<CODIGO>4</CODIGO> <NOME>Yasmin<DESCRICAO>Tipo Marcelade Cavalcanti<Referência</NOME>DESCRICAO> <CPF>38252307671<<SIMBOLO>TR</CPF>SIMBOLO> <SOBRENOME>Cavalcanti</SOBRENOME> <APELIDO>Yasmin</APELIDO> <DTNASCIMENTO>1994-06-10T00:00:00</DTNASCIMENTO> <NACIONALIDADE>10</NACIONALIDADE> <ESTADONATAL>MG</ESTADONATAL> <NATURALIDADE>Belo Horizonte</NATURALIDADE> <NIT>0</NIT> <NROFILHOSBRASIL>0</NROFILHOSBRASIL> <CONJUGEBRASIL>0</CONJUGEBRASIL> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0</FILHOSBRASIL> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00</INDATENDESPECIFICO> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F</CANHOTO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0</ESTADOROW> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1</ALUNO> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0</CANDIDATO> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0</FUNCIONARIO> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0</FALECIDO> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON> <CODIGO1>4105</CODIGO1> </EduAluno></LTipoRef> </BibTipoRef>]]></ReadRecordResult> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<ReadRecordResult><EduAluno BibTipoRef/></ReadRecordResult> |
Método SaveRecord
Este método realiza a inclusão ou alteração de um alunotipo de referência. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo, além dos outros campos que estão configurados como obrigatórios no sistema.
O sistema irá realizar a inclusão de um alunotipo de referência, caso o código informado não exista na base.
Se o Registro Acadêmico Código existir na coligada informada, essa terá as informações alteradas de acordo com o que será passado no arquivo XML.Observação: Caso sejam passadas para o dataserver informações para campos complementares, devem ser utilizados os mesmos códigos obrigatórios para que o sistema consiga entender que se referem ao aluno que se deseja alterar.
Inclusão de tipo de
...
referência
Para realizar inclusão de um alunotipo de referência, deve ser utilizado a operação de SaveRecord.
Deve ser passado um XML contendo todos os campos que serão cadastrados, como informação, para o alunotipo de referência.
Caso o Registro acadêmico código informado não exista, será incluído um novo alunotipo de referência. Caso contrário, o mesmo terá suas informações atualizadas.
O XML deve conter a tabela SALUNOtabela LTipoRef com os campos CODCOLIGADA e RACODIGO como informações da chave para o cadastro de tipo de aluno referência e, também, os campos obrigatórios para seu cadastro.
A inclusão do Aluno irá levar em consideração as configurações de RA informadas no sistema. Para que o RA seja criado automaticamente, deve-se informar "0" para o registroO código será sempre criado automático, dessa forma, informaremos o registro como "0".
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>BibTipoRefData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduAluno><BibTipoRef> <SAluno><LTipoRef> <CODCOLIGADA>1</CODCOLIGADA> <RA>0</RA> <CODPESSOA>0</CODPESSOA> <CODTIPOCURSO>2</CODTIPOCURSO> <CODIGO>0<<CODIGO>5</CODIGO> <NOME>Stella<DESCRICAO>Tipo Fernandade Aparício<Referencia</NOME>DESCRICAO> <CPF>62587463653</CPF> <SOBRENOME>Aparício</SOBRENOME> <APELIDO>Fernanda</APELIDO> <DTNASCIMENTO>1994-06-10T00:00:00</DTNASCIMENTO> <NACIONALIDADE>10</NACIONALIDADE> <ESTADONATAL>MG</ESTADONATAL> <NATURALIDADE>Belo Horizonte</NATURALIDADE> <NIT>0</NIT> <NROFILHOSBRASIL>0</NROFILHOSBRASIL> <CONJUGEBRASIL>0</CONJUGEBRASIL> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0</FILHOSBRASIL> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00</INDATENDESPECIFICO> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F</CANHOTO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0</ESTADOROW> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1</ALUNO> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0</CANDIDATO> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0</FUNCIONARIO> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0</FALECIDO> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON> <CODIGO1>4105</CODIGO1> </SAluno> <SAlunoCompl> <CODCOLIGADA>1</CODCOLIGADA> <RA>0</RA> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON> </SAlunoCompl> </EduAluno><SIMBOLO>TR</SIMBOLO> </LTipoRef> </BibTipoRef>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto> </tot:SaveRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<SaveRecordResult>1;8001408<5</SaveRecordResult> |
Informações |
---|
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada e o registro acadêmico código inserido no item SaveRecordResult. |
Alteração de
...
tipo de referência
Para realizar alteração de um alunotipo de referência, deve ser utilizado a operação de SaveRecord.
Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de alunotipo de referência.
O XML deve conter a tabela SALUNOtabela LTipoRef com os campos CODCOLIGADA e RA CODIGO como informações da chave para a atualização do cadastro de tipo de alunoreferência.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>BibTipoRefData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduAluno><BibTipoRef> <SAluno><LTipoRef> <CODCOLIGADA>1</CODCOLIGADA> <RA>0</RA> <CODPESSOA>0</CODPESSOA> <CODTIPOCURSO>2</CODTIPOCURSO> <CODIGO>0</<CODIGO>5</CODIGO> <NOME>Stella<DESCRICAO>Tipo Fernandade Aparício<Ref</NOME>DESCRICAO> <CPF>62587463653</CPF> <SOBRENOME>Aparício</SOBRENOME> <APELIDO>Fernanda</APELIDO> <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO> <NACIONALIDADE>10</NACIONALIDADE> <ESTADONATAL>MG</ESTADONATAL> <NATURALIDADE>Belo Horizonte</NATURALIDADE> <NIT>0</NIT> <NROFILHOSBRASIL>0</NROFILHOSBRASIL> <CONJUGEBRASIL>0</CONJUGEBRASIL> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0</FILHOSBRASIL> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00</INDATENDESPECIFICO> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F</CANHOTO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0</ESTADOROW> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1</ALUNO> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0</CANDIDATO> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0</FUNCIONARIO> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0</FALECIDO> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON> <CODIGO1>4105</CODIGO1> </SAluno> <SAlunoCompl> <CODCOLIGADA>1</CODCOLIGADA> <RA>0</RA> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON> </SAlunoCompl> </EduAluno><SIMBOLO>TiR</SIMBOLO> </LTipoRef> </BibTipoRef>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto> </tot:SaveRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<SaveRecordResult>1;8001408<5</SaveRecordResult> |
Informações |
---|
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o registro acadêmico código no item SaveRecordResult. |
Método DeleteRecord
Este método realiza a exclusão de um alunotipo de referência. Algumas informações são obrigatórias e devem ser informadas: o código da coligada e o registro acadêmicocódigo, além dos outros campos que estão configurados como obrigatórios no sistema.
O sistema irá realizar a exclusão de um aluno código caso encontre o registro.
Exclusão de
...
tipo de referência
Para realizar exclusão de um alunotipo de referência, deve ser utilizado a operação de DeleteRecord.
Deve ser passado um XML contendo todos os campos que fazem parte do registro de alunotipo de referência.
O XML deve conter a tabela SALUNO tabela LTipoRef com os campos CODCOLIGADA e RA como informações da chave para o cadastro de tipo de aluno referência e, também, os campos obrigatórios para seu cadastro.
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<tot:DeleteRecord> <!--Optional:--> <tot:DataServerName>EduAlunoData<DataServerName>BibTipoRefData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduAluno><BibTipoRef> <SAluno><LTipoRef> <CODCOLIGADA>1</CODCOLIGADA> <RA>8001408</RA> <CODPESSOA>45087</CODPESSOA> <CODTIPOCURSO>2</CODTIPOCURSO> <CODIGO>45087</<CODIGO>5</CODIGO> <NOME>Stella<DESCRICAO>Tipo Fernandade Aparício<Ref</NOME>DESCRICAO> <CPF>62587463653</CPF> <SOBRENOME>Aparício</SOBRENOME> <APELIDO>Fernanda</APELIDO> <DTNASCIMENTO>1994-06-12T00:00:00</DTNASCIMENTO> <NACIONALIDADE>10</NACIONALIDADE> <ESTADONATAL>MG</ESTADONATAL> <NATURALIDADE>Belo Horizonte</NATURALIDADE> <NIT>0</NIT> <NROFILHOSBRASIL>0</NROFILHOSBRASIL> <CONJUGEBRASIL>0</CONJUGEBRASIL> <NATURALIZADO>0</NATURALIZADO> <FILHOSBRASIL>0</FILHOSBRASIL> <INDATENDESPECIALIZADO>00</INDATENDESPECIALIZADO> <INDATENDESPECIFICO>00</INDATENDESPECIFICO> <INDICADORDERECURSOS>00</INDICADORDERECURSOS> <CANHOTO>F</CANHOTO> <INVESTTREINANT>0.00</INVESTTREINANT> <ESTADOROW>0</ESTADOROW> <ROWVALIDA>0</ROWVALIDA> <ALUNO>1</ALUNO> <PROFESSOR>0</PROFESSOR> <CANDIDATO>0</CANDIDATO> <USUARIOBIBLIOS>0</USUARIOBIBLIOS> <FUNCIONARIO>0</FUNCIONARIO> <EXFUNCIONARIO>0</EXFUNCIONARIO> <FALECIDO>0</FALECIDO> <CODSTATUS>-1</CODSTATUS> <FIADOR_SGI>0</FIADOR_SGI> <CONJUGE_SGI>0</CONJUGE_SGI> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:41</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:41</RECMODIFIEDON> <CODIGO1>4105</CODIGO1> </SAluno> <SAlunoCompl> <CODCOLIGADA>1</CODCOLIGADA> <RA>8001408</RA> <RECCREATEDBY>mestre</RECCREATEDBY> <RECCREATEDON>2018-04-03T08:42:42</RECCREATEDON> <RECMODIFIEDBY>mestre</RECMODIFIEDBY> <RECMODIFIEDON>2018-04-03T08:42:42</RECMODIFIEDON> </SAlunoCompl> </EduAluno><SIMBOLO>TiR</SIMBOLO> </LTipoRef> </BibTipoRef>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=3;CODSISTEMA=S;<1</tot:Contexto> </tot:DeleteRecord> |
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
<DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult> |
...