Ferramentas do usuário

Ferramentas do site


Action unknown: addtobook
webservices:manual-wsexecucaoorcamentaria

WEB-Service para Consulta de Execução Orçamentária

Informações Gerais

Serviço

Nome: Web Service para consulta de execução orçamentária
Nome na interface: WSExecucaoOrcamentaria
Início da operação: 31/05/2017 (atualizar)
Endereço do WSDL - Testes https://testews.siop.gov.br/services/WSExecucaoOrcamentaria?wsdl
Endereço do WSDL - Produção https://webservice.siop.gov.br/services/WSExecucaoOrcamentaria?wsdl

Objetivo

Fornecer uma interface que possibilite a consulta de execução orçamentária.

Operações

Este serviço disponibiliza apenas uma operação para consultar a execução orçamentária, especificamente, para a Secretaria de Desenvolvimento da Infraestrutura (SDI) , antiga Secretaria do Programa de Aceleração do Crescimento - SEPAC

2.1 Consultar Execução PAC

Operação para consulta de execução orçamentária específica para o PAC (Programa de Aceleração do Crescimento), ou seja, os dados são filtrados para identificador de Resultado Primário (RP 3)

Nome da operação na interface do serviço: consultarExecucaoPac

Parâmetro(s) de entrada:

ParâmetroTipo (tamanho)Observações
credencialCredencialDTOCredencial do usuário
filtroFiltroExecucaoOrcamentariaPacDTOFiltro de consulta que permite a passagem do exercício para busca da execução orçamentária

Tipo de Retorno: RetornoExecucaoPacDTO

Exemplo:

Requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://servicoweb.siop.sof.planejamento.gov.br/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:consultarExecucaoPac>
         <credencial>
            <email>?</email>
            <perfil>32</perfil>
            <senha>[hash md5 da senha]</senha>
            <usuario>[login credencial]</usuario>
         </credencial>
         <filtro>
            <exercicio>2017</exercicio>
         </filtro>
      </ser:consultarExecucaoPac>
   </soapenv:Body>
</soapenv:Envelope>

Resposta:

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sof="http://servicoweb.siop.sof.planejamento.gov.br/">
  <env:Header>
    <sof:request>F4D71977355F05786B40209700EB8501</sof:request>
  </env:Header>
  <env:Body>
    <ns2:consultarExecucaoPacResponse xmlns:ns2="http://servicoweb.siop.sof.planejamento.gov.br/">
      <return>
        <sucesso>true</sucesso>
        <execucoesOrcamentarias>
          <execucaoOrcamentaria>
            <acao>122I</acao>
            <anoexercicio>2017</anoexercicio>
            <antecipado>0.00</antecipado>
            <autorizado>0.00</autorizado>
            <bloqueado_remanejamento_de_credito>0.00</bloqueado_remanejamento_de_credito>
            <bloqueado_rp2>0.00</bloqueado_rp2>
            <bloqueado_rp3>0.00</bloqueado_rp3>
            <descricaoesfera>Orçamento Fiscal</descricaoesfera>
            <descricaofuncao>Transporte</descricaofuncao>
            <descricaolocalizador>No Estado do Espírito Santo</descricaolocalizador>
            <descricaoorgao>Presidência da República</descricaoorgao>
            <descricaosubfuncao>Transporte Hidroviário</descricaosubfuncao>
            <descricaouo>Secretaria de Portos</descricaouo>
            <disponivel>0.00</disponivel>
            <dotacaoatual>0.00</dotacaoatual>
            <dotacaoinicial>0.00</dotacaoinicial>
            <emp_liq_inscr_rap_np>0.00</emp_liq_inscr_rap_np>
            <empenhado>0.00</empenhado>
            <empenhoaliquidar>0.00</empenhoaliquidar>
            <empenholiquidado>0.00</empenholiquidado>
            <esfera>10</esfera>
            <funcao>26</funcao>
            <localizador>0032</localizador>
            <orgao>20000</orgao>
            <pago>0.00</pago>
            <pidescricao>Porto de Vitoria - Drag.Aprof.Canal de Acesso</pidescricao>
            <plano_interno>SEP00012</plano_interno>
            <programa>2074</programa>
            <projetolei>0.00</projetolei>
            <rapapagar>1195501.93</rapapagar>
            <rapcancelados>0.00</rapcancelados>
            <rapexerciciosanteriores>3534913.46</rapexerciciosanteriores>
            <rapinscrito>0.00</rapinscrito>
            <rappago>2339411.53</rappago>
            <rp_atual>3</rp_atual>
            <rp_lei>3</rp_lei>
            <subfuncao>784</subfuncao>
            <tituloacao>Dragagem e Adequação da Navegabilidade no Porto de Vitória (ES)</tituloacao>
            <tituloprograma>Transporte Marítimo</tituloprograma>
            <uo>20128</uo>
          </execucaoOrcamentaria>
        </execucoesOrcamentarias>
      </return>
    </ns2:consultarExecucaoPacResponse>
  </env:Body>
