Content Comparison

...

Expand

title	Serviços relacionados a consultas/listagens

Expand

title	Operação: listar

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:

Code Block

language	xml
title	Solicitaçã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: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>

Code Block

language	xml
title	Resposta

<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>

Expand

title	Operação: listarTabelasDisponiveis

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:

Code Block

language	xml
title	Solicitação

<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>

Code Block

language	xml
title	Resposta

<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>

Expand

title	Operação: listarOperadoresFiltroConsultaDisponiveis

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:

Code Block

language	xml
title	Solicitação:

<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>

Code Block

language	xml
title	Resposta

<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>

Version	Old Version 23	New Version 24
Changes made by	Former user	Former user
Saved on	Mar 11, 2020	Mar 11, 2020

Versions Compared

Key