Visão Geral dos processos

...

WebServices dos Documentos do Fiador

O objetivo deste DataServer é possibilitar a busca, inclusão, alteração e exclusão de dos documentos do fiador através de WebService. Tudo o que for realizado, poderá ser visualizado no cadastro de documentos do fiador no TOTVS Gestão Educacional.

Através do dataserver "EduDocFiadorData" 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 do dos documentos do fiador no TOTVS Gestão Educacional.

...

O sistema irá realizar a consulta de do documento do fiador, caso as informações passadas estejam de acordo com algum documento do fiador já existente no sistema.

Consulta

...

do documento do fiador

Para realizar a consulta de um documento do fiador, deve ser utilizado a operação de ReadRecord.

...

O XML deve conter os campos CODCOLIGADA e IDDOCFIADOR como informações da chave para busca do documento do fiador.

      <tot:ReadRecord>
         <!--Optional:-->
         <tot:DataServerName>EduDocFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:PrimaryKey>1;35</tot:PrimaryKey>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadRecord> 

...

Consulta os documentos do fiador

Para realizar a consulta de um documento os documentos do fiador, deve ser utilizado a operação de ReadView.

...

O XML deve conter os campos CODCOLIGADA e IDFIADOR da tabela SDOCFIADOR como informações da chave para busca os dos documentos do fiador.

  <tot:ReadView>
         <!--Optional:-->
         <tot:DataServerName>EduDocFiadorData</tot:DataServerName>
         <!--Optional:-->
         <tot:Filtro>SDOCFIADOR.CODCOLIGADA=1 AND SDOCFIADOR.IDFIADOR=34</tot:Filtro>
         <!--Optional:-->
         <tot:Contexto>CODCOLIGADA=1;CODFILIAL=1;CODTIPOCURSO=1</tot:Contexto>
      </tot:ReadView>

       <ReadViewResult><![CDATA[<NewDataSet>
  <SDOCFIADOR>
    <CODCOLIGADA>1</CODCOLIGADA>
    <IDDOCFIADOR>35</IDDOCFIADOR>
    <IDFIADOR>34</IDFIADOR>
    <CODDOCUMENTO>2</CODDOCUMENTO>
    <DTENTREGA>2021-10-27T00:00:00</DTENTREGA>
    <RECCREATEDBY>mestre</RECCREATEDBY>
    <RECCREATEDON>2023-04-03T10:11:47</RECCREATEDON>
    <RECMODIFIEDBY>mestre</RECMODIFIEDBY>
    <RECMODIFIEDON>2023-04-03T10:11:47</RECMODIFIEDON>
    <DESCRICAO>Histórico Escolar</DESCRICAO>
    <STATUS>0</STATUS>
  </SDOCFIADOR>
</NewDataSet>]]></ReadViewResult>
      </ReadViewResponse>

...

O sistema irá realizar a inclusão de um documento do fiador, caso o código do documento do fiador informado no XML não exista no sistemaseja igual a zero. O valor do código do documento do fiador presente no XML serve apenas para identificar o documento do fiador dentro do próprio XML. O sistema irá criar um código para o documento do fiador inserido.

Se o código do documento do fiador existir na coligada informada, essa terá as informações alteradas de acordo com o que será passado no arquivo XML.

Observação: 

• O No campo Status só pode receber um dos valores 0 - Não Entregue, 1 - Entregue Em Validação, 2 - Recusado, e 3 - Validado
• O No campo Arquivo deverá ser informado o arquivo do documento do fiador no formato base64.

Inclusão

...

do documento do fiador

Para realizar inclusão de um documento do fiador, deve ser utilizado a operação de SaveRecord.

...

O XML deve conter a tabela SDOCFIADOR com os campos CODCOLIGADA e IDDOCFIADOR como informações da chave para a atualização do cadastro do documento do fiador.

Observação: 

• O No campo IdMotivoRejeicaoDocumento deverá ser informado o código do motivo de rejeição do documento cadastrado no cadastro de "Motivo de Rejeição do Documento" no menu Currículo e Oferta → Acadêmico → Auxiliares → Motivo de Rejeição do Documento
• O No campo OBS deverá ser informado uma observação referente à rejeição do documento.
• O No campo MotivoRejeicaoDocumento não precisa ser informado, pois esse campo é a descrição do IdMotivoRejeicaoDocumento informado.

...