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âmetro	Tipo (tamanho)	Observações
credencial	CredencialDTO	Credencial do usuário
filtro	FiltroExecucaoOrcamentariaPacDTO	Filtro 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.

Atributo	Tipo(tamanho)	Aceita Nulo?	Observações
usuario	Texto	Não	Login do usuário no SIOP
senha	Texto	Não	Hash MD5 da senha do usuário no SIOP
perfil	Inteiro	Sim (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

Atributo	Tipo(tamanho)	Observações
exercicio	int	obrigatório

Retorno

RetornoExecucaoPacDTO

Atributo	Tipo(tamanho)	Observações
execucoesOrcamentarias	List<ExecucaoOrcamentariaPacDTO>	Contém a lista de execuções orçamentárias

ExecucaoOrcamentariaPacDTO

Atributo	Tipo(tamanho)	Observações
anoExercicio	int
esfera	string
descricaoesfera	string
orgao	string
descricaoorgao	string
uo	string
descricaouo	string
funcao	string
descricaofuncao	string
subfuncao	string
descricaosubfuncao	string
programa	string
tituloprograma	string
acao	string
tituloacao	string
localizador	string
descricaolocalizador	string
plano_interno	string
pidescricao	string
projetolei	numeric(16,2)
dotacaoinicial	numeric(16,2)
dotacaoatual	numeric(16,2)
antecipado	numeric(16,2)
autorizado	numeric(16,2)
empenhado	numeric(16,2)
empenholiquidado	numeric(16,2)
empenhoaliquidar	numeric(16,2)
disponivel	numeric(16,2)
bloqueado_remanejamento_de_credito	numeric(16,2)
bloqueado_rp3	numeric(16,2)
bloqueado_rp2	numeric(16,2)
pago	numeric(16,2)
rapexerciciosanteriores	numeric(16,2)
rapinscrito	numeric(16,2)
rapcancelados	numeric(16,2)
rapapagar	numeric(16,2)
rappago	numeric(16,2)
emp_liq_inscr_rap_np	numeric(16,2)
rp_lei	string
rp_atual	string

RetornoDTO

Atributo	Tipo(tamanho)	Observações
sucesso	boolean	Indica se a requisição foi processada com sucesso.
mensagensErro	List<String>	Contém a lista de mensagens de erro nos casos em que sucesso retornar valor igual false.