sigplan - catálogo de...

53
MPOG SPI Documentação do Web Service Exportação SIGPlan Versão 1.2 Sistema de Informações Gerenciais e Planejamento SIGPlan

Upload: hakhue

Post on 28-Apr-2019

218 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Documentação do Web Service Exportação

SIGPlanVersão 1.2

Sistema de Informações Gerenciais e Planejamento

SIGPlan

Page 2: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Índice

1. Informações gerais sobre o serviço ........................................................................................................... 7 1.1 Contexto ............................................................................................................................................... 7 1.2 Objetivo ................................................................................................................................................ 7 1.3 Nome .................................................................................................................................................... 7 1.4 Endereço do arquivo WSDL ................................................................................................................ 7 1.5 Gestor do serviço ................................................................................................................................. 7 1.6 Responsável técnico ............................................................................................................................. 7 1.7 Requisitos e orientações para o acesso ................................................................................................ 8

2. Informações detalhadas do serviço ........................................................................................................... 8 2.1 Nome do serviço na interface .............................................................................................................. 8 2.2 Considerações gerais sobre parâmetros de entrada e/ou saída ............................................................. 8 2.3 Operações ............................................................................................................................................. 8

2.3.1 Base Geográfica ............................................................................................................................ 8 2.3.1.1 BaseGeografica ...................................................................................................................... 8 2.3.1.2 Parâmetro(s) de entrada ......................................................................................................... 8 2.3.1.3 Parâmetro(s) de saída ............................................................................................................. 8 2.3.1.4 Tipo(s) Complexo(s) .............................................................................................................. 9

2.3.2 Categoria Econômica .................................................................................................................... 9 2.3.2.1 CategoriaEconomica .............................................................................................................. 9 2.3.2.2 Parâmetro(s) de entrada ......................................................................................................... 9 2.3.2.3 Parâmetro(s) de saída ............................................................................................................. 9 2.3.2.4 Tipo(s) Complexo(s) .............................................................................................................. 9

2.3.3 Esfera .......................................................................................................................................... 10 2.3.3.1 Esfera ................................................................................................................................... 10 2.3.3.2 Parâmetro(s) de entrada ....................................................................................................... 10 2.3.3.3 Parâmetro(s) de saída ........................................................................................................... 10 2.3.3.4 Tipo(s) Complexo(s) ............................................................................................................ 10

2.3.4 FontePPA .................................................................................................................................... 10 2.3.4.1 FontePPA ............................................................................................................................. 10 2.3.4.2 Parâmetro(s) de entrada ....................................................................................................... 10 2.3.4.3 Parâmetro(s) de saída ........................................................................................................... 11 2.3.4.4 Tipo(s) Complexo(s) ............................................................................................................ 11

2.3.5 Função ......................................................................................................................................... 11 2.3.5.1 Funcao .................................................................................................................................. 11 2.3.5.2 Parâmetro(s) de entrada ....................................................................................................... 11 2.3.5.3 Parâmetro(s) de saída ........................................................................................................... 11 2.3.5.4 Tipo(s) Complexo(s) ............................................................................................................ 11

2.3.6 Geração por Ação ....................................................................................................................... 12 2.3.6.1 GeracaoPorAcao .................................................................................................................. 12 2.3.6.2 Parâmetro(s) de entrada ....................................................................................................... 12 2.3.6.3 Parâmetro(s) de saída ........................................................................................................... 13 2.3.6.4 Tipo(s) Complexo(s) ............................................................................................................ 14

2.3.7 Geração por Localizador ............................................................................................................. 30 2.3.7.1 GeracaoPorLocalizador ........................................................................................................ 30 2.3.7.2 Parâmetro(s) de entrada ....................................................................................................... 30 2.3.7.3 Parâmetro(s) de saída ........................................................................................................... 31

Page 3: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.8 Geração por Orgão ...................................................................................................................... 32 2.3.8.1 GeracaoPorOrgao ................................................................................................................. 32 2.3.8.2 Parâmetro(s) de entrada ....................................................................................................... 32 2.3.8.3 Parâmetro(s) de saída ........................................................................................................... 33

2.3.9 Geração por Programa ................................................................................................................ 34 2.3.9.1 GeracaoPorPrograma ........................................................................................................... 34 2.3.9.2 Parâmetro(s) de entrada ....................................................................................................... 34 2.3.9.3 Parâmetro(s) de saída ........................................................................................................... 35

2.3.10 Geração por Situação Programa ................................................................................................ 36 2.3.10.1 GeracaoPorSituacaoPrograma ........................................................................................... 36 2.3.10.2 Parâmetro(s) de entrada ..................................................................................................... 36 2.3.10.3 Parâmetro(s) de saída ......................................................................................................... 36

2.3.11 Geração por UO ........................................................................................................................ 36 2.3.11.1 GeracaoPorUO ................................................................................................................... 36 2.3.11.2 Parâmetro(s) de entrada ..................................................................................................... 36 2.3.11.3 Parâmetro(s) de saída ......................................................................................................... 38

2.3.12 Geração por UO Ação ............................................................................................................... 39 2.3.12.1 GeracaoPorUOAcao .......................................................................................................... 39 2.3.12.2 Parâmetro(s) de entrada ..................................................................................................... 39 2.3.12.3 Parâmetro(s) de saída ......................................................................................................... 39

2.3.13 Grupo Natureza ......................................................................................................................... 41 2.3.13.1 GrupoNatureza ................................................................................................................... 41 2.3.13.2 Parâmetro(s) de entrada ..................................................................................................... 41 2.3.13.3 Parâmetro(s) de saída ......................................................................................................... 41 2.3.13.4 Tipo(s) Complexo(s) .......................................................................................................... 41

2.3.14 Nível Acesso ............................................................................................................................. 41 2.3.14.1 NivelAcesso ....................................................................................................................... 41 2.3.14.2 Parâmetro(s) de entrada ..................................................................................................... 41 2.3.14.3 Parâmetro(s) de saída ......................................................................................................... 42 2.3.14.4 Tipo(s) Complexo(s) .......................................................................................................... 42

2.3.15 Objetivo Governo ...................................................................................................................... 42 2.3.15.1 ObjetivoGoverno ................................................................................................................ 42 2.3.15.2 Parâmetro(s) de entrada ..................................................................................................... 42 2.3.15.3 Parâmetro(s) de saída ......................................................................................................... 42 2.3.15.4 Tipo(s) Complexo(s) .......................................................................................................... 42

2.3.16 Objetivo Setorial ....................................................................................................................... 43 2.3.16.1 ObjetivoSetorial ................................................................................................................. 43 2.3.16.2 Parâmetro(s) de entrada ..................................................................................................... 43 2.3.16.3 Parâmetro(s) de saída ......................................................................................................... 43 2.3.16.4 Tipo(s) Complexo(s) .......................................................................................................... 43

2.3.17 Órgão Orçamentário .................................................................................................................. 43 2.3.17.1 OrgaoOrcamentario ............................................................................................................ 43 2.3.17.2 Parâmetro(s) de entrada ..................................................................................................... 43 2.3.17.3 Parâmetro(s) de saída ......................................................................................................... 44 2.3.17.4 Tipo(s) Complexo(s) .......................................................................................................... 44

2.3.18 Órgão Siorg ............................................................................................................................... 44 2.3.18.1 OrgaoSiorg ......................................................................................................................... 44 2.3.18.2 Parâmetro(s) de entrada ..................................................................................................... 44

Page 4: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.18.3 Parâmetro(s) de saída ......................................................................................................... 44 2.3.18.4 Tipo(s) Complexo(s) .......................................................................................................... 45

2.3.19 Periodicidade ............................................................................................................................. 45 2.3.19.1 Periodicidade ...................................................................................................................... 45 2.3.19.2 Parâmetro(s) de entrada ..................................................................................................... 45 2.3.19.3 Parâmetro(s) de saída ......................................................................................................... 45 2.3.19.4 Tipo(s) Complexo(s) .......................................................................................................... 45

2.3.20 Produto ...................................................................................................................................... 45 2.3.20.1 Produto ............................................................................................................................... 45 2.3.20.2 Parâmetro(s) de entrada ..................................................................................................... 46 2.3.20.3 Parâmetro(s) de saída ......................................................................................................... 46 2.3.20.4 Tipo(s) Complexo(s) .......................................................................................................... 46

2.3.21 Região ....................................................................................................................................... 46 2.3.21.1 Regiao ................................................................................................................................ 46 2.3.21.2 Parâmetro(s) de entrada ..................................................................................................... 46 2.3.21.3 Parâmetro(s) de saída ......................................................................................................... 46 2.3.21.4 Tipo(s) Complexo(s) .......................................................................................................... 46

2.3.22 Situação Ação ........................................................................................................................... 47 2.3.22.1 SituacaoAcao ..................................................................................................................... 47 2.3.22.2 Parâmetro(s) de entrada ..................................................................................................... 47 2.3.22.3 Parâmetro(s) de saída ......................................................................................................... 47 2.3.22.4 Tipo(s) Complexo(s) .......................................................................................................... 47

2.3.23 Situação Programa .................................................................................................................... 47 2.3.23.1 SituacaoPrograma .............................................................................................................. 47 2.3.23.2 Parâmetro(s) de entrada ..................................................................................................... 47 2.3.23.3 Parâmetro(s) de saída ......................................................................................................... 48 2.3.23.4 Tipo(s) Complexo(s) .......................................................................................................... 48