</env:Envelope>

Estruturas de Entrada/Saída e Retorno

As informações que trafegam pelo serviço são organizadas em estruturas de dados que atuam como entrada (parâmetros) e retorno das operações. Enquanto os dados são manipulados pelos sistemas, seja nos clientes ou no servidor, essas informações ficam alocadas em entidades que, no contexto de web services, podem ser chamadas de Objetos de Transferência de Dados, ou DTOs (sigla de Data Transfer Objects). Um DTO é uma classe de objetos que descreve os atributos (e as operações de atribuição e consulta de seus valores) de determinado conceito envolvido no domínio de um problema. No momento da comunicação, seja na requisição ou na resposta, os DTOs são transformados em estruturas XML formatadas de acordo com a especificação contida no documento descritor do web service (WSDL).

As linguagens de programação modernas possuem ferramentas que automatizam o processo de construção dos DTOs a partir do WSDL, bem como bibliotecas com funcionalidades que tornam transparente para o desenvolvedor o processo de tradução de DTO para XML e vice-versa.

Entradas

CredencialDTO

Esta estrutura é composta pelas informações necessárias para que a aplicação cliente se identifique junto ao serviço. A credencial a ser utilizada nos web services do SIOP é específica para esse fim e não é válida para acessar a aplicação web.

AtributoTipo(tamanho)Aceita Nulo?Observações
usuarioTextoNãoLogin do usuário no SIOP
senhaTextoNãoHash MD5 da senha do usuário no SIOP
perfilInteiroSim (apenas para operações de consultas de tabelas de apoio).Perfil com o qual o usuário deseja realizar determinada operação. Não é obrigatório na operação obterTabelasApoioQuantitativo.

FiltroExecucaoOrcamentariaPacDTO

AtributoTipo(tamanho)Observações
exercicioint obrigatório

Retorno

RetornoExecucaoPacDTO

AtributoTipo(tamanho)Observações
execucoesOrcamentariasList<ExecucaoOrcamentariaPacDTO>Contém a lista de execuções orçamentárias

ExecucaoOrcamentariaPacDTO

AtributoTipo(tamanho)Observações
anoExercicioint
esferastring
descricaoesferastring
orgaostring
descricaoorgaostring
uostring
descricaouostring
funcaostring
descricaofuncaostring
subfuncaostring
descricaosubfuncaostring
programastring
tituloprogramastring
acaostring
tituloacaostring
localizadorstring
descricaolocalizadorstring
plano_internostring
pidescricaostring
projetoleinumeric(16,2)
dotacaoinicialnumeric(16,2)
dotacaoatualnumeric(16,2)
antecipadonumeric(16,2)
autorizadonumeric(16,2)
empenhadonumeric(16,2)
empenholiquidadonumeric(16,2)
empenhoaliquidarnumeric(16,2)
disponivelnumeric(16,2)
bloqueado_remanejamento_de_creditonumeric(16,2)
bloqueado_rp3numeric(16,2)
bloqueado_rp2numeric(16,2)
pagonumeric(16,2)
rapexerciciosanterioresnumeric(16,2)
rapinscritonumeric(16,2)
rapcanceladosnumeric(16,2)
rapapagarnumeric(16,2)
rappagonumeric(16,2)
emp_liq_inscr_rap_npnumeric(16,2)
rp_leistring
rp_atualstring

RetornoDTO

AtributoTipo(tamanho)Observações
sucessobooleanIndica se a requisição foi processada com sucesso.
mensagensErroList<String>Contém a lista de mensagens de erro nos casos em que sucesso retornar valor igual false.