Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Tip

O TCE/SC disponibiliza para os desenvolvedores/integradores de sistemas duas máquinas para uso do WSE, uma para desenvolvimento/testes e uma para produção (envios oficiais de dados). Segue o endereço:
• Desenvolvimento: https://esfingews.dev.tce.sc.gov.br/esfinge/services/

No endereço apresentado anteriormente estão os WSDL dos serviços disponíveis atualmente.

Com relação somente ao servidor de desenvolvimento, cabe destacar que:

...

Expand
titleServiço ArquivoFisico

Os serviços enviarArquivo são utilizados para envios, listagem e obtenção de arquivos ou documentos em geral (dados não estruturados). Enquadram-se nesta categoria os textos de legislação e atos jurídicos, como por exemplo os textos de: leis, editais de licitação, contratos, convênios, etc. São aceitos os formatos: txt, rtf, doc, docx, htm, html e pdf. Este serviço substitui o envio de documentos que no sistema e-Sfinge Desktop eram colocados na pasta “textos”. Cabe destacar que este serviço não recebe nem importa arquivos formatados (arquivos de dados) do sistema e-Sfinge Desktop. Para o envio de dados pelo WSE deve-se utilizar os serviços “enviar” descritos no título “Serviços para enviar assuntos”. Para se utilizar estes serviços e suas respectivas operações é necessário possuir um token válido na situação “Pronto para envio ou consulta”, independente da sua posição na fila.

Expand
titleOperação: enviarArquivo

Serviço utilizado para o envio de arquivos físicos, documentos em geral. Para acesso é necessário obter token, mas não é necessário finalizalo. Maiores detalhes no capítulo Serviço da fila virtual de acesso. Este serviço, diferentemente dos demais serviços de envio não permite múltiplos envios de dados. Somente um arquivo pode ser enviado por chamada. Outra diferença é que sempre que um arquivo for enviado com o mesmo nome para a mesma competência e unidade gestora este será sobrescrito. Este serviço limita o tamanho máximo de um arquivo em 26Mb (considerando o arquivo já convertido em base64) ou aproximadamente 20Mb do original (vinte megabytes). A seguir a definição da operação enviarArquivo:

Definição:

  • enviarArquivo (caracteres token, inteiro competencia, ArquivoFisico)

Parâmetros:

  • token: o token recebido no serviço obterToken.
  • Competência: competência bimestral no formato: AAAABB, onde:
    • AAAA = ano a ser enviado os dados
    • BB = bimestre de 01 até 06
  • ArquivoFisico:
    • nomeArquivo: Nome do arquivo a ser enviado; Maiores detalhes sobre nome do arquivo, verifique a definição do campo "Nome do Arquivo" do assunto "Arquivo Texto" no documento: Leiaute do arquivo intermediário – PCASP.
    • arquivo: o binário do arquivo em formato base64.


Code Block
languagexml
titleSolicitação (O cabeçalho “soapenv:Header” foi omitido para simplificação da documentação):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:arq="http://arquivofisico.ws.tce.sc.gov.br/">
 <soapenv:Header...
 <soapenv:Body>
 <arq:enviarArquivo>
 <chaveToken>a5041bcc-b0e9-4440-9d04-ca5aedab077d</chaveToken>
 <competencia>201401</competencia>
 <arquivoFisico>
 <nomeArquivo>asdasdas.txt</nomeArquivo>
 <arquivo>UGFyYWLDqW5zDQoNClZvY8OqDQoNCkRlY29kaWZpY291IA0KDQpPIA0KDQpBcnF1aXZvDQoNCjop</arquivo>
 </arquivoFisico>
 </arq:enviarArquivo>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta com sucesso:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:enviarArquivoResponse xmlns:ns2="http://arquivofisico.ws.tce.sc.gov.br/">
 <return>
 <dados/>
 <mensagem>Arquivo salvo com sucesso</mensagem>
 <status>Ok</status>
 </return>
 </ns2:enviarArquivoResponse>
 </soap:Body>
</soap:Envelope>


Code Block
languagexml
titleResposta com erro de validação:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:enviarArquivoResponse xmlns:ns2="http://arquivofisico.ws.tce.sc.gov.br/">
 <return>
 <dados>
 <entry>
 <key>MD5</key>
<value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">418051c3a07169a508da2168e9c5a2f6</value>
 </entry>
 </dados>
 <mensagem>Nome do arquivo inválido</mensagem>
 <status>ERRO</status>
 </return>
 </ns2:enviarArquivoResponse>
 </soap:Body>
</soap:Envelope>



Expand
titleOperação: listarArquivo

Serviço utilizado para listar os arquivos enviados em uma competência. A seguir a definição da operação listarArquivo:

Definição:

  • listarArquivo (caracteres token, inteiro competencia)

Parâmetros:

  • token: o token recebido no serviço obterToken.
  • Competência: competência bimestral no formato: AAAABB, onde:
    • AAAA = ano a ser enviado os dados
    • BB = bimestre de 01 até 06
Code Block
languagexml
titleSolicitação (O cabeçalho “soapenv:Header” foi omitido para simplificação da documentação):
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:arq="http://arquivofisico.ws.tce.sc.gov.br/">
 <soapenv:Header...
 <soapenv:Body>
 <arq:listarArquivo>
 <chaveToken>a5041bcc-b0e9-4440-9d04-ca5aedab077d</chaveToken>
 <competencia>201401</competencia>
 </arq:listarArquivo>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta com sucesso:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:listarArquivo xmlns:ns2="http://arquivofisico.ws.tce.sc.gov.br/">
 <return>
 <dados>
 <entry>
 <key>Arquivo 1</key>
 <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:registro">
 <registros>
 <campo>nome</campo>
<valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">asdasdas.txt</valor>
 </registros>
 <registros>
 <campo>data</campo>
<valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:dateTime">2015-05-01T12:00:00.040-03:00</valor>
 </registros>
 <registros>
 <campo>tamanho</campo>
<valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:long">57</valor>
 </registros>
<registros>
 <campo>MD5</campo>
<valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">418051c3a07169a508da2168e9c5a2f6</valor>
 </registros>
 </value>
 </entry>
 <entry>
 <key>TOTAL</key>
 <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:int">1</value>
 </entry>
 </dados>
 <mensagem> Consulta executada com sucesso com 1 resultado(s)</mensagem>
 <status>OK</status>
 </return>
 </ns2:listarArquivo>
 </soap:Body>
</soap:Envelope>


Code Block
languagexml
titleResposta arquivo inexistente:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
 <soap:Body>
 <ns2:downloadArquivo xmlns:ns2="http://arquivofisico.ws.tce.sc.gov.br/">
<return>
 <dados/>
 <mensagem>Não existe arquivo com nome asdasdas2.txt na competência 201501</mensagem>
 <status>ERRO</status>
 </return>
 </ns2:downloadArquivo>
 </soap:Body>
</soap:Envelope>