2.3.24 Subcategoria Restrição .............................................................................................................. 48 2.3.24.1 SubcategoriaRestricao ........................................................................................................ 48 2.3.24.2 Parâmetro(s) de entrada ..................................................................................................... 48 2.3.24.3 Parâmetro(s) de saída ......................................................................................................... 48 2.3.24.4 Tipo(s) Complexo(s) .......................................................................................................... 48

2.3.25 SubFunção ................................................................................................................................. 49 2.3.25.1 SubFuncao .......................................................................................................................... 49 2.3.25.2 Parâmetro(s) de entrada ..................................................................................................... 49 2.3.25.3 Parâmetro(s) de saída ......................................................................................................... 49 2.3.25.4 Tipo(s) Complexo(s) .......................................................................................................... 49

2.3.26 Tipo Ação .................................................................................................................................. 49 2.3.26.1 TipoAcao ............................................................................................................................ 49 2.3.26.2 Parâmetro(s) de entrada ..................................................................................................... 49 2.3.26.3 Parâmetro(s) de saída ......................................................................................................... 50 2.3.26.4 Tipo(s) Complexo(s) .......................................................................................................... 50

2.3.27 Tipo Programa .......................................................................................................................... 50 2.3.27.1 TipoPrograma .................................................................................................................... 50 2.3.27.2 Parâmetro(s) de entrada ..................................................................................................... 50 2.3.27.3 Parâmetro(s) de saída ......................................................................................................... 50 2.3.27.4 Tipo(s) Complexo(s) .......................................................................................................... 50

2.3.28 Tipo Restrição ........................................................................................................................... 51

Page 5: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.28.1 TipoRestricao ..................................................................................................................... 51 2.3.28.2 Parâmetro(s) de entrada ..................................................................................................... 51 2.3.28.3 Parâmetro(s) de saída ......................................................................................................... 51 2.3.28.4 Tipo(s) Complexo(s) .......................................................................................................... 51

2.3.29 Unidade Medida ........................................................................................................................ 51 2.3.29.1 UnidadeMedida .................................................................................................................. 51 2.3.29.2 Parâmetro(s) de entrada ..................................................................................................... 51 2.3.29.3 Parâmetro(s) de saída ......................................................................................................... 52 2.3.29.4 Tipo(s) Complexo(s) .......................................................................................................... 52

2.3.30 Unidade Orçamentária .............................................................................................................. 52 2.3.30.1 UnidadeOrcamentaria ........................................................................................................ 52 2.3.30.2 Parâmetro(s) de entrada ..................................................................................................... 52 2.3.30.3 Parâmetro(s) de saída ......................................................................................................... 52 2.3.30.4 Tipo(s) Complexo(s) .......................................................................................................... 52

2.3.31 Usuário ...................................................................................................................................... 53 2.3.31.1 Usuario ............................................................................................................................... 53 2.3.31.2 Parâmetro(s) de entrada ..................................................................................................... 53 2.3.31.3 Parâmetro(s) de saída ......................................................................................................... 53 2.3.31.4 Tipo(s) Complexo(s) .......................................................................................................... 53

Page 6: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Histórico de Alterações

Data Versão Descrição Responsável (eis)

02.03.2010 1.0 Versão inicialFlávio Renato Couto Oliveira

04.03.2010 1.1Atualização dos itens 1.2 Objetivo e1.7 Requisitos do documento

Flávio Renato Couto Oliveira

30.07.2010 1.2 Atualização dos itens 1.1 ao 1.7. Rejane Rodrigues de Carvalho

Page 7: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

1. Informações gerais sobre o serviço

1.1 Contexto

O serviço Exportação foi desenvolvido com um propósito específico para integração do SIGPlan(Sistema de Informações Gerenciais e de Planejamento), gerenciado pela Secretaria de Planejamento eInvestimentos Estratégicos (SPI) do Ministério do Planejamento, Orçamento e Gestão, com os sistemasespecializados de planejamento e orçamento (InfraSIGs) dos diversos órgãos do governo federal. O focodesse serviço de integração é exportar dados de monitoramento dos programas, ações orçamentárias eações não-orçamentárias presentes no Módulo de Monitoramento do SIGPlan, módulo esse que suportauma das fases do ciclo de gestão do PPA – Plano Plurianual.

1.2 Objetivo

O objetivo principal desse Web Service é disponibilizar operações de consulta a diversos dadosde programas, de ações orçamentárias e de ações não orçamentárias contemplados no Módulo deMonitoramento do SIGPlan.

1.3 Nome

Web Service de Exportação de Dados do SIGPlan.

1.4 Endereço do arquivo WSDL

Ambiente de Homologação:http://homSIGPlan.serpro.gov.br/integracao/exportacao.asmx

Ambiente de Produção: http://www.SIGPlan.gov.br/integracao/exportacao.asmx

1.5 Gestor do serviço

Nome: Andrea Thalhofer RicciardiE-mail: [email protected]: (61) 2020-4711

1.6 Responsável técnico

Nome: José Ricardo Ribeiro E-mail: [email protected]: (61) 2021-8241

Page 8: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

1.7 Requisitos e orientações para o acesso

O requisito fundamental para acesso ao Web Service de Exportação é possuir um cadastro noSIGPlan, com o perfil InfraSIG associado ao órgão interessado. Dessa forma, o usuário usará o login esenha a ele fornecido no final do cadastro para acessar o Web Service em cada uma de suas operações.

