Visão Geral dos processos WebSevices de Avaliações

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de Avaliação da Etapa da Turma Disciplina através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de uma Avaliação no TOTVS Gestão Educacional.

Através do DataServer "EduprovasData" e por meio dos métodos ReadRecord, SaveRecord e DeleteRecord, é possível realizar busca, inclusão, manutenção e exclusão das informações das Avaliações no TOTVS Gestão Educacional.

Se necessário clique aqui para obter ajuda na configuração do Host.

Índice

Método ReadRecord

Este método realiza a consulta de uma Avaliação. Algumas informações são obrigatórias e devem ser informadas: o código da Coligada, o código da Turma Disciplina, o código da Etapa e o código da Prova.

O sistema irá realizar a consulta de uma Avaliação da Etapa da Turma Disciplina caso as informações passadas estejam de acordo com alguma Avaliação já existente no sistema.

Consulta de uma Avaliação

Para realizar a consulta de uma Avaliação, 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, o mesmo terá suas informações exibidas através de um XML.

O XML deve conter os campos CODCOLIGADA , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA como informações da chave para busca de Avaliação da Etapa da Turma Disciplina.

Exemplo de XML para consulta de uma Avaliação

	<tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>Eduprovasdata</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;4385;1;N;1</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODSISTEMA=S;CODUSUARIO=MESTRE</tot:Contexto>
      </tot:ReadRecord>

Exemplo do retorno de consulta de uma Avaliação

<ReadRecordResponse xmlns="http://www.totvs.com/">
         <ReadRecordResult><![CDATA[<EduProvas>
  <SProvas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
    <DESCRICAO>Prova</DESCRICAO>
    <VALOR>90</VALOR>
    <DTPREVISTA>2018-05-03T00:00:00</DTPREVISTA>
    <DTPROVA>2018-05-03T00:00:00</DTPROVA>
    <MEDIA>50</MEDIA>
    <CODPROVATESTIS>1</CODPROVATESTIS>
    <DESCETAPA>Notas</DESCETAPA>
    <PERMITEENTREGAWEB>N</PERMITEENTREGAWEB>
    <DISPONIVELALUNOS>S</DISPONIVELALUNOS>
    <DISPTODASSUBTURMAS>N</DISPTODASSUBTURMAS>
  </SProvas>
  <SProvasCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
  </SProvasCompl>
</EduProvas>]]></ReadRecordResult>

Exemplo do retorno sem registros

<ReadRecordResult>&lt;EduprovasData /></ReadRecordResult>

Método SaveRecord

Este método realiza a inclusão ou alteração de uma Avaliação da Etapa da Turma Disciplina. Algumas informações são obrigatórias e devem ser informadas: o código da Coligada, o código da Turma Disciplina, o código da Etapa e o código da Prova, além dos outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a inclusão de uma Avaliação, caso o código informado não exista na base.

Se o código da Avaliação 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 a Avaliação que se deseja alterar.

Inclusão de uma Avaliação da Etapa da Turma Disciplina

Para realizar inclusão de um Avaliação, 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 Avaliação.

Caso o código da Avaliação informado não exista, será incluído uma nova Avaliação. Caso contrário, o mesmo terá suas informações atualizadas.

O XML deve conter a tabela SPROVAS com os campos CODCOLIGADA , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA como informações da chave para o cadastro da Avaliação da Etapa da Turma Disciplina, também os campos obrigatórios para seu cadastro.

Exemplo de XML para inclusão de uma Avaliação

       <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>Eduprovasdata</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduProvas>
  <SProvas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>5</CODPROVA>
    <DESCRICAO>Prova</DESCRICAO>
    <VALOR>90</VALOR>
    <DTPREVISTA>2018-05-03T00:00:00</DTPREVISTA>
    <DTPROVA>2018-05-03T00:00:00</DTPROVA>
    <MEDIA>50</MEDIA>
    <CODPROVATESTIS>1</CODPROVATESTIS>
    <DESCETAPA>Notas</DESCETAPA>
    <PERMITEENTREGAWEB>N</PERMITEENTREGAWEB>
    <DISPONIVELALUNOS>S</DISPONIVELALUNOS>
    <DISPTODASSUBTURMAS>N</DISPTODASSUBTURMAS>
  </SProvas>
  <SProvasCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>5</CODPROVA>
  </SProvasCompl>
</EduProvas>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODSISTEMA=S;CODUSUARIO=MESTRE;CODTIPOCURSO=1;CODFILIAL=1</tot:Contexto>
      </tot:SaveRecord>

