Versions Compared

Key

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

...

Expand
titleServiço Competência

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:

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:com="http://competencia.ws.tce.sc.gov.br/">
 <soapenv:Header...
 <soapenv:Body>
 <com:obterCompetencia>
 <codigoUg>10006</codigoUg>
 </com:obterCompetencia>
 </soapenv:Body>
</soapenv:Envelope>


Code Block
languagexml
titleResposta
<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>



Expand
titleServiços relacionados a consultas/listagens


Expand
titleOperaçã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
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: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
languagexml
titleResposta
<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>