O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de equivalência através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de equivalência no TOTVS Gestão Educacional.
Através do dataserver "EduEquivalenciaData" e por meio dos métodos ReadRecord, ReadView, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações de equivalência no TOTVS Gestão Educacional.
Se necessário clique aqui para obter ajuda na configuração do Host.
Este método realiza a consulta de uma equivalência. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o id. do grupo de disciplinas e id. do grupo de disciplinas equivalentes.
O sistema irá realizar a consulta da equivalência, caso as informações passadas estejam de acordo com alguma equivalência já existente no sistema.
Para realizar a consulta de uma equivalência, deve ser utilizado a operação de ReadRecord.
Deve ser passado um XML contendo todos os campos de chave primária.
Caso a chave informada não retorne registro, o resultado será o nome do DataSet. Caso contrário, a mesma terá suas informações exibidas através de um XML.
O XML deve conter os campos CODCOLIGADA e IDGRUPOEQ e IDGRUPOEQEQUIV como informações da chave para busca da equivalência.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:ReadRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:PrimaryKey>1;85;86</tot:PrimaryKey> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:ReadRecord> </soapenv:Body> </soapenv:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadRecordResponse xmlns="http://www.totvs.com/"> <ReadRecordResult><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>85</IDGRUPOEQ> <IDGRUPOEQEQUIV>86</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>85</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>86</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>85</IDGRUPO> <NOME>MATEMÁTICA</NOME> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>86</IDGRUPO> <NOME>ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</NOME> </SDISCGRUPOEQ> </EduEquivalencia>]]></ReadRecordResult> </ReadRecordResponse> </s:Body> </s:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadRecordResponse xmlns="http://www.totvs.com/"> <ReadRecordResult><EduEquivalencia /></ReadRecordResult> </ReadRecordResponse> </s:Body> </s:Envelope> |
Este método retorna os dados de uma ou mais equivalências de acordo com o filtro informado no XML. Entretanto, somente irá retornar se as informações passadas estejam de acordo com alguma equivalência já existente no sistema.
Para realizar esta consulta, deve ser utilizado a operação de ReadView, sendo necessário informar o DataServerName, Filtro e o Contexto. Para visualizar os nomes dos campos para a montagem do filtro de equivalência, acesse: Currículo e Oferta | Estrutura Curricular | Mais | Equivalências | Filtro, selecione para criar um novo. Ao passar o mouse em cima dos itens, serão exibidos os nomes dos campos do cadastro de equivalência, tais poderão ser utilizados na montagem do filtro no XML. Exemplo de como obter o nome do campo.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:ReadView> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:Filtro>SDISCGRUPOEQ.CODDISC = 'A002-1'</tot:Filtro> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:ReadView> </soapenv:Body> </soapenv:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadViewResponse xmlns="http://www.totvs.com/"> <ReadViewResult><![CDATA[<NewDataSet> <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>85</IDGRUPOEQ> <IDGRUPOEQEQUIV>86</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> <CODTIPOCURSODESTINO>1</CODTIPOCURSODESTINO> <NOMETIPOCURSODESTINO>Ensino Superior</NOMETIPOCURSODESTINO> <LISTDISC>A002-1 - MATEMÁTICA</LISTDISC> <LISTDISCEQUIV>A012-1 - ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</LISTDISCEQUIV> </SEQUIVALENCIA> </NewDataSet>]]></ReadViewResult> </ReadViewResponse> </s:Body> </s:Envelope> |
Este método realiza a inclusão ou alteração de uma equivalência.
O sistema irá realizar a inclusão de uma equivalência, caso o código informado não exista na base.
Se a equivalência existir na coligada informada, essa terá as informações alteradas de acordo com o que será passado no arquivo XML.
Para realizar inclusão de uma equivalê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 a equivalência.
Caso a equivalência informada não exista, será incluída uma nova. Caso contrário, a mesma terá suas informações atualizadas.
O XML deve conter as tabelas conforme exemplo abaixo.
Vale ressaltar que no exemplo abaixo será criado uma equivalência entre duas disciplinas, sendo o lado esquerdo a A002-1 e do lado direito a A012-1. Outro ponto importante os campos IDGRUPOEQ e IDGRUPOEQEQUIV da tabela SEQUIVALENCIA estão respectivamente com -1 e -2, o campo IDGRUPOEQ da SGRUPOEQ está com -1 e -2 nos respectivos registros, o mesmo vale para o IDGRUPO da tabela SDISCGRUPOEQ.
Lado esquerdo | Lado direito |
---|---|
A002-1 | A012-1 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-1</IDGRUPOEQ> <IDGRUPOEQEQUIV>-2</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-1</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-2</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>-1</IDGRUPO> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>-2</IDGRUPO> </SDISCGRUPOEQ> </EduEquivalencia>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:SaveRecord> </soapenv:Body> </soapenv:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <SaveRecordResponse xmlns="http://www.totvs.com/"> <SaveRecordResult>1;87;88</SaveRecordResult> </SaveRecordResponse> </s:Body> </s:Envelope> |
Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, id. do grupo de disciplinas e id. do grupo de disciplinas equivalentes inserido no item SaveRecordResult. |
Caso seja necessário incluir um grupo de equivalência, ou seja, do lado esquerdo uma disciplina e do lado direito duas disciplinas, segue exemplo.
Lado esquerdo | Lado direito |
---|---|
A002-1 | 146-1 |
A012-1 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-1</IDGRUPOEQ> <IDGRUPOEQEQUIV>-2</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-1</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>-2</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>-1</IDGRUPO> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>146-1</CODDISC> <IDGRUPO>-2</IDGRUPO> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>-2</IDGRUPO> </SDISCGRUPOEQ> </EduEquivalencia>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:SaveRecord> </soapenv:Body> </soapenv:Envelope> |
Para realizar alteração de uma equivalê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 equivalência. Para obter o XML deve-se rodar o ReadRecord, a partir daí fazer as alterações que desejar.
Como exemplo vamos alterar a disciplina de código A012-1 para 146-1.
Antes da alteração | Depois da alteração | ||
---|---|---|---|
Lado esquerdo | Lado direito | Lado esquerdo | Lado direito |
A002-1 | A012-1 | A002-1 | 146-1 |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadRecordResponse xmlns="http://www.totvs.com/"> <ReadRecordResult><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> <IDGRUPOEQEQUIV>88</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>88</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>87</IDGRUPO> <NOME>MATEMÁTICA</NOME> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>88</IDGRUPO> <NOME>ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</NOME> </SDISCGRUPOEQ> </EduEquivalencia>]]></ReadRecordResult> </ReadRecordResponse> </s:Body> </s:Envelope> |
Exemplo de alteração da disciplina.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> <IDGRUPOEQEQUIV>88</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>88</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>87</IDGRUPO> <NOME>MATEMÁTICA</NOME> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>146-1</CODDISC> <IDGRUPO>88</IDGRUPO> <NOME>ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</NOME> </SDISCGRUPOEQ> </EduEquivalencia>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:SaveRecord> </soapenv:Body> </soapenv:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <SaveRecordResponse xmlns="http://www.totvs.com/"> <SaveRecordResult>1;87;88</SaveRecordResult> </SaveRecordResponse> </s:Body> </s:Envelope> |
Caso a alteração seja realizada com sucesso, será mostrado o código da coligada, id. do grupo de disciplinas e id. do grupo de disciplinas equivalentes inserido no item SaveRecordResult. |
Caso seja necessário incluir mais uma disciplina do lado direito para forma um grupo de equivalência, segue exemplo.
Antes da alteração | Depois da alteração | ||
---|---|---|---|
Lado esquerdo | Lado direito | Lado esquerdo | Lado direito |
A002-1 | A012-1 | A002-1 | A012-1 |
146-1 |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <ReadRecordResponse xmlns="http://www.totvs.com/"> <ReadRecordResult><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>89</IDGRUPOEQ> <IDGRUPOEQEQUIV>90</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>89</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>90</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>89</IDGRUPO> <NOME>MATEMÁTICA</NOME> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>90</IDGRUPO> <NOME>ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</NOME> </SDISCGRUPOEQ> </EduEquivalencia>]]></ReadRecordResult> </ReadRecordResponse> </s:Body> </s:Envelope> |
Exemplo de alteração.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:SaveRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>89</IDGRUPOEQ> <IDGRUPOEQEQUIV>90</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>89</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>90</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>89</IDGRUPO> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>90</IDGRUPO> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>146-1</CODDISC> <IDGRUPO>90</IDGRUPO> </SDISCGRUPOEQ> </EduEquivalencia>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:SaveRecord> </soapenv:Body> </soapenv:Envelope> |
Este método realiza a exclusão de uma equivalência. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o id. do grupo de disciplinas e id. do grupo de disciplinas equivalentes.
O sistema irá realizar a exclusão de uma equivalência caso encontre o registro.
Para realizar exclusão de uma equivalência, deve ser utilizado a operação de DeleteRecord.
Deve ser passado um XML contendo todos os campos que fazem parte do registro de equivalência.
Segue exemplo de XML para exclusão.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:DeleteRecord> <!--Optional:--> <tot:DataServerName>EduEquivalenciaData</tot:DataServerName> <!--Optional:--> <tot:XML><![CDATA[<EduEquivalencia > <SEQUIVALENCIA> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> <IDGRUPOEQEQUIV>88</IDGRUPOEQEQUIV> <RECIPROCO>N</RECIPROCO> <CODTIPOCURSO>1</CODTIPOCURSO> </SEQUIVALENCIA> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>87</IDGRUPOEQ> </SGRUPOEQ> <SGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <IDGRUPOEQ>88</IDGRUPOEQ> </SGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A002-1</CODDISC> <IDGRUPO>87</IDGRUPO> <NOME>MATEMÁTICA</NOME> </SDISCGRUPOEQ> <SDISCGRUPOEQ> <CODCOLIGADA>1</CODCOLIGADA> <CODDISC>A012-1</CODDISC> <IDGRUPO>88</IDGRUPO> <NOME>ESTATÍSTICA APLICADA À ADMINISTRAÇÃO</NOME> </SDISCGRUPOEQ> </EduEquivalencia>]]></tot:XML> <!--Optional:--> <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1;CODSISTEMA=S</tot:Contexto> </tot:DeleteRecord> </soapenv:Body> </soapenv:Envelope> |
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <DeleteRecordResponse xmlns="http://www.totvs.com/"> <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult> </DeleteRecordResponse> </s:Body> </s:Envelope> |
Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService: |