Para efetuar um cadastro no SIGPlan é necessário seguir o passo a passo descrito no portal doSIGPlan (http://www.sigplan.gov.br). O passo a passo encontra-se na página de Ajuda/FAQ que possuilink na parte superior da página principal do portal. O procedimento consiste basicamente no seguinte:

Primeiramente fazer o download da Ficha de Cadastro (Cadastro para Acompanhamento eGestão do PPA no SIGPlan ), preenchê-la de forma completa .indicando o nível de acesso desejado, eencaminhá-la para o e-mail mailto:[email protected]. Após o envio dessa ficha, a solicitaçãoserá processada, e posteriormente será enviado um login e uma senha por e-mail para o solicitante docadastro acessar o sistema.

2. Informações detalhadas do serviço

2.1 Nome do serviço na interface

exportacao

2.2 Considerações gerais sobre parâmetros de entrada e/ou saída

Todas operações de entradas incluem os parâmetros de usuário e senha para que apenasusuários autorizados possam executar as operações do Web Service. No caso de erro em login e senhaou algum outro tipo de erro, o Web Service não retorna um XML e sim uma exceção.

2.3 Operações

2.3.1 Base Geográfica

2.3.1.1 BaseGeograficaBusca os dados da tabela Base Geográfica

2.3.1.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do usuáriosenha String 0 Senha do Usuário

2.3.1.3 Parâmetro(s) de saída

Page 9: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosBaseGeografica BaseGeografica 0 Elemento BaseGeografica com

seus dados

2.3.1.4 Tipo(s) Complexo(s)

2.3.1.4.1 BaseGeografica

Parâmetro Tipo Ocorrência mínima ObservaçõesBSGCod String 0 Código da Base GeográficaBSGDsc String 0 Descrição da Base GeográficaBSGSNAtivo String 0 Indica se a Base Geográfica está ativa

ou inativa. Valor do campo será 0 sefor inativa e 1 se for ativa

2.3.2 Categoria Econômica

2.3.2.1 CategoriaEconomicaBusca os dados da tabela Categoria Econômica.

2.3.2.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano da(s) Categoria(s) Econômica(s)

que se deseja buscar

2.3.2.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

DadosCategoriaEconomica CategoriaEconomica 0 Elemento Categoria Econômicacom seus dados

2.3.2.4 Tipo(s) Complexo(s)

2.3.2.4.1 CategoriaEconomica

Parâmetro Tipo Ocorrência mínima ObservaçõesCATCod String 0 Código da Categoria EconômicaCATAno String 0 Ano da Categoria EconômicaCATDsc String 0 Descrição da Categoria Econômica

Page 10: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

CATSNAtivo String 0 Indica se a Categoria Econômica estáativa ou inativa. Valor do campo será0 se for inativa e 1 se for ativa

2.3.3 Esfera

2.3.3.1 EsferaBusca os dados da tabela de Esfera

2.3.3.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesano String 0 Ano da(s) Esfera(s) que se deseja

buscarusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.3.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosEsfera Esfera 0 Elemento Esfera com seus dados

2.3.3.4 Tipo(s) Complexo(s)

2.3.3.4.1 Esfera

Parâmetro Tipo Ocorrência mínima ObservaçõesESFAno String 0 Ano da EsferaESFCod String 0 Código da EsferaESFDsc String 0 Descrição da EsferaESFSNAtivo String 0 Indica se a Esfera está ativa ou

inativa. Valor do campo será 0 se forinativa e 1 se for ativa

2.3.4 FontePPA

2.3.4.1 FontePPABusca os dados da tabela FontePPA.

2.3.4.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do usuáriosenha String 0 Senha do Usuário

Page 11: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.4.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosFontePPA FontePPA 0 Elemento FontePPA com seus

dados

2.3.4.4 Tipo(s) Complexo(s)

2.3.4.4.1 FontePPA

Parâmetro Tipo Ocorrência mínima ObservaçõesFPPCod String 0 Código da Fonte PPAFPPDsc String 0 Descrição da Fonte PPAFPPObs String 0 Observação da Fonte PPAFPPSNTotalizacao String 0 Indica se é uma Totalização da Fonte

PPA. Valor do campo será 1 em casopositivo, e 0 em caso negativo.

FPPNAtivo String 0 Indica se a Fonte PPA está ativa ouinativa. Valor do campo será 0 se forinativa e 1 se for ativa

2.3.5 Função

2.3.5.1 FuncaoBusca os dados da tabela Funcao.

2.3.5.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesano String 1 Ano das Funções que se deseja buscarusuario String 1 Login do Usuáriosenha String 1 Senha do Usuário

2.3.5.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosFuncao Funcao 0 Elemento Função com seus dados

2.3.5.4 Tipo(s) Complexo(s)

2.3.5.4.1 Funcao

Parâmetro Tipo Ocorrência mínima ObservaçõesFUNAno String 0 Ano da Função

Page 12: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

FUNCod String 0 Código da FunçãoFUNDsc String 0 Descrição da FunçãoFUNSNAtivo String 0 Indica se a Função está ativa ou

inativa. Valor do campo será 0 se forinativa e 1 se for ativa

2.3.6 Geração por Ação

2.3.6.1 GeracaoPorAcaoExportação de dados por Ação

2.3.6.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoreceberAcao Boolean 1 Indicação para retorno do conjunto

de dados Acao. O valor deve sertrue (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjuntode dados RestricaoAcao. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisico Boolean 1 Indicação para retorno do conjuntode dados DadoFisico. O valor deveser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFinanceiro Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiro. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFisicoRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiroRAP. Ovalor deve ser true (retorna o

Page 13: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

conjunto de dados) ou false (nãoretorna o conjunto de dados).

2.3.6.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima

Observações

ArrayOfPrograma Programa 0 Um array contendo todos osprogramas retornados a partirdos dados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dados deentrada

ArrayOfAcao Acao 0 Um array contendo todas osações retornados a partir dosdados de entrada. Só virá comdados se o parâmetroreceberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados a partirdos dados de entrada. Só virácom dados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro for true.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP for true.

ArrayOfDadoFinanceiroRAP DadoFinanceiroRAP 0 Um array contendo todos osdados financeiros RAPretornados a partir dos dados deentrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Page 14: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.6.4 Tipo(s) Complexo(s)

2.3.6.4.1 Programa

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaORGCod String 0 Código do ÓrgãoTPOCod String 0 Código do Tipo do Órgão OrçamentárioPRGDsc String 0 Descrição do ProgramaTPRCod String 0 Código do Tipo de ProgramaPRGMesInicio String 0 Mês de Início do ProgramaPRGAnoInicio String 0 Ano de Início do ProgramaPRGMesTermino String 0 Mês de Término do ProgramaPRGAnoTermino String 0 Ano de Término do ProgramaPRGDscObjetivo String 0 Descrição do Objetivo do ProgramaPRGDscPublicoAlvo String 0 Descrição do Público Alvo do ProgramaPRGDscJustificativa String 0 Descrição da Justificativa do ProgramaPRGDscEstrategia String 0 Descrição da Estratégia do ProgramaPRGUrl String 0 URL do ProgramaPRGVlrPPA String 0 Valor PPA do ProgramaPRGSNTemporario String 0 Indica se o Programa é temporário.

Valor 0 em caso negativo e 1 em casopositivo

PRGPercExecucao String 0 Percentual de execução do ProgramaPRGComentariosGerais String 0 Comentários Gerais do ProgramaOSECod String 0 Código do Objetivo SetorialSIPCod String 0 Código da situação de execução do

ProgramaPRGDataAlt String 0 Última data de atualização do

ProgramaPRGUsuCodAlt String 0 Código do Usuário que alterou o

ProgramaPRGSisSiglaAlt String 0 Sigla do sistema a realizar a operação ListaUsuarioPerfil List 0 Lista dos usuários vinculados ao

programa com seus respectivos perfis.Ver tabela a sequir

Arquivos List 0 Lista dos arquivos anexos ao programa.Ver tabela a seguir

HistoricoComentariosGerente

List 0 Histórico dos comentários dogerente/gerente executivo do programa.Ver tabela a seguir

HistoricoComentariosMonitor

List 0 Histórico dos comentários do monitordo programa. Ver tabela a seguir

Os atributos do tipo List serão listados abaixo:

Page 15: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.6.4.1.1 ListaUsuarioPerfil

Parâmetro Tipo Ocorrência mínima ObservaçõesNIVCod String 0 Código do PerfilUSUCod String 0 Código do Usuário

2.3.6.4.1.2 Arquivos

Parâmetro Tipo Ocorrência mínima ObservaçõesARQNumSequencial String 0 Código do anexoARQDsc String 0 Descrição do anexoARQNomeArquivo String 0 Nome do arquivo anexo

2.3.6.4.1.3 HistoricoComentariosGerente

Parâmetro Tipo Ocorrência mínima ObservaçõesHPCData String 0 Data do histórico do comentárioSIPCod String 0 Situação do programaUSUCod String 0 Código do usuárioHPCDsc String 1 Comentário

2.3.6.4.1.4 HistoricoComentariosMonitor

Parâmetro Tipo Ocorrência mínima ObservaçõesHPCData String 0 Data do histórico do comentárioUSUCod String 0 Código do usuárioHPCDsc String 0 Comentário

2.3.6.4.2 Indicador

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaTRSCod String 0 Número do IndicadorPERCod String 0 Código da PeriodicidadeBSGCod String 0 Código da Base GeográficaINDDsc String 0 Descrição do IndicadorINDDscFonte String 0 Descrição da Fonte do IndicadorINDDscFormula String 0 Descrição da Fórmula do IndicadorINDVlrReferencia String 0 Valor de Referência do IndicadorINDVlrPrevistoAno1 String 0 Valor previsto do indicador para o

primeiro ano do PPAINDVlrPrevistoAno2 String 0 Valor previsto do indicador para o

segundo ano do PPAINDVlrPrevistoAno3 String 0 Valor previsto do indicador para o

terceiro ano do PPA

Page 16: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

INDVlrPrevistoAno4 String 0 Valor previsto do indicador para oquarto ano do PPA

INDVlrApuradoAno1 String 0 Valor apurado para o indicador noprimeiro ano do PPA anterior ao PPAatual

INDVlrApuradoAno2 String 0 Valor apurado para o indicador nosegundo ano do PPA anterior ao PPAatual

INDVlrApuradoAno3 String 0 Valor apurado para o indicador noterceiro ano do PPA anterior ao PPAatual

INDVlrApuradoAno4 String 0 Valor apurado para o indicador noquarto ano do PPA anterior ao PPAatual

INDVlrApuradoAno5 String 0 Valor apurado para o indicador noprimeiro ano do PPA atual

INDVlrApuradoAno6 String 0 Valor apurado para o indicador nosegundo ano do PPA atual

INDVlrApuradoAno7 String 0 Valor apurado para o indicador noterceiro ano do PPA atual

INDVlrApuradoAno8 String 0 Valor apurado para o indicador noquarto ano do PPA atual

INDDataReferencia String 0 Data de apuração do índice dereferência. Importado do cadastro PPA-Elaboração/Revisão

INDDscJustificativa String 0 Justificativa para a não informação doíndice

INDDscComentario String 0 Comentário geral do indicador

2.3.6.4.3 RestricaoPrograma

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaTRSCod String 0 Código do Tipo de RestriçãoRSPNum String 0 Número da Restrição de ProgramaRSPDataInclusao String 0 Data da Inclusão da Restrição de

ProgramaRSPDscRestricao String 0 Descrição da Restrição da Restrição de

ProgramaRSPDscProvidencia String 0 Descrição da Providência da Restrição

de ProgramaRSPDataSuperacao String 0 Data da Superação da Restrição de

ProgramaRSPUsuCodAlt String 0 Código do Usuário da última

atualização da Restrição de ProgrmaRSPDataAlt String 0 Data da Alteração da Restrição de

Page 17: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

ProgramaSubcategorias List 0 Lista com subcategorias da restrição.

Ver definição a seguir. (ver descriçãodos tipos no método de exportaçãoSubcategoriaRestricao)

O atributo do tipo List será listado abaixo:

2.3.6.4.3.1Subcategorias

Parâmetro Tipo Ocorrência mínima ObservaçõesSUBTRSCod String 0 Código da subcategoria da restrição

2.3.6.4.4 Acao

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo,gerado pelo SIGPlan. Este códigonão é, necessariamente, o mesmocódigo do localizador de gasto.

LOCCod String 0 Código do Localizador de Gasto(subtítulo) constante da LeiOrçamentária Anual e do PPA

REGCod String 0 Código da RegiãoTACCod String 0 Código do Tipo da Ação.

Identifica se a ação é um Projeto,Atividade, Operação Especial ouNão-Orçamentária

PROCod String 0 Código do ProdutoUNMCod String 0 Código da Unidade de Medida do

ProdutoUNICod String 0 Código da Unidade OrçamentáriaUNITPOCod String 0 Código do Tipo de Unidade

OrçamentáriaESFCod String 0 Código da Esfera da AçãoFUNCod String 0 Código da FunçãoSFUCod String 0 Código da SubFunçãoSITCodEstagio String 0 Código da Situação do EstágioSITCodAndamento String 0 Código da Situação do AndamentoSITCodCronograma String 0 Código da Situação do

CronogramaACAPercExecucao String 0 Percentual de Execução da Ação

Page 18: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

ACADsc String 0 Título da AçãoSACDsc String 0 Descrição do LocalizadorACAFinalidade String 0 Finalidade da AçãoACADescricao String 0 Descrição da AçãoACASNMetaNaoCumulativa String 0 Indica se a ação é cumulativa ou

nãoACAMesInicio String 0 Data do Mês de Início da

execução da Ação (para ações dosórgãos 12000, 14000, 15000,34000 e 39000 o mês de início éreferente ao localizador)

ACAAnoInicio String 0 Data do Ano de Início daexecução da Ação (para ações dosórgãos 12000, 14000, 15000,34000 e 39000 o ano de início éreferente ao localizador)

ACAMesTermino String 0 Data do Mês de Término daexecução da Ação (para ações dosórgãos 12000, 14000, 15000,34000 e 39000 o mês de término éreferente ao localizador)

ACAAnoTermino String 0 Data do Ano de Término daexecução da Ação (para ações dosórgãos 12000, 14000, 15000,34000 e 39000 o ano de término éreferente ao localizador)

ACADscSituacaoAtual String 0 Descrição da situação atual daação

ACAMesPrevisaoConclusao String 0 Mês previsto para conclusão daação/localizador (somentedisponível para ações do tipoprojeto). Esta é a previsão atualde conclusão.

ACAAnoPrevisaoConclusao String 0 Ano previsto para conclusão daação/localizador (somentedisponível para ações do tipoprojeto). Esta é a previsão atualde conclusão.

ACASNRap String 0 Indicação de ação do tipo RAPACASNMEDesc String 0 Indicação de Forma de

implementação do tipoDescentralizada

ACASNMELinCred String 0 Indicação de Forma deimplementação do tipo Linha deCrédito

ACASNTransfObrigatoria String 0 Indicação de Forma deimplementação do tipotransferências obrigatórias

Page 19: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

ACASNTransfVoluntaria String 0 Indicação de Forma deimplementação do tipotransferências volutárias

ACASNTransfOutras String 0 Indicação de Forma deimplementação do tipotransferências “outras”

ACASNMEDireta String 0 Indicação de Forma deimplementação do tipo Direta

ACAVlrCustoProjeto String 0 Custo total do projeto (para açõesdo tipo projeto) (para ações dosórgãos 12000, 14000, 15000,34000 e 39000 o custo total doprojeto é referente ao localizador)

ACADetalhamentoFormaImplementacao

String 0 Detalhamento da forma deimplementação

ACAUnidadeAdminResponsavel String 0 Código da unidade administrativaresponsável

ACACoordenador String 0 Código do usuário coordenadorda ação

ACAComentarioExecucao1 String 0 Comentário da ação para janeiroACAComentarioExecucao2 String 0 Comentário da ação para

fevereiroACAComentarioExecucao3 String 0 Comentário da ação para marçoACAComentarioExecucao4 String 0 Comentário da ação para abrilACAComentarioExecucao5 String 0 Comentário da ação para maioACAComentarioExecucao6 String 0 Comentário da ação para junhoACAComentarioExecucao7 String 0 Comentário da ação para julhoACAComentarioExecucao8 String 0 Comentário da ação para agostoACAComentarioExecucao9 String 0 Comentário da ação para

setembroACAComentarioExecucao10 String 0 Comentário da ação para outubroACAComentarioExecucao11 String 0 Comentário da ação para

novembroACAComentarioExecucao12 String 0 Comentário da ação para

dezembroACADscComentarios String 0 Comentário geral ACADscComentExecFisicaBGU String 0 Comentário da execução física

BGUACADscComentExecFinanceiraBGU

String 0 Comentário da execuçãofinanceira BGU

ACADscComentExecucao String 0 Comentários gerais da execuçãoACAUsuCodAlt String 0 Código do usuário que realizou

última alteração na açãoACADataAlt String 0 Data da última alteração na AçãoACASisSiglaAlt String 0 Sigla do sistema a realizar a

alteração. Não é fornecido peloInfrasig

Page 20: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

DadosFinanceirosCategoriaGND List 0 Valores financeiros da açãoagrupados por categoriaeconômica e grupo de natureza dedespesa. Ver os atributos natabela a seguir.

O atributo do tipo List será listado abaixo:

2.3.6.4.4.1DadosFinanceirosCategoriaGND

Parâmetro Tipo Ocorrência mínima ObservaçõesCATCod String 0 Código da categoria econômicaGNDCod String 0 Código do grupo de natureza de

despesaFINVLRPREVISTOANO String 0 Valor financeiro previsto na LOAFINVLRATUALANO String 0 Valor financeiro previsto na LOA mais

créditosFINVLRPAGOANO String 0 Valor financeiro pagoFINVLREMPENHADOANO String 0 Valor financeiro empenhadoFINVLRREALIZADOANO String 0 Valor financeiro empenhado realizado

2.3.6.4.5 DadoFisico

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo, geradopelo SIGPlan. Este código não é,necessariamente, o mesmo código dolocalizador de gasto

REGCod String 0 Código da RegiãoFISQtdeCronInicial1 String 0 Quantidade inicial previsto para JaneiroFISQtdeCronInicial2 String 0 Quantidade inicial previsto para

FevereiroFISQtdeCronInicial3 String 0 Quantidade inicial previsto para MarçoFISQtdeCronInicial4 String 0 Quantidade inicial previsto para AbrilFISQtdeCronInicial5 String 0 Quantidade inicial previsto para MaioFISQtdeCronInicial6 String 0 Quantidade inicial previsto para JunhoFISQtdeCronInicial7 String 0 Quantidade inicial previsto para JulhoFISQtdeCronInicial8 String 0 Quantidade inicial previsto para AgostoFISQtdeCronInicial9 String 0 Quantidade inicial previsto para

SetembroFISQtdeCronInicial10 String 0 Quantidade inicial previsto para

Page 21: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

OutubroFISQtdeCronInicial11 String 0 Quantidade inicial previsto para

NovembroFISQtdeCronInicial12 String 0 Quantidade inicial previsto para

DezembroFISQtdeCronogramado1 String 0 Quantidade prevista atual/corrigida

para JaneiroFISQtdeCronogramado2 String 0 Quantidade prevista atual/corrigida

para FevereiroFISQtdeCronogramado3 String 0 Quantidade prevista atual/corrigida

para MarçoFISQtdeCronogramado4 String 0 Quantidade prevista atual/corrigida

para AbrilFISQtdeCronogramado5 String 0 Quantidade prevista atual/corrigida

para MaioFISQtdeCronogramado6 String 0 Quantidade prevista atual/corrigida

para JunhoFISQtdeCronogramado7 String 0 Quantidade prevista atual/corrigida

para JulhoFISQtdeCronogramado8 String 0 Quantidade prevista atual/corrigida

para AgostoFISQtdeCronogramado9 String 0 Quantidade prevista atual/corrigida

para SetembroFISQtdeCronogramado10 String 0 Quantidade prevista atual/corrigida

para OutubroFISQtdeCronogramado11 String 0 Quantidade prevista atual/corrigida

para NovembroFISQtdeCronogramado12 String 0 Quantidade prevista atual/corrigida

para DezembroFISQtdeRealizado1 String 0 Quantidade realizada em JaneiroFISQtdeRealizado2 String 0 Quantidade realizada em FevereiroFISQtdeRealizado3 String 0 Quantidade realizada em MarçoFISQtdeRealizado4 String 0 Quantidade realizada em AbrilFISQtdeRealizado5 String 0 Quantidade realizada em MaioFISQtdeRealizado6 String 0 Quantidade realizada em JunhoFISQtdeRealizado7 String 0 Quantidade realizada em JulhoFISQtdeRealizado8 String 0 Quantidade realizada em AgostoFISQtdeRealizado9 String 0 Quantidade realizada em SetembroFISQtdeRealizado10 String 0 Quantidade realizada em OutubroFISQtdeRealizado11 String 0 Quantidade realizada em NovembroFISQtdeRealizado12 String 0 Quantidade realizada em DezembroFISQtdeCronInicialAno String 0 Quantidade inicial prevista para o anoFISQtdeAtualAno String 0 Quantidade atual do ano (LOA +

Créditos em ações orçamentárias, e PPAnas ações não-orçamentárias).

FISQtdeCronogramadoAno String 0 Quantidade prevista atual/corrigidapara o ano

Page 22: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

FISQtdeRealizadoAno String 0 Quantidade realizada para o anoFISUsuCodAlt String 0 Código do Usuário que realizou a última

alteração neste dado físicoFISDataAlt String 0 Data da última alteração deste dado

físico

2.3.6.4.6 DadoFinanceiro

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo, geradopelo SIGPlan. Este código não é,necessariamente, o mesmo código dolocalizador de gasto

FPPCod String 0 Código da Fonte PPAREGCod String 0 Código da RegiãoFINVlrCronInicial1 String 0 Valor inicial previsto para JaneiroFINVlrCronInicial2 String 0 Valor inicial previsto para FevereiroFINVlrCronInicial3 String 0 Valor inicial previsto para MarçoFINVlrCronInicial4 String 0 Valor inicial previsto para AbrilFINVlrCronInicial5 String 0 Valor inicial previsto para MaioFINVlrCronInicial6 String 0 Valor inicial previsto para JunhoFINVlrCronInicial7 String 0 Valor inicial previsto para JulhoFINVlrCronInicial8 String 0 Valor inicial previsto para AgostoFINVlrCronInicial9 String 0 Valor inicial previsto para SetembroFINVlrCronInicial10 String 0 Valor inicial previsto para OutubroFINVlrCronInicial11 String 0 Valor inicial previsto para NovembroFINVlrCronInicial12 String 0 Valor inicial previsto para DezembroFINVlrCronogramado1 String 0 Valor previsto atual/corrigido para

JaneiroFINVlrCronogramado2 String 0 Valor previsto atual/corrigido para

FevereiroFINVlrCronogramado3 String 0 Valor previsto atual/corrigido para

MarçoFINVlrCronogramado4 String 0 Valor previsto atual/corrigido para AbrilFINVlrCronogramado5 String 0 Valor previsto atual/corrigido para

MaioFINVlrCronogramado6 String 0 Valor previsto atual/corrigido para

JunhoFINVlrCronogramado7 String 0 Valor previsto atual/corrigido para

JulhoFINVlrCronogramado8 String 0 Valor previsto atual/corrigido para

AgostoFINVlrCronogramado9 String 0 Valor previsto atual/corrigido para

Page 23: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

SetembroFINVlrCronogramado10 String 0 Valor previsto atual/corrigido para

OutubroFINVlrCronogramado11 String 0 Valor previsto atual/corrigido para

NovembroFINVlrCronogramado12 String 0 Valor previsto atual/corrigido para

DezembroFINVlrRealizado1 String 0 Valor realizado em Janeiro. Este campo

é obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado2 String 0 Valor realizado em Fevereiro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado3 String 0 Valor realizado em Março. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado4 String 0 Valor realizado em Abril. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado5 String 0 Valor realizado em Maio. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado6 String 0 Valor realizado em Junho. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado7 String 0 Valor realizado em Julho. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado8 String 0 Valor realizado em Agosto. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado9 String 0 Valor realizado em Setembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado10 String 0 Valor realizado em Outubro. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado11 String 0 Valor realizado em Novembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado12 String 0 Valor realizado em Dezembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrEmpenhado1 String 0 Valor empenhado em JaneiroFINVlrEmpenhado2 String 0 Valor empenhado em FevereiroFINVlrEmpenhado3 String 0 Valor empenhado em MarçoFINVlrEmpenhado4 String 0 Valor empenhado em AbrilFINVlrEmpenhado5 String 0 Valor empenhado em Maio

Page 24: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

FINVlrEmpenhado6 String 0 Valor empenhado em JunhoFINVlrEmpenhado7 String 0 Valor empenhado em JulhoFINVlrEmpenhado8 String 0 Valor empenhado em AgostoFINVlrEmpenhado9 String 0 Valor empenhado em SetembroFINVlrEmpenhado10 String 0 Valor empenhado em OutubroFINVlrEmpenhado11 String 0 Valor empenhado em NovembroFINVlrEmpenhado12 String 0 Valor empenhado em DezembroFINVlrPago1 String 0 Valor pago em JaneiroFINVlrPago2 String 0 Valor pago em FevereiroFINVlrPago3 String 0 Valor pago em MarçoFINVlrPago4 String 0 Valor pago em AbrilFINVlrPago5 String 0 Valor pago em MaioFINVlrPago6 String 0 Valor pago em JunhoFINVlrPago7 String 0 Valor pago em JulhoFINVlrPago8 String 0 Valor pago em AgostoFINVlrPago9 String 0 Valor pago em SetembroFINVlrPago10 String 0 Valor pago em OutubroFINVlrPago11 String 0 Valor pago em NovembroFINVlrPago12 String 0 Valor pago em DezembroFINVlrContratado1 String 0 Valor contratado em Janeiro. Este

campo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrContratado2 String 0 Valor contratado em Fevereiro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrContratado3 String 0 Valor contratado em Março. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado4 String 0 Valor contratado em Abril. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado5 String 0 Valor contratado em Maio. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado6 String 0 Valor contratado em Junho. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado7 String 0 Valor contratado em Julho. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado8 String 0 Valor contratado em Agosto. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrContratado9 String 0 Valor contratado em Setembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrContratado10 String 0 Valor contratado em Outubro. Este

Page 25: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

campo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrContratado11 String 0 Valor contratado em Novembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrContratado12 String 0 Valor contratado em Dezembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrPrevistoAno String 0 Valor previsto para o ano na LeiOrçamentária (LOA) ou no PPA (nocaso de ações não-orçamentárias)

FINVlrAtualAno String 0 Valor atual do ano (LOA + Créditos emações orçamentárias, e PPA nas açõesnão-orçamentárias)

FINUsuCodAlt String 0 Código do último usuário a fazeralteração no dado financeiro

FINDataAlt String 0 Data da última atualização do dadofinanceiro

FINDataSIAFI String 0 Data de referência SIAFI (esferas 10 e20)

FINDataSIEST String 0 Data de referência SIEST (esfera 30)

2.3.6.4.7 DadoFisicoRAP

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo, geradopelo SIGPlan. Este código não é,necessariamente, o mesmo código dolocalizador de gasto

REGCod String 0 Código da RegiãoFISQtdeCronInicial1 String 0 Quantidade inicial previsto para JaneiroFISQtdeCronInicial2 String 0 Quantidade inicial previsto para

FevereiroFISQtdeCronInicial3 String 0 Quantidade inicial previsto para MarçoFISQtdeCronInicial4 String 0 Quantidade inicial previsto para AbrilFISQtdeCronInicial5 String 0 Quantidade inicial previsto para MaioFISQtdeCronInicial6 String 0 Quantidade inicial previsto para JunhoFISQtdeCronInicial7 String 0 Quantidade inicial previsto para JulhoFISQtdeCronInicial8 String 0 Quantidade inicial previsto para AgostoFISQtdeCronInicial9 String 0 Quantidade inicial previsto para

SetembroFISQtdeCronInicial10 String 0 Quantidade inicial previsto para

Page 26: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

OutubroFISQtdeCronInicial11 String 0 Quantidade inicial previsto para

NovembroFISQtdeCronInicial12 String 0 Quantidade inicial previsto para

DezembroFISQtdeCronogramado1 String 0 Quantidade prevista atual/corrigida

para JaneiroFISQtdeCronogramado2 String 0 Quantidade prevista atual/corrigida

para FevereiroFISQtdeCronogramado3 String 0 Quantidade prevista atual/corrigida

para MarçoFISQtdeCronogramado4 String 0 Quantidade prevista atual/corrigida

para AbrilFISQtdeCronogramado5 String 0 Quantidade prevista atual/corrigida

para MaioFISQtdeCronogramado6 String 0 Quantidade prevista atual/corrigida

para JunhoFISQtdeCronogramado7 String 0 Quantidade prevista atual/corrigida

para JulhoFISQtdeCronogramado8 String 0 Quantidade prevista atual/corrigida

para AgostoFISQtdeCronogramado9 String 0 Quantidade prevista atual/corrigida

para SetembroFISQtdeCronogramado10 String 0 Quantidade prevista atual/corrigida

para OutubroFISQtdeCronogramado11 String 0 Quantidade prevista atual/corrigida

para NovembroFISQtdeCronogramado12 String 0 Quantidade prevista atual/corrigida

para DezembroFISQtdeRealizado1 String 0 Quantidade realizada em JaneiroFISQtdeRealizado2 String 0 Quantidade realizada em FevereiroFISQtdeRealizado3 String 0 Quantidade realizada em MarçoFISQtdeRealizado4 String 0 Quantidade realizada em AbrilFISQtdeRealizado5 String 0 Quantidade realizada em MaioFISQtdeRealizado6 String 0 Quantidade realizada em JunhoFISQtdeRealizado7 String 0 Quantidade realizada em JulhoFISQtdeRealizado8 String 0 Quantidade realizada em AgostoFISQtdeRealizado9 String 0 Quantidade realizada em SetembroFISQtdeRealizado10 String 0 Quantidade realizada em OutubroFISQtdeRealizado11 String 0 Quantidade realizada em NovembroFISQtdeRealizado12 String 0 Quantidade realizada em DezembroFISQtdeCronInicialAno String 0 Quantidade inicial prevista para o anoFISQtdeCronogramadoAno String 0 Quantidade prevista atual/corrigida

para o anoFISQtdeRealizadoAno String 0 Quantidade realizada para o anoFISUsuCodAlt String 0 Código do Usuário que realizou a última

alteração neste dado físico

Page 27: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

FISDataAlt String 0 Data da última alteração deste dadofísico

2.3.6.4.8 DadoFinanceiroRAP

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo, geradopelo SIGPlan. Este código não é,necessariamente, o mesmo código dolocalizador de gasto

FPPCod String 0 Código da Fonte PPAREGCod String 0 Código da RegiãoFINVlrCronInicial1 String 0 Valor inicial previsto para JaneiroFINVlrCronInicial2 String 0 Valor inicial previsto para FevereiroFINVlrCronInicial3 String 0 Valor inicial previsto para MarçoFINVlrCronInicial4 String 0 Valor inicial previsto para AbrilFINVlrCronInicial5 String 0 Valor inicial previsto para MaioFINVlrCronInicial6 String 0 Valor inicial previsto para JunhoFINVlrCronInicial7 String 0 Valor inicial previsto para JulhoFINVlrCronInicial8 String 0 Valor inicial previsto para AgostoFINVlrCronInicial9 String 0 Valor inicial previsto para SetembroFINVlrCronInicial10 String 0 Valor inicial previsto para OutubroFINVlrCronInicial11 String 0 Valor inicial previsto para NovembroFINVlrCronInicial12 String 0 Valor inicial previsto para DezembroFINVlrCronogramado1 String 0 Valor previsto atual/corrigido para

JaneiroFINVlrCronogramado2 String 0 Valor previsto atual/corrigido para

FevereiroFINVlrCronogramado3 String 0 Valor previsto atual/corrigido para

MarçoFINVlrCronogramado4 String 0 Valor previsto atual/corrigido para AbrilFINVlrCronogramado5 String 0 Valor previsto atual/corrigido para

MaioFINVlrCronogramado6 String 0 Valor previsto atual/corrigido para

JunhoFINVlrCronogramado7 String 0 Valor previsto atual/corrigido para

JulhoFINVlrCronogramado8 String 0 Valor previsto atual/corrigido para

AgostoFINVlrCronogramado9 String 0 Valor previsto atual/corrigido para

SetembroFINVlrCronogramado10 String 0 Valor previsto atual/corrigido para

Page 28: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

OutubroFINVlrCronogramado11 String 0 Valor previsto atual/corrigido para

NovembroFINVlrCronogramado12 String 0 Valor previsto atual/corrigido para

DezembroFINVlrRealizado1 String 0 Valor realizado em Janeiro. Este campo

é obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado2 String 0 Valor realizado em Fevereiro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado3 String 0 Valor realizado em Março. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado4 String 0 Valor realizado em Abril. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado5 String 0 Valor realizado em Maio. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado6 String 0 Valor realizado em Junho. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado7 String 0 Valor realizado em Julho. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado8 String 0 Valor realizado em Agosto. Este campo éobrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado9 String 0 Valor realizado em Setembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado10 String 0 Valor realizado em Outubro. Este campoé obrigatório somente para ações do tipo"Não Orçamentária"

FINVlrRealizado11 String 0 Valor realizado em Novembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrRealizado12 String 0 Valor realizado em Dezembro. Estecampo é obrigatório somente para açõesdo tipo "Não Orçamentária"

FINVlrCancelado1 String 0 Valor cancelado em JaneiroFINVlrCancelado2 String 0 Valor cancelado em FevereiroFINVlrCancelado3 String 0 Valor cancelado em MarçoFINVlrCancelado4 String 0 Valor cancelado em AbrilFINVlrCancelado5 String 0 Valor cancelado em MaioFINVlrCancelado6 String 0 Valor cancelado em JunhoFINVlrCancelado7 String 0 Valor cancelado em Julho

Page 29: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

FINVlrCancelado8 String 0 Valor cancelado em AgostoFINVlrCancelado9 String 0 Valor cancelado em SetembroFINVlrCancelado10 String 0 Valor cancelado em OutubroFINVlrCancelado11 String 0 Valor cancelado em NovembroFINVlrCancelado12 String 0 Valor cancelado em DezembroFINVlrInscLiquidoAno String 0 Valor inscrito líquido no anoFINVlrInscAno String 0 Valor inscrito no ano (LOA + Créditos

em ações orçamentárias, e PPA nasações não-orçamentárias)

FINUsuCodAlt String 0 Código do último usuário a fazeralteração no dado financeiro

FINDataAlt String 0 Data da última atualização do dadofinanceiro

FINDataSIAFI String 0 Data de referência SIAFI (esferas 10 e20)

2.3.6.4.9 RestricaoAcao

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoSACCod String 0 Código interno de identificação do

localizador de gasto/subtítulo, geradopelo SIGPlan. Este código não é,necessariamente, o mesmo código dolocalizador de gasto

TRSCod String 0 Código do Tipo de RestriçãoRSINum String 0 Código de restrição do InfrasigRSANum String 0 Código sequencial da restriçãoRSADataInclusao String 0 Data da inclusão da restrição da açãoRSADscRestricao String 0 Descrição (detalhamento) da restriçãoRSADscProvidencia String 0 Descrição (detalhamento) da providênciaRSADataSuperacao String 0 Data de superação da restriçãoRSAUsuCodAlt String 0 Código do usuário que realizou a última

atualização na restrição da açãoRSADataAlt String 0 Data da última alteração da restrição da

açãoSubcategorias List 0 Lista com subcategorias da restrição. Ver

definição a seguir. (ver descrição dostipos no método de exportaçãoSubcategoriaRestricao)

O atributo do tipo List será listado abaixo:

2.3.6.4.9.1Subcategorias

Page 30: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Parâmetro Tipo Ocorrência mínima ObservaçõesSUBTRSCod String 0 Código da subcategoria da restrição

2.3.7 Geração por Localizador

2.3.7.1 GeracaoPorLocalizadorExportação de dados por localizador

2.3.7.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaACACod String 0 Código da AçãoreceberAcao Boolean 1 Indicação para retorno do conjunto

de dados Acao. O valor deve ser true(retorna o conjunto de dados) ou false(não retorna o conjunto de dados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjuntode dados RestricaoAcao. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFisico Boolean 1 Indicação para retorno do conjuntode dados DadoFisico. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFinanceiro Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiro. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFisicoRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiroRAP. Ovalor deve ser true (retorna oconjunto de dados) ou false (não

Page 31: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

retorna o conjunto de dados).

2.3.7.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

ArrayOfPrograma Programa 0 Um array contendo todos osprogramas retornados a partir dosdados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma

RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dados deentrada

ArrayOfAcao Acao 0 Um array contendo todas os açõesretornados a partir dos dados deentrada. Só virá com dados se oparâmetro receberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados a partirdos dados de entrada. Só virá comdados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro for true.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP for true.

ArrayOfDadoFinanceiroRAP

DadoFinanceiroRAP

0 Um array contendo todos osdados financeiros RAP retornadosa partir dos dados de entrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Os tipos complexos desta operação do Web Service são idênticos aos da operação de GeracaoPorAcao eestão listados dentro da seção 2.4.6.4 Tipo(s) Complexo(s).

Page 32: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.8 Geração por Orgão

2.3.8.1 GeracaoPorOrgaoExportação de dados por órgão

2.3.8.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaORGCod String 0 Código do ÓrgãoreceberPrograma Boolean 1 Indicação para retorno do conjunto de

dados Programa. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberIndicador Boolean 1 Indicação para retorno do conjunto dedados Indicador. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberRestricaoPrograma Boolean 1 Indicação para retorno do conjunto dedados RestricaoPrograma. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberAcao Boolean 1 Indicação para retorno do conjunto dedados Acao. O valor deve ser true(retorna o conjunto de dados) ou false(não retorna o conjunto de dados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjunto dedados RestricaoAcao. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFisico Boolean 1 Indicação para retorno do conjunto dedados DadoFisico. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberDadoFinanceiro Boolean 1 Indicação para retorno do conjunto dedados DadoFinanceiro. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjunto dedados DadoFisicoRAP. O valor deve

Page 33: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

ser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjunto dedados DadoFinanceiroRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

2.3.8.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

ArrayOfPrograma Programa 0 Um array contendo todos osprogramas retornados a partir dosdados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma

RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dados deentrada

ArrayOfAcao Acao 0 Um array contendo todas os açõesretornados a partir dos dados deentrada. Só virá com dados se oparâmetro receberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados a partirdos dados de entrada. Só virá comdados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro for true.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP for true.

ArrayOfDadoFinanceiroRAP

DadoFinanceiroRAP

0 Um array contendo todos osdados financeiros RAP retornadosa partir dos dados de entrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados a

Page 34: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

partir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Os tipos complexos desta operação do Web Service são idênticos aos da operação de GeracaoPorAcao eestão listados dentro da seção 2.4.6.4 Tipo(s) Complexo(s).

2.3.9 Geração por Programa

2.3.9.1 GeracaoPorProgramaExportação de dados por programa

2.3.9.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramareceberPrograma Boolean 1 Indicação para retorno do conjunto

de dados Programa. O valor deveser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberIndicador Boolean 1 Indicação para retorno do conjuntode dados Indicador. O valor deve sertrue (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberRestricaoPrograma Boolean 1 Indicação para retorno do conjuntode dados RestricaoPrograma. Ovalor deve ser true (retorna oconjunto de dados) ou false (nãoretorna o conjunto de dados).

receberAcao Boolean 1 Indicação para retorno do conjuntode dados Acao. O valor deve ser true(retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjuntode dados RestricaoAcao. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisico Boolean 1 Indicação para retorno do conjuntode dados DadoFisico. O valor deveser true (retorna o conjunto dedados) ou false (não retorna o

Page 35: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

conjunto de dados). receberDadoFinanceiro Boolean 1 Indicação para retorno do conjunto

de dados DadoFinanceiro. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFisicoRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiroRAP. Ovalor deve ser true (retorna oconjunto de dados) ou false (nãoretorna o conjunto de dados).

2.3.9.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

ArrayOfPrograma Programa 0 Um array contendo todos osprogramas retornados a partir dosdados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma

RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dados deentrada

ArrayOfAcao Acao 0 Um array contendo todas os açõesretornados a partir dos dados deentrada. Só virá com dados se oparâmetro receberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados a partirdos dados de entrada. Só virá comdados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro for true.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados a

Page 36: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

partir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP for true.

ArrayOfDadoFinanceiroRAP

DadoFinanceiroRAP

0 Um array contendo todos osdados financeiros RAP retornadosa partir dos dados de entrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Os tipos complexos desta operação do Web Service são idênticos aos da operação de GeracaoPorAcao eestão listados dentro da seção 2.4.6.4 Tipo(s) Complexo(s).

2.3.10Geração por Situação Programa

2.3.10.1 GeracaoPorSituacaoProgramaExportação de dados por situação programa

2.3.10.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaTRICod String 0 Código do Tribunal

2.3.10.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do ProgramaTRICod String 0 Código do TribunalSIPCod String 0 Código da Situação do ProgramaComentario String 0 Comentário da Situação Programa

2.3.11Geração por UO

2.3.11.1 GeracaoPorUOExportação de dados por unidade orçamentária

2.3.11.2 Parâmetro(s) de entrada

Page 37: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaUNICod String 0 Código da Unidade receberPrograma Boolean 1 Indicação para retorno do conjunto

de dados Programa. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberIndicador Boolean 1 Indicação para retorno do conjuntode dados Indicador. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberRestricaoPrograma Boolean 1 Indicação para retorno do conjuntode dados RestricaoPrograma. Ovalor deve ser true (retorna oconjunto de dados) ou false (nãoretorna o conjunto de dados).

receberAcao Boolean 1 Indicação para retorno do conjuntode dados Acao. O valor deve ser true(retorna o conjunto de dados) ou false(não retorna o conjunto de dados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjuntode dados RestricaoAcao. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisico Boolean 1 Indicação para retorno do conjuntode dados DadoFisico. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFinanceiro Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiro. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFisicoRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjuntode dados DadoFinanceiroRAP. Ovalor deve ser true (retorna oconjunto de dados) ou false (não

Page 38: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

retorna o conjunto de dados).

2.3.11.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

ArrayOfPrograma Programa 0 Um array contendo todos osprogramas retornados a partir dosdados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma

RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dados deentrada

ArrayOfAcao Acao 0 Um array contendo todas os açõesretornados a partir dos dados deentrada. Só virá com dados se oparâmetro receberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados a partirdos dados de entrada. Só virá comdados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro for true.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP for true.

ArrayOfDadoFinanceiroRAP

DadoFinanceiroRAP

0 Um array contendo todos osdados financeiros RAP retornadosa partir dos dados de entrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Os tipos complexos desta operação do Web Service são idênticos aos da operação de GeracaoPorAcao eestão listados dentro da seção 2.4.6.4 Tipo(s) Complexo(s).

Page 39: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.12Geração por UO Ação

2.3.12.1 GeracaoPorUOAcaoExportação de dados por Unidade Orçamentária/Ação

2.3.12.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuárioPRGAno String 0 Ano do ProgramaPRGCod String 0 Código do Programa ACACod String 0 Código da AçãoUNICod String 0 Código da Unidade OrçamentáriareceberAcao Boolean 1 Indicação para retorno do conjunto de

dados Acao. O valor deve ser true(retorna o conjunto de dados) ou false(não retorna o conjunto de dados).

receberRestricaoAcao Boolean 1 Indicação para retorno do conjunto dedados RestricaoAcao. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFisico Boolean 1 Indicação para retorno do conjunto dedados DadoFisico. O valor deve sertrue (retorna o conjunto de dados) oufalse (não retorna o conjunto dedados).

receberDadoFinanceiro Boolean 1 Indicação para retorno do conjunto dedados DadoFinanceiro. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFisicoRAP Boolean 1 Indicação para retorno do conjunto dedados DadoFisicoRAP. O valor deveser true (retorna o conjunto de dados)ou false (não retorna o conjunto dedados).

receberDadoFinanceiroRAP Boolean 1 Indicação para retorno do conjunto dedados DadoFinanceiroRAP. O valordeve ser true (retorna o conjunto dedados) ou false (não retorna oconjunto de dados).

2.3.12.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência Observações

Page 40: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

mínimaArrayOfPrograma Programa 0 Um array contendo todos os

programas retornados a partirdos dados de entrada

ArrayOfIndicador Indicador 0 Um array contendo todos osindicadores retornados a partirdos dados de entrada

ArrayOfRestricaoPrograma RestricaoPrograma 0 Um array contendo todas asrestrições de programaretornados a partir dos dadosde entrada

ArrayOfAcao Acao 0 Um array contendo todas osações retornados a partir dosdados de entrada. Só virá comdados se o parâmetroreceberAcao for true.

ArrayOfDadoFisico DadoFisico 0 Um array contendo todos osdados físicos retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisico for true.

ArrayOfDadoFinanceiro DadoFinanceiro 0 Um array contendo todos osdados financeiros retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFinanceiro fortrue.

ArrayOfDadoFisicoRAP DadoFisicoRAP 0 Um array contendo todos osdados físicos RAP retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberDadoFisicoRAP fortrue.

ArrayOfDadoFinanceiroRAP DadoFinanceiroRAP 0 Um array contendo todos osdados financeiros RAPretornados a partir dos dadosde entrada

ArrayOfRestricaoAcao RestricaoAcao 0 Um array contendo todas asrestrições de ação retornados apartir dos dados de entrada. Sóvirá com dados se o parâmetroreceberRestricaoAcao for true.

Os tipos complexos desta operação do Web Service são idênticos aos da operação de GeracaoPorAcao eestão listados dentro da seção 2.4.6.4 Tipo(s) Complexo(s).

Page 41: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.13Grupo Natureza

2.3.13.1 GrupoNaturezaBusca os dados da tabela Natureza

2.3.13.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 1 Login do Usuáriosenha String 1 Senha do Usuárioano String 1 Ano do(s) Grupo(s) Natureza(s) que se

deseja buscar

2.3.13.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosGrupoNatureza GrupoNatureza 0 Elemento GrupoNatureza com

seus dados

2.3.13.4 Tipo(s) Complexo(s)

2.3.13.4.1 GrupoNatureza

Parâmetro Tipo Ocorrência mínima ObservaçõesCATCod String 0 Código da Categoria EconômicaGNDCod String 0 Código do Grupo NaturezaGNDAno String 0 Ano do Grupo NaturezaGNDDsc String 0 Descrição do Grupo NaturezaGNDSNAtivo String 0 Indica se o Grupo Natureza está ativo

ou inativo. Valor do campo será 0 sefor inativo e 1 se for ativo

2.3.14Nível Acesso

2.3.14.1 NivelAcessoBusca Nível Acesso

2.3.14.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

Page 42: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.14.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosNivelAcesso NivelAcesso 0 Elemento NivelAcesso com seus

dados

2.3.14.4 Tipo(s) Complexo(s)

2.3.14.4.1 NivelAcesso

Parâmetro Tipo Ocorrência mínima ObservaçõesNIVCod String 0 Código do Nível de AcessoNIVDsc String 0 Descrição do Nível de Acesso

2.3.15Objetivo Governo

2.3.15.1 ObjetivoGovernoBusca os dados da tabela PPAObjetivoGoverno

2.3.15.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano do(s) Objetivo(s) do Governo(s)

que se deseja buscar

2.3.15.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

DadosObjetivoGoverno ObjetivoGoverno 0 Elemento ObjetivoGoverno comseus dados

2.3.15.4 Tipo(s) Complexo(s)

2.3.15.4.1 ObjetivoGoverno

Parâmetro Tipo Ocorrência mínima ObservaçõesOBJCod String 0 Código do Objetivo do GovernoOBJDsc String 0 Descrição do Objetivo do GovernoOBJAno String 0 Ano do Objetivo do Governo

Page 43: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.16Objetivo Setorial

2.3.16.1 ObjetivoSetorialBusca os dados da tabela Objetivos Setoriais

2.3.16.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano dos Objetivos Setoriais que se

deseja buscar

2.3.16.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosObjetivoSetorial ObjetivoSetorial 0 Elemento ObjetivoSetorial com

seus dados

2.3.16.4 Tipo(s) Complexo(s)

2.3.16.4.1 ObjetivoSetorial

Parâmetro Tipo Ocorrência mínima ObservaçõesDIRCod String 0 Código do Objetivo SetorialDIRNome String 0 Nome do Objetivo SetorialDIRAno String 0 Ano do Objetivo SetorialOBJCod String 0 Código do Objetivo de GovernoORGCod String 0 Código do Órgão OrçamentárioDIRSNAtivo String 0 Indica se o Objetivo Setorial está ativo

ou inativo. Valor do campo será 0 sefor inativo e 1 se for ativo

2.3.17Órgão Orçamentário

2.3.17.1 OrgaoOrcamentarioBusca os dados da tabela Órgão Orçamentário

2.3.17.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observações

Page 44: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

usuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano dos Órgão(s) Orçamentário(s)

que se deseja buscar

2.3.17.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosOrgao Orgao 0 Elemento Órgão com seus dados

2.3.17.4 Tipo(s) Complexo(s)

2.3.17.4.1 Orgao

Parâmetro Tipo Ocorrência mínima ObservaçõesORGAno String 0 Ano do Órgão OrçamentárioORGCod String 0 Código do Órgão OrçamentárioORGDsc String 0 Descrição do Órgão OrçamentárioTPOCod String 0 Tipo do Órgão Orçamentário

2.3.18Órgão Siorg

2.3.18.1 OrgaoSiorgBusca os dados da tabela Órgão siorg

2.3.18.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano do(s) Órgão(s) Siorg que se

deseja buscarOSICod String 0 Filtro pelo código do órgão SIORG.

Apenas o registro do código do órgãoSIORG informado será retornado.

2.3.18.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosOrgaoSiorg OrgaoSiorg 0 Elemento OrgaoSiorg com seus

dados

Page 45: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.18.4 Tipo(s) Complexo(s)

2.3.18.4.1 OrgaoSiorg

Parâmetro Tipo Ocorrência mínima ObservaçõesORGSiorgCod String 0 Código do Órgão SiorgORGSiorgDsc String 0 Descrição do Órgão Siorg

2.3.19Periodicidade

2.3.19.1 PeriodicidadeBusca os dados da tabela Periodicidade

2.3.19.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.19.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosPeridiciodade Periodicidade 0 Elemento Periodicidade com seus

dados

2.3.19.4 Tipo(s) Complexo(s)

2.3.19.4.1 Periodicidade

Parâmetro Tipo Ocorrência mínima ObservaçõesPERCod String 0 Código da PeriodicidadePERDsc String 0 Descrição da PeriodicidadePERSNAtivo String 0 Indica se a Periodicidade está ativa ou

inativa. Valor do campo será 0 se forinativa e 1 se for ativa

2.3.20Produto

2.3.20.1 ProdutoBusca os dados da tabela Produto

Page 46: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.20.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.20.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosProduto Produto 0 Elemento Produto com seus dados

2.3.20.4 Tipo(s) Complexo(s)

2.3.20.4.1 Produto

Parâmetro Tipo Ocorrência mínima ObservaçõesPROCod String 0 Código do ProdutoPRODsc String 0 Descrição do Produto

2.3.21Região

2.3.21.1 RegiaoBusca os dados da tabela Região

2.3.21.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.21.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesRegiao Regiao 0 Elemento Regiao com seus dados

2.3.21.4 Tipo(s) Complexo(s)

2.3.21.4.1 Regiao

Parâmetro Tipo Ocorrência mínima ObservaçõesREGCod String 0 Código da RegiãoREGDsc String 0 Descrição da Região

Page 47: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

REGMaeCod String 0 Código da Região na qual essa regiãoestá inserida.

2.3.22Situação Ação

2.3.22.1 SituacaoAcaoBusca os dados da tabela Situação Ação

2.3.22.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.22.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesSituacaoAcao SituacaoAcao 0 Elemento SituacaoAcao com seus

dados

2.3.22.4 Tipo(s) Complexo(s)

2.3.22.4.1 SituacaoAcao

Parâmetro Tipo Ocorrência mínima ObservaçõesSITCod String 0 Código da Situação AçãoSITDsc String 0 Descrição da Situação AçãoSITTipo String 0 Tipo da Situação Ação

2.3.23Situação Programa

2.3.23.1 SituacaoProgramaBusca os dados da tabela Situação Programa

2.3.23.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

Page 48: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.23.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesSituacaoPrograma SituacaoPrograma 0 Elemento SituacaoPrograma com

seus dados

2.3.23.4 Tipo(s) Complexo(s)

2.3.23.4.1 SituacaoPrograma

Parâmetro Tipo Ocorrência mínima ObservaçõesSIPCod String 0 Código da Situação ProgramaSIPDsc String 0 Descrição da Situação Programa

2.3.24Subcategoria Restrição

2.3.24.1 SubcategoriaRestricaoBusca os dados da tabela Subcategoria Restrição

2.3.24.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.24.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

SubcategoriaRestricao SubcategoriaRestricao 0 Elemento SubcategoriaRestricaocom seus dados

2.3.24.4 Tipo(s) Complexo(s)

2.3.24.4.1 SubcategoriaRestricao

Parâmetro Tipo Ocorrência mínima ObservaçõesSUBTRSCod String 0 Código da Subcategoria de RestriçãoTRSCod String 0 Código do Tipo de RestriçãoSUBTRSDsc String 0 Descrição da Subcategoria de Restrição

Page 49: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

2.3.25SubFunção

2.3.25.1 SubFuncaoBusca os dados da tabela SubFunção

2.3.25.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesano String 0 Ano das SubFunções que se deseja

buscarusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.25.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosSubFuncao SubFuncao 0 Elemento SubFuncao com seus

dados

2.3.25.4 Tipo(s) Complexo(s)

2.3.25.4.1 SubFuncao

Parâmetro Tipo Ocorrência mínima ObservaçõesSFUAno String 0 Ano da SubFunçãoSFUCod String 0 Código da SubFunçãoFUNCod String 0 Código da FunçãoSFUDsc String 0 Descrição da SubFunçãoSFUSNAtivo String 0 Indica se a SubFunção está ativa ou

inativa. Valor do campo será 0 se forinativa e 1 se for ativa

2.3.26Tipo Ação

2.3.26.1 TipoAcaoBusca os dados da tabela TipoAção

2.3.26.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuário

Page 50: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

senha String 0 Senha do Usuário

2.3.26.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosTipoAcao TipoAcao 0 Elemento TipoAcao com seus

dados

2.3.26.4 Tipo(s) Complexo(s)

2.3.26.4.1 TipoAcao

Parâmetro Tipo Ocorrência mínima ObservaçõesTACCod String 0 Código do Tipo de AçãoTACDsc String 0 Descrição do Tipo de AçãoTACSNAtivo String 0 Indica se o Tipo de Ação está ativo ou

inativo. Valor do campo será 0 se forinativo e 1 se for ativo

2.3.27Tipo Programa

2.3.27.1 TipoProgramaBusca os dados da tabela TipoPrograma

2.3.27.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.27.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosTipoPrograma TipoPrograma 0 Elemento TipoPrograma com seus

dados

2.3.27.4 Tipo(s) Complexo(s)

2.3.27.4.1 TipoPrograma

Parâmetro Tipo Ocorrência mínima ObservaçõesTPRCod String 0 Código do Tipo de Programa

Page 51: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

TPRNome String 0 Nome do Tipo de ProgramaTPRSNAtivo String 0 Indica se o Tipo de Programa está

ativo ou inativo. Valor do campo será0 se for inativo e 1 se for ativo

2.3.28Tipo Restrição

2.3.28.1 TipoRestricaoBusca os dados da tabela TipoRestrição

2.3.28.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.28.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosTipoRestricao TipoRestricao 0 Elemento TipoRestricao com seus

dados

2.3.28.4 Tipo(s) Complexo(s)

2.3.28.4.1 TipoRestricao

Parâmetro Tipo Ocorrência mínima ObservaçõesTRSCod String 0 Código do Tipo de RestriçãoTRSDsc String 0 Descrição do Tipo de RestriçãoTRSSNAtivo String 0 Indica se o Tipo de Restrição está

ativo ou inativo. Valor do campo será0 se for inativo e 1 se for ativo

2.3.29Unidade Medida

2.3.29.1 UnidadeMedidaBusca os dados da tabela Unidade de Medida

2.3.29.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observações

Page 52: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

usuario String 0 Login do Usuáriosenha String 0 Senha do Usuário

2.3.29.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosUnidadeMedida UnidadeMedida 0 Elemento UnidadeMedida com

seus dados

2.3.29.4 Tipo(s) Complexo(s)

2.3.29.4.1 UnidadeMedida

Parâmetro Tipo Ocorrência mínima ObservaçõesUNMCod String 0 Código da Unidade de MedidaUNMDsc String 0 Descrição da Unidade de Medida

2.3.30Unidade Orçamentária

2.3.30.1 UnidadeOrcamentariaBusca os dados da tabela Unidade Orçamentária

2.3.30.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do Usuárioano String 0 Ano das Unidade(s) Orçamentária(s)

que se deseja buscar

2.3.30.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrênciamínima

Observações

DadosUnidade UnidadeOrcamentaria 0 Elemento UnidadeOrcamentariacom seus dados

2.3.30.4 Tipo(s) Complexo(s)

2.3.30.4.1 UnidadeOrcamentaria

Parâmetro Tipo Ocorrência mínima Observações

Page 53: SIGPlan - Catálogo de Interoperabilidadecatalogo.governoeletronico.gov.br/arquivos/Documentos/SIGPLAN... · ou algum outro tipo de erro, o Web Service não retorna um XML e sim uma

MPOGSPI

UNIAno String 0 Ano da Unidade OrçamentáriaUNICod String 0 Código da Unidade OrçamentáriaORGCod String 0 Código do Órgão OrçamentárioUNIDsc String 0 Descrição da Unidade OrçamentáriaTPOCod String 0 Código do Tipo de Órgão

OrçamentárioUNITpoCod String 0 Código do Tipo de Unidade

Orçamentária

2.3.31Usuário

2.3.31.1 UsuarioBusca os dados da tabela Usuário

2.3.31.2 Parâmetro(s) de entrada

Parâmetro Tipo Ocorrência mínima Observaçõesusuario String 0 Login do Usuáriosenha String 0 Senha do UsuáriousuCod String 0 Código do Usuário

2.3.31.3 Parâmetro(s) de saída

Parâmetro Tipo Ocorrência mínima ObservaçõesDadosUsuario Usuario 0 Elemento Usuario com seus dados

2.3.31.4 Tipo(s) Complexo(s)

2.3.31.4.1 Usuario

Parâmetro Tipo Ocorrência mínima ObservaçõesUSUCod String 0 Código do UsuárioUSUNome String 0 Nome do UsuárioUSUTelComercial String 0 Telefone Comercial do UsuárioUSUTelFAX String 0 Telefone do Fax do UsuárioUSUCodOrgao String 0 Código do Órgão no qual o usuário

está cadastradoUSUDscSecretaria String 0 Descrição da Secretaria do UsuárioUSUDscCargoFuncao String 0 Descrição do Cargo/Função do

UsuárioUSUEmail String 0 E-mail do Usuário