Web Service para desenvolvimento/testes
Former user (Deleted)
LUCAS GODAY
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:
- Os dados (banco de dados) são geralmente atualizados com os dados de produção (dados oficiais) todos os finais de semana.
- Nem todos os serviços desta máquina estão em produção. Isso ocorre, pois, alguns serviços novos, durante o processo de desenvolvimento somente estarão disponíveis em produção no ano seguinte.
- Todos os assuntos com o sufixo _alpha não foram homologados pelo TCE/SC, server como uma referência inicial, podem sofrer modificações até sua versão final.
Por segurança o WSE só permite conexões HTTPS. Os serviços são compostos de um ou várias operações. As operações implementadas seguem uma mesma regra de formação. Todos tem um cabeçalho (header) de segurança (autenticação) e retorno dos métodos sempre será um “responseTCEWS”. No header será passado o usuário (wsse:Username) e a senha (wsse:Password). Este usuário e senha será criado no sistema e-Sfinge Web, como qualquer outro usuário, mas deve possuir o perfil: “WS e-Sfinge”. Um usuário poderá possuir outros perfis, mas somente será considerado no WSE o perfil: “WS e-Sfinge”. Segue um exemplo do header:
<soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401- wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken> <wsse:Username>USUARIO</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-tokenprofile-1.0#PasswordText">SENHA</wsse:Password> </wsse:UsernameToken> </wsse:Security>
O Response TCEWS, resposta das operações, é composto de três campos: status, mensagem e dados. O status, retorna uma situação (ERRO ou OK). O OK significa que o serviço foi executado com
sucesso. O ERRO significa que a operação não pode ser executada com sucesso. A mensagem é um descritivo do resultado da operação, sendo com status ERRO ou OK.
O dados pode variar conforme o serviço e sua operação. Este é o retorno efetivo das informações solicitadas. Este campo é um mapa composto por uma chave (key) e elemento de resposta (value). O
elemento de resposta pode ser um elemento simples ou complexo. Simples são elementos como inteiro, data ou sequência de caracteres. Complexo pode ser um vetor de elementos ou um outro mapa. O tipo de cada elemento de resposta é definido no “xsi:type”.
Um caso particular, é são os serviço do tipo “enviar“. O sistema retornará status OK se conseguir receber os dados e processá-los, mesmo que o resultado dos elementos a serem inseridos retorne erro. Neste caso o erro individual dos registros retornará no campo dados.
Exemplo de resposta da operação obterNovoToken com erro:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:obterTokenResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados></dados> <mensagem>Dados não compactados. Deve-se usar compactação (gzip) ao usar o WebService. Header enviado:...</mensagem> <status>ERRO</status> </return> </ns2:obterTokenResponse> </soap:Body> </soap:Envelope>
O WSE exige o envio de dados com compressão, GZIP. Isso permitirá maior agilidade no envio de informações além de grande economia de rede. O envio de dados compactados é obrigatório desde 28/08/2015. Caso qualquer chamada do WSE não use compactação, retornará o erro demostrado a seguir:
<soap:Body> <ns2:obterTokenResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados></dados> <mensagem>Dados não compactados. Deve-se usar compactação (gzip) ao usar o WebService. Header enviado:...</mensagem> <status>ERRO</status> </return> </ns2:obterTokenResponse> </soap:Body> </soap:Envelope>
Recomendamos que todas as chamadas sejam enviadas com os parâmetros: “Content-Length” (tamanho do “pacote”) e “user-agent” (definição da plataforma usada no envio do WS) no cabeçalho HTTP.
Para todas as operações do WSE todos os campos (parâmetros) são obrigatórios, salvo quando a definição da operação ou do assunto permita que este seja opcional. Para atributos opcionais ou
condicionais (obrigatório dependendo do contexto), não devem ser enviados com valor nulo, e sim não criem a TAG no XML. Seguem exemplo da forma correta e errada de serem enviados atributos opcionais/ condicionais sem valor:
Forma CORRETA de envio de um atributo opcional com valor: <assunto><attr>XX</attr><attrOpcional>XX</attrOpcional></assunto> Forma CORRETA de envio de um atributo opcional sem valor: <assunto><attr></attr></assunto> Formas ERRADAS de envio de um atributo opcional sem valor: <assunto><attr>XX</attr><attrOpcional></attrOpcional></assunto> Ou <assunto><attr>XX</attr><attrOpcional/></assunto>
Cada solicitação enviada via Web Service ao TCE deve-se preencher os elementos com as seguintes regras:
Valores Financeiros – deverão ser preenchidos com caracteres ISO-8859-1 numéricos e ponto para posição decimal. Ex.: Para informar R$ 1.510,15 deve ser preenchido como 1510.15
Valores Percentuais – deverão ser preenchidos com caracteres ISO-8859-1 numéricos e ponto para posição decimal. Ex.: Para informar 15% deve ser preenchido como 15.00
Quantidades – deverão ser preenchidas com caracteres ISO-8859-1 numéricos e ponto para posição de milésimos. Ex.: Para informar 184,3251 deve ser preenchido como 184.3251
Valores Inteiros – deverão ser preenchidos com caracteres ISO-8859-1 numéricos. Não admite ponto decimal. Ex.: Para informar 120 deve ser preenchido como 120
Valores Lógicos – são campos com uma posição e representam indicação de conformidade ou negação. Tais campos assumem somente os valores “S” ou “N” (Sim ou Não) usando a codificação ISO-8859-1.
Dados carácter – deverão ser preenchidos com caracteres ISO-8859-1 letras, números e símbolos.
Para executar algumas operações haverá a necessidade de entrar em uma fila virtual de acesso. Esta fila foi criada para evitar que determinado usuário use os recursos do TCE impedindo que outros usuários o façam. O usuário (sistema que usa o Web Service) receberá um token (uma string com 36 caracteres aleatórios) e se for necessário de tempos em tempos verificará se chegou a sua vez. O token também representará uma sessão de trabalho ou de envio de dados ao TCE. Esta sessão possui um tempo de expiração (time out) de 360 segundos. Cada nova chamada do Web Service reiniciará o contador de time out. Caso ocorra um time out de token e se este teve elementos inseridos associados a ele, estes elementos serão removidos, se for o caso. Isso equivalerá a chamada da operação cancelarTransferencia (descrita na sequência deste documento), no caso dos serviços de envio de informações ao TCE. Um token após usado que ocorreu um time out não poderá ser reaproveitado e deverá ser descartado, independente da sua situação final. É permite somente um token ativo por unidade gestora. Só será permitido a solicitação de um novo token se o anterior estiver com uma situação “inativo”. Cada novo envio/consulta deve-se solicitar um novo token.
Os serviços que usam a fila virtual estão divididos em dois grupos. O primeiro grupo, serviços enviar assuntos, necessitam de uma confirmação após o envio. Ou seja, deve-se executar a operação cancelarTransferencia ou finalizarTransferencia após a transferência dos dados. A seguir as situações (status) que um token pode estar, para os serviços enviar assuntos.
O Segundo grupo são as operações operação listar de cada serviço (assunto), Consultar operação listar e para o serviço ArquivoFisico operação enviarArquivo. Para estas operações, depois do envio ou consulta finalizada não deve-se executar o iniciarTransferencia, cancelarTransferencia ou finalizarTransferencia. O token será finalizado após o envio da consulta ser respondida a unidade, ou seja sua situação será modificada automaticamente para a situação inativo – “Finalizado”. A seguir as situações (status) que um token pode estar, para os serviços: Consultar operação listar e para o ArquivoFisico operação enviarArquivo.
Para os dois grupos, se um token não chegou em seu status final poderá ser cancelado usando a operação cancelarTransferencia ou esperar que ocorra o timeout. Um caso típico para isso é quando uma token é obtido com sucesso mas ao longo de seu ciclo de vida ocorre algum problema na execução das demais operações. Neste caso o token não será automaticamente removido depois da operação que resultou em erro. O desenvolvedor deverá utilizar a operação “cancelarTransferencia” ou esperar o timeout do token. Esta regra vale para os dois grupos de assuntos. Considera-se uma
execução com erro se o campo “status” retornar “ERRO” ou não retornar este campo (por exemplo quando ocorra um problema de formatação do XML).
Ou seja, o sistema somente avançará ou permitirá avançar para a próxima situação se a tag “status” retornar “OK”. Segue um exemplo de retorno de status ERRO e um com erro na formatação do XML, dois casos que o token não será cancelado.
<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>O conteúdo do arquivo a.pdf não corresponde a extensão, favor conferir se o arquivo foi gerado corretamente.</mensagem> *** <status>ERRO</status> *** </return> </ns2:enviarArquivoResponse> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <soap:Fault> <faultcode>soap:Client</faultcode> <faultstring>Problems creating SAAJ object model</faultstring> </soap:Fault> </soap:Body> </soap:Envelope>
<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>...<dados/> <mensagem>Arquivo salvo com sucesso</mensagem> ***<status>OK</status>*** </return> </ns2:enviarArquivoResponse> </soap:Body> </soap:Envelope>
Retorna um token para a unidade gestora poder usar o serviço do TCE. Permite somente um token por unidade gestora.
Definição:
- obterToken(inteiro codigoUnidadeGestora, string descricaoEmpresaTI, string descritivoSoftware)
Parâmetros:
- codigoUnidadeGestora: código da Unidade Gestora conforme serviço listar da tabela unidades gestoras.
- descricaoEmpresaTI: nome da Empresa de TI responsável pela integração*
- descritivoSoftware: nome do Software utilizado para integração*
Resposta (campos dados):
- posicao: posição atual do seu token na fila
- situacao: situação do token
- chaveToken: o token em si, deverá ser usado nos demais serviços
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken> <wsse:Username>USUARIO</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">SENHA</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <tok:obterToken> <codigoUg>10006</codigoUg> <descricaoEmpresaTI>Empresa</descricaoEmpresaTI> <descritivoSoftware>Software</descritivoSoftware> </tok:obterToken> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:obterTokenResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>chaveToken</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</value> </entry> <entry> <key>posicao</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2</value> </entry> <entry> <key>situacao</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pronto para envio ou consulta</value> </entry> </dados> <mensagem>Token criado com sucesso</mensagem> <status>OK</status> </return> </ns2:obterTokenResponse> </soap:Body> </soap:Envelope>
Retorna a situação do token passado como parâmetro. Para evitar solicitações indefinidas a este serviço o sistema punirá com a remoção do token da fila sempre que for feita duas chamadas seguidas do serviço obterSituacaoToken em menos de cinco segundos.
Definição:
- obterSituacaoToken(caracteres token)
Parâmetros:
- token: o token recebido no serviço obterToken.
Resposta (campos dados):
- posicao: posição atual do seu token na fila
- situacao: situação do token
Exemplo
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/"> <soapenv:Header… <soapenv:Body> <tok:obterSituacaoToken> <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token> </tok:obterSituacaoToken> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:obterSituacaoTokenResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>posicao</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value> </entry> <entry> <key>situacao</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pronto para envio ou consulta</value> </entry> </dados> <mensagem>Situação token obtida com sucesso</mensagem> <status>OK</status> </return> </ns2:obterSituacaoTokenResponse> </soap:Body> </soap:Envelope>
Antes de iniciar a transferência dos dados propriamente dita será necessário executar o serviço iniciarTransferencia.
Definição:
- iniciarTransferencia (caracteres token)
Parâmetros:
- token: o token recebido no serviço obterToken.
Resposta (campos dados): vazio, não retorna valores.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <tok:iniciarTransferencia> <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token> </tok:iniciarTransferencia> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:iniciarTransferenciaResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados/> <mensagem>Início de transferência liberado</mensagem> <status>OK</status> </return> </ns2:iniciarTransferenciaResponse> </soap:Body> </soap:Envelope>
Ao final da transferência caso queria remover todos os elementos inseridos nesta sessão, ou seja todos os elementos ligados a determinado token passado para o serviço. Uma vez executado este serviço o token atual será descartado.
Definição:
- cancelarTransferencia (caracteres token)
Parâmetros:
- token: o token recebido no serviço obterToken.
Resposta (campos dados): vazio, não retorna valores.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <tok:cancelarTransferencia> <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token> </tok:cancelarTransferencia> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:cancelarTransferenciaResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados/> <mensagem>Cancelada com sucesso</mensagem> <status>OK</status> </return> </ns2:cancelarTransferenciaResponse> </soap:Body> </soap:Envelope>
Ao final da transferência caso queria confirmar todos os elementos inseridos (que não retornaram erro) nesta sessão, ou seja todos os elementos ligados a determinado token passado para o serviço. Uma vez executado este serviço o token atual será descartado.
Definição:
- finalizarTransferencia (caracteres token)
Parâmetros:
- token: o token recebido no serviço obterToken.
Resposta (campos dados): vazio, não retorna valores.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tok="http://token.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <tok:finalizarTransferencia> <token>d95a313b-4ba9-49b1-aca0-53c1f1bd16a4</token> </tok:finalizarTransferencia> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:finalizarTransferenciaResponse xmlns:ns2="http://token.ws.tce.sc.gov.br/"> <return> <dados/> <mensagem>Finalizada com sucesso</mensagem> <status>OK</status> </return> </ns2:finalizarTransferenciaResponse> </soap:Body> </soap:Envelope>
Os serviços enviar são utilizados para enviar informações (dados estruturados) ao TCE. Este serviço substitui o envio de arquivos “.txt” estruturados do sistema e-Sfinge Desktop, que eram colocados na pasta “dados”. Para se utilizar estes serviços é necessário possuir um token válido na situação “Pronto para envio ou consulta”, independente da sua posição na fila.
Para todos os assuntos a serem enviados existirá um serviço específico. Cada serviço ligado a um assunto, haverá uma operação genérica enviar. A operação enviar deve ser executada após a operação iniciarTransferencia. Ao final da operação envio, estarão presentes todos os elementos que não retornaram erro no nosso banco de dados. Para confirmar o envio dos dados deve-se usar uma das operações para cancelar (cancelarTransferencia) ou confirmar (finalizarTransferenciao) envio. Se não for chamado uma destas operações, após o tempo de time out, o sistema cancelará todo o envio (equivale a chamar a operação cancelarTransferencia).
Além dos dados normais, ligados ao assunto a ser enviado, o utilizador do WSE obrigatoriamente deverá enviar um parâmetro para servir de identificação do retorno (idRetorno). Este campo deverá ter um valor diferente para cada registro dentro de uma mesma chamada do enviar. Se na mesma chamada forem enviados idRetorno iguais o sistema retornará erro de idRetorno duplicado. O idRetorno não será armazenado pelo TCE, servindo apenas de referência para o cliente do WS poder identificar qual o resultado de cada elemento enviado.
Cada chamada da operação “enviar” é limitado a 5000 registros (registros = N informações de somente um assunto). Porem dependendo da velocidade da rede e do uso no momento do envio, pode ser necessário reduzir este valor para evitar timeouts. Em geral uma redução para 2000 registros por envio já resolve o problema.
A seguir a definição da operação enviar:
Definição:
- enviar (caracteres token, inteiro competencia, Vetor de assuntos*)
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 - Vetor de assuntos:
• idRetorno:
• <Campos específicos do assunto>: a definição dos assuntos, dos campos e as regras de validação estão no documento: Leiaute do arquivo intermediário – PCASP.
Resposta (campos dados):
- Lista de pares de elementos na forma idResposta e resultado do processamento do registro.
Exemplo envio do assunto lançamento contábil plano único:
Definição:
- enviar (caracteres token, inteiro competencia, Vetor de Lançamentos Contábeis Plano Único*)
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 - Vetor de Lançamentos Contábeis Plano Único:
• idRetorno:
• <Campos específicos dos Lançamentos Contábeis Plano Único>: a definição dos campos e as regras de validação está no documento: Leiaute do arquivo intermediário – PCASP.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lan="http://lanccontpu.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <lan:enviar> <token>79aad05f-f9f9-42c1-a8a8-e24f95de0d9c</token> <competencia>201401</competencia> <lancamentos> <lancContPU> <idRetorno>0</idRetorno> <numeroControle>1</numeroControle> <numeroSequencial>1</numeroSequencial> <dataLancamento>2014-06-02</dataLancamento> <codigoContaContabil>212130100</codigoContaContabil> <contaCorrenteContabil>06710122905</contaCorrenteContabil> <tipoLancamento>1</tipoLancamento> <tipoMovimentoContabil>2</tipoMovimentoContabil> <historicoLancamento>histosoap</historicoLancamento> <valorLancamento>555.55</valorLancamento> <indicativoEstornoLancamento>S</indicativoEstornoLancamento> <attrSuperavitFinanc>P</attrSuperavitFinanc> <mensagemProcessamento>vazia</mensagemProcessamento> <codigoProcessamento></codigoProcessamento> </lancContPU> <lancContPU> <idRetorno>1</idRetorno> <numeroControle>1</numeroControle> <numeroSequencial>1</numeroSequencial> <dataLancamento>2010-06-02</dataLancamento> <codigoContaContabil>212130100</codigoContaContabil> <contaCorrenteContabil>06710122905</contaCorrenteContabil> <tipoLancamento>1</tipoLancamento> <tipoMovimentoContabil>2</tipoMovimentoContabil> <historicoLancamento>histosoap</historicoLancamento> <valorLancamento>555.55</valorLancamento> <indicativoEstornoLancamento>S</indicativoEstornoLancamento> <attrSuperavitFinanc>P</attrSuperavitFinanc> <mensagemProcessamento>vazia</mensagemProcessamento> <codigoProcessamento></codigoProcessamento> </lancContPU> </lancamentos> </lan:enviar> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:enviarResponse xmlns:ns2="http://lanccontpu.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>0</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:codigoMensagem"> <codigo>0</codigo> <mensagem>OK</mensagem> </value> </entry> <entry> <key>1</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:codigoMensagem"> <codigo>1</codigo> <mensagem>OK</mensagem> </value> </entry> </dados> <mensagem>LANCAMENTO_CONTABIL_PU processado com sucesso</mensagem> <status>OK</status> </return> </ns2:enviarResponse> </soap:Body> </soap:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:enviarResponse xmlns:ns2="http://lanccontpu.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>0</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:codigoMensagem"> <codigo>2012019</codigo> <mensagem>Número de Controle já utilizado em outra data</mensagem> </value> </entry> <entry> <key>1</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:codigoMensagem"> <codigo>20351</codigo> <mensagem>Data do lançamento deve estar no período atual da competência</mensagem> </value> </entry> </dados> <mensagem>LANCAMENTO_CONTABIL_PU processado com sucesso</mensagem> <status>OK</status> </return> </ns2:enviarResponse> </soap:Body> </soap:Envelope>
Vale destacar que neste exemplo, mesmo a tag ‘status’ sendo ‘OK’ os dois registros enviados não foram processados de forma correta. Ou seja, o processamento do pacote foi com status OK dados recebidos com sucesso), porem o processamento dos registros foi com falha, tag “código” diferente de 0 e tag ‘mensagem‘ diferente de ‘OK’.
Os serviços listar são utilizados para listar as informações enviadas ao TCE. Para se utilizar estes serviços é necessário possuir um token válido na situação “Pronto para envio ou consulta”.
Para todo o assunto a ser listado existirá um serviço específico. Cada serviço ligado a um assunto, haverá uma operação genérica listar.
Definição:
- listar (inteiro codigoUg, caracteres token, inteiro competencia, inteiro pagina, Vetor de item filtros)
Parâmetros:
- codigoUg: código da Unidade Gestora para listar as informações.
- 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 - Pagina : numero da pagina(na primeira execução sempre usar 1)
- vetor de filtros: permitirá que o retorno traga somente elementos que casarem com o filtro definido. Caso seja enviado vazio neste campo trará todos os dados de determinada competência x unidade gestora (campo opcional). Esta funcionalidade está desabilitada nesta versão do sistema.
Resposta (campos dados):
- Lista de assuntos.
Exemplo listar do assunto lançamento contábil plano único:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lan="http://lanccontpu.ws.tce.sc.gov.br/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken> <wsse:Username>WS42_lucas</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile1.0#PasswordText">123456</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <lan:listar> <codigoUg>10472</codigoUg> <chaveToken>7801a3df-7998-4490-aef9-dfa48ab033ec</chaveToken> <competencia>201401</competencia> <PAGINA>1</PAGINA> </lan:listar> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarResponse xmlns:ns2="http://lanccontpu.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>0</key> <value xsi:type="ns2:lancamentoContabilPU" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <codigoContaContabil>222910200</codigoContaContabil> <contaCorrenteContabil/> <dataLancamento>2014-01-10</dataLancamento> <historicoLancamento>historico</historicoLancamento> <indicativoEstornoLancamento>S</indicativoEstornoLancamento> <numeroControle>55555</numeroControle> <numeroSequencial>102</numeroSequencial> <tipoLancamento>1</tipoLancamento> <tipoMovimentoContabil>1</tipoMovimentoContabil> <valorLancamento>555.55</valorLancamento> </value> </entry> <entry> <key>1</key> <value xsi:type="ns2:lancamentoContabilPU" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <codigoContaContabil>111110100</codigoContaContabil> <contaCorrenteContabil>432423232</contaCorrenteContabil> <dataLancamento>2014-01-10</dataLancamento> <historicoLancamento>historico</historicoLancamento> <indicativoEstornoLancamento>N</indicativoEstornoLancamento> <numeroControle>2</numeroControle> <numeroSequencial>1</numeroSequencial> <tipoLancamento>1</tipoLancamento> <tipoMovimentoContabil>1</tipoMovimentoContabil> <valorLancamento>100.00</valorLancamento> </value> </entry> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2</value> </entry> <entry> <key>PAGINA</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value> </entry> <entry> <key>QUANTIDADE_PAGINAS</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</value> </entry> </dados> <mensagem>Consulta executada com sucesso com 2 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarResponse> </soap:Body> </soap:Envelope>
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.
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.
<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>
<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>
<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>
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
<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>
<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>
<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>
Serviço utilizado para fazer o downlaod (obtenção) de um arquivo enviado em uma competência. A seguir a definição da operação downloadArquivo:
Definição:
- downloadArquivo (caracteres token, inteiro competência, caracteres nomeArquivo)
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 - nomeArquivo: Nome do arquivo a ser obtido (downlaod).
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:arq="http://arquivofisico.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <arq:downloadArquivo> <chaveToken>a5041bcc-b0e9-4440-9d04-ca5aedab077d</chaveToken> <competencia>201401</competencia> <nomeArquivo>asdasdas.txt</nomeArquivo> </arq:downloadArquivo> </soapenv:Body> </soapenv:Envelope>
<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> <entry> <key>asdasdas.txt</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:arquivoFisico"> <arquivo>UGFyYWLDqW5zDQoNClZvY8OqDQoNCkRlY29kaWZpY291IA0KDQpPIA0KDQpBcnF1aXZvDQoNCjop</arquivo> <nomeArquivo>asdasdas.txt</nomeArquivo> </value> </entry> </dados> <mensagem> Download executado com sucesso</mensagem> <status>OK</status> </return> </ns2:downloadArquivo> </soap:Body> </soap:Envelope>
<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>
Serviço competência, com sua operação getCompetenciaCorrrente retorna a última competência existente no sistema e-Sfinge independentemente da sua situação. O serviço retornará três informações, o código da situação da unidade, a descrição da situação da unidade e a última competência existente no TCE.
Definição:
- String getCompetenciaCorrrente(inteiro codigoUnidadeGestora)
Parâmetros:
- codigoUnidadeGestora: código da Unidade Gestora para se obter a competência.
Resposta (campos dados):
- codigo: código da situação da última competência recebida pelo TCE.
- descricao: descrição da situação da última competência recebida pelo TCE.
- descartePendente: indica se para esta unidade há descarte de remessa pendente. Se ‘S’ não poderá ser enviado dados ao TCE.
- competencia: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser enviado os dados
• BB = bimestre de 01 até 06
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://competencia.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <com:obterCompetencia> <codigoUg>10006</codigoUg> </com:obterCompetencia> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:obterCompetenciaResponse xmlns:ns2="http://competencia.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>descartePendente</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">N</value> </entry> <entry> <key>codigo</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">13</value> </entry> <entry> <key>descricao</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">Remessa confirmada</value> </entry> <entry> <key>competencia</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">201401</value> </entry> </dados> <mensagem>Competência recuperada com sucesso</mensagem> <status>OK</status> </return> </ns2:obterCompetenciaResponse> </soap:Body> </soap:Envelope>
Permite listar elementos de tabelas de constantes de definidas pelo TCE. Este serviço requer um token na situação “Pronto para envio ou consulta”. Não lista os assuntos enviados, os mesmos devem ser obtidos no listar do ws do assunto específico.
Definição:
- listar (caracteres token, inteiro codigoUnidadeGestora, inteiro competencia, inteiro identificadorTabela, vetor de filtros, inteiro pagina)
Parâmetros:
- token: o token recebido no serviço obterToken.
- codigoUnidadeGestora: código da Unidade Gestora para listar as informações, opcional para consultas de unidade gestora.
- competencia: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser enviado os dados
• BB = bimestre de 01 até 06 - identificadorTabela: identificador (campo value) do assunto que se deseja listar, conforme tabela devolvida pelo serviço: listarTabelasDisponiveis.
- vetor de filtros: permitirá que o retorno traga somente elementos que casarem com o filtro definido. Caso seja enviado vazio neste campo trará todos os dados de determinada competência x unidade gestora (campo opcional). Esta funcionalidade está desabilitada nesta versão do sistema.
- pagina : número da página referente a paginação dos resultados que se deseja consultar
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- pagina : página que foi requisita
- quantidade_paginas : quantidade de páginas disponíveis
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• registro_<número do="" registro="">: identificador do enésimo registro da lista
• <registros>: lista de campos existente no assunto, Varia conforme a tabela a ser consultada.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <con:listar> <token>79aad05f-f9f9-42c1-a8a8-e24f95de0d9c</token> <codigoUg>10006</codigoUg> <competencia>201401</competencia> <identificadorTabTabela>461</identificadorTabTabela> </con:listar> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarResponse xmlns:ns2="http://consulta.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">100</value> </entry> <entry> <key>PAGINA</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">1</value> </entry> <entry> <key>QUANTIDADE_PAGINAS</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">10</value> </entry> <entry> <key>registro_1</key> <value xsi:type="ns2:registro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <registros> <campo>codigoUnidade</campo> <valor xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema">12345</valor> </registros> <registros> <campo>nomeUnidade</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Inst. XXX</valor> </registros> <registros> <campo>nomeEnte</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">XXX</valor> </registros> <registros> <campo>descricaoTipoUnidade</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Autarquia</valor> </registros> <registros> <campo>descricaoPoderOrgao</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Executivo</valor> </registros> <registros> <campo>descricaoTipoEsfera</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Municipal</valor> </registros> </value> </entry> <entry> <key>registro_2</key> <value xsi:type="ns2:registro" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <registros> <campo>codigoUnidade</campo> <valor xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema">999</valor> </registros> <registros> <campo>nomeUnidade</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Fundação XXX</valor> </registros> <registros> <campo>nomeEnte</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">XXX</valor> </registros> <registros> <campo>descricaoTipoUnidade</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Fundação</valor> </registros> <registros> <campo>descricaoPoderOrgao</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Executivo</valor> </registros> <registros> <campo>descricaoTipoEsfera</campo> <valor xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema">Municipal</valor> </registros> </value> </entry> </dados> <mensagem>Consulta executada com sucesso com 2 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarResponse> </soap:Body> </soap:Envelope>
Permite listar as tabelas disponíveis para consulta.
Definição:
- listarTabelasDisponiveis(inteiro competencia)
Parâmetros:
- competencia: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser enviado os dados
• BB = bimestre de 01 até 06
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome da tabela>: identificador do enésimo registro da lista.
• <identificador>: campo identificador a ser usado no serviço listar.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <con:listarTabelasDisponiveis/> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarTabelasDisponiveisResponse xmlns:ns2="http://consulta.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>SISTEMACONTAS</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">468</value> </entry> <entry> <key>TIPOMOVIMENTOCONTABIL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">69</value> </entry> <entry> <key>TIPOLANCAMENTO</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">66</value> </entry> <entry> <key>UNIDADEGESTORA</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">461</value> </entry> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">4</value> </entry> </dados> <mensagem>Consulta executada com sucesso com 4 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarTabelasDisponiveisResponse> </soap:Body> </soap:Envelope>
Permite listar os operadores disponíveis para usar dentro de um filtro de consulta.
Definição:
listarOperadoresFiltroConsultaDisponiveis()
Parâmetros:
- nenhum
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Operador>: operador sql.
• <valor>: desconsiderar, usar o operador.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <con:listarOperadoresFiltroConsultaDisponiveis/> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarOperadoresFiltroConsultaDisponiveisResponse xmlns:ns2="http://consulta.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>AND</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">and</value> </entry> <entry> <key>OR</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">or</value> </entry> <entry> <key>IGUAL</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">=</value> </entry> <entry> <key>LIKE_TOTAL</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">like</value> </entry> <entry> <key>LIKE_ESQUERDA</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">like</value> </entry> <entry> <key>LIKE_DIREITA</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">like</value> </entry> <entry> <key>MAIOR</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">></value> </entry> <entry> <key>MENOR</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><</value> </entry> <entry> <key>MAIOR_IGUAL</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">>=</value> </entry> <entry> <key>MENOR_IGUAL</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><=</value> </entry> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">10</value> </entry> </dados> <mensagem>Consulta executada com sucesso com 10 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarOperadoresFiltroConsultaDisponiveisResponse> </soap:Body> </soap:Envelope>
Permite listar os campos disponíveis em uma determinada tabela para usar dentro de um filtro de consulta.
Definição:
- listarCamposPorTabela( inteiro identificadorTabTabela )
Parâmetros:
- identificadorTabTabela: identificador da tabela que se deseja pesquisar
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome do campo>: nome do campo para se usar na consulta com filtro.
• <tipo do campo - tamanho máximo do campo>: tipo do campo e tamanho máximo do mesmo.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <con:listarCamposPorTabela> <identificadorTabTabela>66</identificadorTabTabela> </con:listarCamposPorTabela> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarCamposPorTabelaResponse xmlns:ns2="http://consulta.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>DATAATIVACAO</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">DATE : 8</value> </entry> <entry> <key>CODIGOTIPOLANCAMENTO</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">INTEGER : 4</value> </entry> <entry> <key>DESCRICAOTIPOLANCAMENTO</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">STRING : 10</value> </entry> <entry> <key>DATADESATIVACAO</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">DATE : 8</value> </entry> <entry> <key>IDENTIFICADOR</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">INTEGER : 4</value> </entry> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5</value> </entry> </dados> <mensagem>Consulta executada com sucesso com 5 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarCamposPorTabelaResponse> </soap:Body> </soap:Envelope>
Permite listar os tipos de relatórios disponíveis em uma determinada competência.
Definição:
- listarRelatoriosDisponiveis( inteiro competência )
Parâmetros:
- Competência: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser consultado os dados
• BB = bimestre de 01 até 06
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome do campo>: nome do campo para se usar na consulta com filtro.
• <tipo do campo - tamanho máximo do campo>: tipo do campo e tamanho máximo do mesmo.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <con:listarRelatoriosDisponiveis> <competencia>201506</competencia> </con:listarRelatoriosDisponiveis> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarRelatoriosDisponiveisResponse> <return> <dados> <entry> <key>Débito e Crédito Acumulado por Conta Contábil</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> <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> </return> </ns2:listarRelatoriosDisponiveisResponse> </soap:Body> </soap:Envelope>
Permite obter de relatórios de uma determinada competência.
Definição:
- listarRelatorios ( inteiro idRelatório )
Parâmetros:
- token: o token recebido no serviço obterToken.
- codigoUnidadeGestora: código da Unidade Gestora para listar as informações, opcional para consultas de unidade gestora.
- competencia: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser enviado os dados
• BB = bimestre de 01 até 06 - idRelatório: identificador do relatório obtido pela operação: listarRelatoriosDisponiveis.
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome do campo>: nome do campo para se usar na consulta com filtro.
• <tipo do campo - tamanho máximo do campo>: tipo do campo e tamanho máximo do mesmo.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <ns2:listarRelatorios> <chaveToken>c6c59f4f-ef36-496d-b286-d8215d460aa9</chaveToken> <codigoUg>92918</codigoUg> <competencia>201506</competencia> <identificadorRelatorio>1</identificadorRelatorio> </ns2:listarRelatorios> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarRelatoriosResponse > <return> <dados> <entry> <key>registro_1</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema -instance" xsi:type="ns2:registro"> <registros> <campo>CODIGOCONTA</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">111110100</valor> </registros> <registros> <campo>CONTACORRENTE</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">0100000000</valor> </registros> <registros> <campo>debito</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:decimal">1096025.73</valor> </registros> <registros> <campo>credito</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:decimal">0.00</valor> </registros> </value> </entry> <entry> <key>registro_2</key> <value xmlns:xsi="http://www.w3.org/2001/XMLSchema -instance" xsi:type="ns2:registro"> <registros> <campo>CODIGOCONTA</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:int">111110100</valor> </registros> <registros> <campo>CONTACORRENTE</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:string">0100000001</valor> </registros> <registros> <campo>debito</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:decimal">980378605.70</valor> </registros> <registros> <campo>credito</campo> <valor xmlns:xs="http://www.w3.org/2001/XMLSchema" xsi:type="xs:decimal">1088825324.68</valor> </registros> </value> </entry> ... </dados> <mensagem> Consulta executada com sucesso com 9999 resultado(s)</mensagem> <status>OK</status> </return> </ns2:listarRelatoriosResponse> </soap:Body> </soap:Envelope>
Permite listar os assuntos disponíveis por tipo de unidade e esfera. Útil para saber quais serviços estão disponíveis para cada tipo de unidade.
Definição:
- listarAssuntosDisponiveisEnvio(inteiro competência, inteiro tipoUnidade, inteiro tipoEsfera)
Parâmetros:
- competencia: competência bimestral no formato: AAAABB, onde:
• AAAA = ano a ser enviado os dados
• BB = bimestre de 01 até 06 - tipoUnidade: tipo da unidade, conforme operação “lista” do serviço “Consulta”.
- tipoEsfera: tipo da esfera, conforme operação “lista” do serviço “Consulta”.
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome do assunto>: identificador do enésimo registro da lista.
• <código do assunto>: código do assunto
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soap:Body> <con:listarAssuntosDisponiveisEnvio xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <competencia>201601</competencia> <tipoEsfera>2</tipoEsfera> <tipoUnidade>1</tipoUnidade> </con:listarAssuntosDisponiveisEnvio></soap:Body></soap:Envelope> <soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarAssuntosDisponiveisEnvioResponse xmlns:ns2="http://consulta.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>Membro Comissão Licitação</key> <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:int">109</value> </entry> <entry> <key>Estorno Pagamento</key> <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:int">130</value> </entry> <entry> <key>Estorno Empenho</key> <value xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:int">125</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">25</value> </entry> </dados> <mensagem> Consulta executada com sucesso com 25 resultado(s)</mensagem> </return> </ns2:listarAssuntosDisponiveisEnvioResponse> </soap:Body> </soap:Envelope>
Permite listar uma relação das mensagens de erro e seu respectivo código de erro.
Definição:
listar ()
Parâmetros:
Não possui
Resposta (campos dados):
- total: Quantidade de elementos resultantes da consulta.
- Lista de pares de elementos na forma “chave x valor” conforme definição:
• <Nome do campo>: nome do campo para se usar na consulta com filtro.
• <valor>:.texto da mensagem de erro.
Exemplo:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://consulta.ws.tce.sc.gov.br/"> <soapenv:Header... <soapenv:Body> <men:listar/> </soapenv:Body> </soapenv:Envelope>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <ns2:listarResponse xmlns:ns2="http://mensagem.ws.tce.sc.gov.br/"> <return> <dados> <entry> <key>0</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">OK</value> </entry> <entry> <key>410</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Cargo Grupo Referência Nível não pertence a Data da Publicação </value> </entry> <entry> <key>1001</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Meta Física Ação cadastrada com sucesso.</value> </entry> <entry> <key>1002</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Meta Física Ação já cadastrada</value> </entry> .... <entry> <key>2012069</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Campo Data do valor do dano apurado obrigatório</value> </entry> <entry> <key>2012070</key> <value xsi:type="xs:string" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A Data de Estorno deve estar dentro da competência atual e maior ou igual a Data do Empenho.</value> </entry> <entry> <key>TOTAL</key> <value xsi:type="xs:int" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2652</value> </entry> </dados> <mensagem>Lista de mensagens erro obtida com sucessso</mensagem> <status>OK</status> </return> </ns2:listarResponse> </soap:Body> </soap:Envelope>