Exemplo do retorno da inclusão de uma Avaliação

<SaveRecordResult>1;4385;1;N;5</SaveRecordResult>

Caso a inclusão seja realizada com sucesso, será mostrado o código da coligada, o código da Turma Disciplina, o código da Etapa, tipo da Etapa e o código da Prova da Avaliação inserido no item SaveRecordResult.

Alteração de uma Avaliação

Para realizar alteração de uma Avaliação, deve ser utilizado a operação de SaveRecord.

Deve ser passado um XML contendo todos os campos que serão atualizados no cadastro de Avalição;

O XML deve conter a tabela SPROVAS com os campos CODCOLIGADA , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA como informações da chave para a atualização do cadastro de uma avaliação.

Exemplo de XML para alteração de informações de uma Avaliação

 <tot:SaveRecord>
         <!--Optional:-->
         <tot:DataServerName>Eduprovasdata</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduProvas>
  <SProvas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>5</CODPROVA>
    <DESCRICAO>Prova</DESCRICAO>
    <VALOR>100</VALOR>
    <DTPREVISTA>2018-05-03T00:00:00</DTPREVISTA>
    <DTPROVA>2018-05-03T00:00:00</DTPROVA>
    <MEDIA>50</MEDIA>
    <CODPROVATESTIS>1</CODPROVATESTIS>
    <DESCETAPA>Notas</DESCETAPA>
    <PERMITEENTREGAWEB>N</PERMITEENTREGAWEB>
    <DISPONIVELALUNOS>S</DISPONIVELALUNOS>
    <DISPTODASSUBTURMAS>N</DISPTODASSUBTURMAS>
  </SProvas>
  <SProvasCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4385</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>5</CODPROVA>
  </SProvasCompl>
</EduProvas>]]></tot:XML>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODSISTEMA=S;CODUSUARIO=MESTRE;CODTIPOCURSO=1;CODFILIAL=1</tot:Contexto>
      </tot:SaveRecord>

Exemplo do retorno da alteração de uma Avaliação

<SaveRecordResult>1;4385;1;N;1</SaveRecordResult>

Caso a alteração seja realizada com sucesso, será mostrado o código da coligada e o código no item SaveRecordResult.

Método DeleteRecord

Este método realiza a exclusão de uma Avaliação. Algumas informações são obrigatórias e devem ser informadas: o código da coligada, o código da Turma Disciplina, o código da Etapa, tipo da Etapa e o código da Prova da Avaliação e os outros campos que estão configurados como obrigatórios no sistema.

O sistema irá realizar a exclusão da Avaliação caso encontre o registro.

Exclusão da Avaliação

Para realizar exclusão de uma Avaliação, deve ser utilizado a operação de DeleteRecord.

Deve ser passado um XML contendo todos os campos que fazem parte do registro de uma Avaliação.

O XML deve conter a tabela SPROVAS com os campos CODCOLIGADA , IDTURMADISC, CODETAPA, TIPOETAPA e CODPROVA como informações da chave para a atualização do cadastro de avaliação.

Exemplo de XML para exclusão de uma Avaliação

		<tot:DeleteRecord>
         <!--Optional:-->
         <tot:DataServerName>EduprovasData</tot:DataServerName>
         <!--Optional:-->
         <tot:XML><![CDATA[<EduProvas>
  <SProvas>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4390</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
    <DESCRICAO>Avaliação</DESCRICAO>
    <VALOR>100</VALOR>
    <MEDIA>70</MEDIA>
    <DESCETAPA>Notas</DESCETAPA>
    <PERMITEENTREGAWEB>N</PERMITEENTREGAWEB>
    <DISPONIVELALUNOS>N</DISPONIVELALUNOS>
    <DISPTODASSUBTURMAS>N</DISPTODASSUBTURMAS>
  </SProvas>
  <SProvasCompl>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDTURMADISC>4390</IDTURMADISC>
    <CODETAPA>1</CODETAPA>
    <TIPOETAPA>N</TIPOETAPA>
    <CODPROVA>1</CODPROVA>
  </SProvasCompl>
</EduProvas>]]>

Exemplo do retorno de exclusão de uma Avaliação

 <DeleteRecordResult>Exclusão de registro(s) realizado com sucesso</DeleteRecordResult>

Para mais informações segue o link da documentação padrão de uso de DataServers utilizando WebService:

http://tdn.totvs.com/x/XYlpCw

Atalhos

Páginas filhas