====== Web Service Qualitativo do SIOP (WSQualitativo) ======

====== Informações Gerais ======

==== Serviço ====

| Nome: | Web Service Qualitativo do SIOP |
| Nome na interface: | WSQualitativo |
| Início da operação: | 29/02/2012 |
| Endereço do WSDL - Testes | https://testews.siop.gov.br/services/WSQualitativo?wsdl |
| Endereço do WSDL - Produção | https://webservice.siop.gov.br/services/WSQualitativo?wsdl |

==== Objetivo ====

Fornecer uma interface que possibilite a interoperabilidade entre os IntraSigs e o SIOP para a consulta de dados referentes à fase qualitativa das Unidades Orçamentárias e Órgãos Setoriais. Este WS possui basicamente métodos para consulta.

===== Operações =====

==== Obter ação por identificador único ====

**Nome da operação na interface do serviço:**
obterAcaoPorIdentificadorUnico

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoMomento | Integer | |
| identificadorUnico | Integer | Identificador único da ação (ver AcaoDTO). |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#retornoacoesdto|RetornoAcoesDTO]]

==== Obter ações por iniciativa ====

**Nome da operação na interface do serviço:**
obterAcoesPorIniciativa

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | |
| codigoObjetivo | String(4) | |
| codigoIniciativa | String(4) | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obterindicadoresporprograma|RetornoAcoesDTO]]

==== Obter ações por programa ====

**Nome da operação na interface do serviço:**
obterAcoesPorPrograma

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obteracoesporprograma|RetornoAcoesDTO]]

==== Obter financiamento extra-orçamentário por iniciativa ====

**Nome da operação na interface do serviço:**
obterFinanciamentoExtraOrcamentarioPorIniciativa

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | |
| codigoObjetivo | String(4) | |
| codigoIniciativa | String(4) | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obterfinanciamentoextraorcamentarioporiniciativa|RetornoFinanciamentoExtraOrcamentarioDTO]]

==== Obter indicadores por programa ====

**Nome da operação na interface do serviço:**
obterIndicadoresPorPrograma

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obterindicadoresporprograma|RetornoIndicadoresDTO]]

==== Obter iniciativas por objetivo ====

**Nome da operação na interface do serviço:**
obterIniciativasPorObjetivo

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoObjetivo | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obteriniciativasporobjetivo|RetornoIniciativasDTO]]

==== Obter localizadores por ação ====

**Nome da operação na interface do serviço:**
obterLocalizadoresPorAcao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| identificadorUnicoAcao | Integer | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obterlocalizadoresporacao|RetornoLocalizadoresDTO]]

==== Obter medidas institucionais por iniciativa ====

**Nome da operação na interface do serviço:**
obterMedidaInstitucionalPorIniciativa

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoObjetivo | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoIniciativa | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
[[webservices:manual-wsqualitativo#obtermedidainstitucionalporiniciativa|RetornoMedidaInstitucionalNormativaDTO]]

==== Obter metas por objetivo ====

**Nome da operação na interface do serviço:**
obterMetasPorObjetivo

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoObjetivo | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoMetasDTO

==== Obter momento carga ====
Busca, na tabela Ação, o Momento válido para carga tendo como parâmetro o exercício informado.

**Nome da operação na interface do serviço:**
obterMomentoCarga

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |

**Tipo de Retorno:**
RetornoMomentoDTO

==== Obter objetivos por programa ====

**Nome da operação na interface do serviço:**
obterObjetivosPorPrograma

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(4) | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoObjetivosDTO

==== Obter órgão ====

**Nome da operação na interface do serviço:**
obterOrgao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoOrgao | String(5) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| tipoOrgao | Char(1) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. Domínio: U – Unidade Orçamentária; O – Órgão Setorial; S – Secretaria |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoOrgaosDTO

==== Obter órgão por código SIORG ====

**Nome da operação na interface do serviço:**
obterOrgaoPorCodigoSiorg

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoSiorg | String | |

**Tipo de Retorno:**
RetornoOrgaosDTO

==== Obter planos orçamentários por ação ====

**Nome da operação na interface do serviço:**
obterPlanosOrcamentariosPorAcao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoMomento | Integer | Opcional, caso não informado, o serviço assume a ação em seu momento atual. |
| identificadorUnicoAcao | Integer | |

**Tipo de Retorno:**
RetornoPlanoOrcamentarioDTO

==== Obter programação completa ====

**Nome da operação na interface do serviço:**
obterProgramacaoCompleta

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoMomento | Integer | |
| retornarOrgaos | Boolean | Retonar órgãos? |
| retornarProgramas | Boolean | Retonar programas? |
| retornarIndicadores | Boolean | Retonar indicadores? |
| retornarObjetivos | Boolean | Retonar objetivos? |
| retornarIniciativas | Boolean | Retonar iniciativas? |
| retornarAcoes | Boolean | Retonar ações? |
| retornarLocalizadores | Boolean | Retonar localizadores? |
| retornarMetas | Boolean | Retonar metas? |
| retornarRegionalizacoes | Boolean | Retonar regionalizações? |
| retornarPlanosOrcamentarios | Boolean | Retonar planos orçamentários? |
| retornarAgendasSam | Boolean | Retonar agendas SAM? |
| retornarMedidasInstitucionaisNormativas | Boolean | Retonar medidas institucionais normativas? |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoProgramacaoQualitativoDTO

**Observações:**
  * PO's só retornam se estiverem no mesmo momento que suas respectivas ações.

==== Obter programas por órgão ====

**Nome da operação na interface do serviço:**
obterProgramasPorOrgao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoOrgao | String(5) | |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoProgramasDTO

==== Obter regionalizações por meta ====

**Nome da operação na interface do serviço:**
obterRegionalizacoesPorMeta

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoPrograma | String(5) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoObjetivo | String(4) | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMeta | Integer | Opcional. Caso não informado a operação retornará os dados vinculados à credencial informada. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoRegionalizacoesDTO

==== Obter tabelas de apoio ====

**Nome da operação na interface do serviço:** obterTabelasApoio

**Parâmetro(s) de entrada:**

|**Parâmetro** |**Tipo(tamanho)** |**Observações** |
|credencial|CredencialDTO| |
|exercicio|Integer| |
|retornarMomentos|Boolean|Retonar momentos?|
|retornarEsferas|Boolean|Retonar esferas?|
|retornarTiposInclusao|Boolean|Retonar tipos de inclusão (origens)?|
|retornarFuncoes|Boolean|Retonar funções?|
|retornarSubFuncao|Boolean|Retonar sub-funções?|
|retornarTiposAcao|Boolean|Retonar tipos de ação?|
|retornarProdutos|Boolean|Retonar produtos?|
|retornarUnidadesMedida|Boolean|Retonar unidades de medida?|
|retornarRegioes|Boolean|Retonar regiões?|
|retornarPerfis|Boolean|Retonar perfis?|
|retornarTiposPrograma|Boolean|Retonar tipos de programa?|
|retornarMacroDesafios|Boolean|Retonar macro desafios?|
|retornarUnidadesMedidaIndicador|Boolean|Retonar unidades de medida de indicador?|
|retornarPeriodicidades|Boolean|Retonar periodicidades?|
|retornarBasesGeograficas|Boolean|Retonar bases geograficas?|
|retornarRecortesGeograficos|Boolean|Retonar recortes geográficos?|
|dataHoraReferencia|Date|Opcional. Data e hora a partir das quais se desejam as respostas.|

**Tipo de Retorno:** RetornoApoioQualitativoDTO

\\


==== Obter unidades orçamentárias por órgão ====

**Nome da operação na interface do serviço:**
obterUnidadesOrcamentariasOrgao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoOrgao | String(5) | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |

**Tipo de Retorno:**
RetornoOrgaosDTO

==== Obter ações por órgão ====

**Nome da operação na interface do serviço:**
obterAcoesPorOrgao

**Parâmetro(s) de entrada:**
| **Parâmetro** | **Tipo(tamanho)** | **Observações** |
| credencial | CredencialDTO | |
| exercicio | Integer | |
| codigoOrgao | String(5) | Opcional. Código do órgão das ações. |
| codigoUo | String(5) | Opcional. Código dda unidade orçamentária das ações. |
| codigoMomento | Integer | |
| dataHoraReferencia | Date | Opcional. Data e hora a partir das quais se desejam as respostas. |
| apenasAtuais| Boolean | Opcional. Retorna apenas os registros atuais |

**Tipo de Retorno:**
RetornoAcoesDTO

===== Estruturas de Entrada/Saída e Retorno =====

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

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

==== AcaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int|Identificador Único da Ação|
|exercicio|int|Ano de exercício. Caso não seja informado, utilizar o corrente.|
|codigoMomento|int|Código do Momento|
|baseLegal|string|   |
|codigoAcao|string|Código da Ação|
|codigoEsfera|string|Código da Esfera|
|codigoFuncao|string|Código da Função|
|codigoIniciativa|string|Código da Iniciativa|
|codigoObjetivo|string|Código do Objetivo|
|codigoOrgao|string|Código do Órgao|
|codigoProduto|int|Código do Produto|
|codigoPrograma|string|Código do Programa|
|codigoSubFuncao|string|Código da subfunção|
|codigoTipoAcao|string|Tipo da Ação|
|codigoTipoInclusaoAcao|int|Tipo de Inclusão da Ação|
|codigoUnidadeMedida|string|Código da Unidade de Medida do Produto|
|descricao|string|Descrição da ação|
|detalhamentoImplementação|string|Detalhamento da Implementação|
|especificacaoProduto|string|Especificação do Produto|
|finalidade|string|   |
|formaAcompanhamento|string|Forma de Acompanhamento|
|identificacaoSazonalidade|string|Indicador de sazonalidade|
|insumosUtilizados|string| |
|snDescentralizada|boolean|Indica forma de Implementação Descentralizada|
|snDireta|boolean|Indica forma de Implementação Direta|
|snLinhaCredito|boolean|Indica forma de Implementação Linha de Crédito|
|snTransferenciaObrigatoria|boolean|Indica forma de Implementação Transferência Obrigatória|
|snTransferenciaVoluntaria|boolean|Indica forma de Implementação Transferência Voluntária|
|titulo|string|Título da Ação|
|unidadeResponsavel|string|Código da Unidade Responsável pela Ação|
|dataHoraInclusao|dateTime|Data da inclusão da ação no banco|
|snExclusaoLogica|boolean|Indicador de exclusão|
|snRegionalizarNaExecucao|boolean|Consultar Manual Técnico do Orçamento|
|snAquisicaoInsumoEstrategico|boolean|Consultar Manual Técnico do Orçamento|
|snParticipacaoSocial|boolean|Indica se houve participação social na discussão da ação orçamentária.|
|snAcompanhamentoOpcional|boolean| |
|localizadores|Lista de LocalizadorDTO| |

==== AgendaSamDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoAgendaSam|int| |
|agendaSam|string| |
|descricao|string| |

==== CredencialDTO ====

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

|Atributo|Tipo(tamanho)|Observações|
|usuario|Texto|Login do usuário no SIOP|
|senha|Texto|Hash MD5 da senha do usuário no SIOP|
|perfil|Inteiro|Perfil com o qual o usuário deseja realizar determinada operação.|

==== EsferaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoEsfera|string| |
|dataHoraAlteracao|dateTime| |
|descricao|string| |
|descricaoAbreviada|string| |
|snAtivo|boolean|Flag indicador de registro ativo|
|snValorizacao|boolean| |

==== FinanciamentoExtraOrcamentarioDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|exercicio|Integer| |
|codigoFinanciamento|string| |
|identificadorUnico|Integer| |
|identificadorObjetivo|Integer| |
|identificadorIniciativa|Integer| |
|codigoMomento|Integer| |
|descricao|string| |
|produto|string| |
|valorTotal|Double| |
|custoTotal|Double| |
|valorAno1Ppa|Double| |
|valorAno2Ppa|Double| |
|valorAno3Ppa|Double| |
|valorAno4Ppa|Double| |
|snProjeto|Boolean| |
|dataInicio|Date| |
|dataTermino|Date| |
|fonteFinanciamento|string| |
|outraFonteFinanciamento|string| |
|codigoOrgaoSiorg|string| |

==== FuncaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoFuncao|string| |
|exercício|int| |
|dataHoraAlteracao|dateTime| |
|descricao|string| |
|descricaoAbreviada|string| |
|snAtivo|boolean| |

==== IndicadorDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercício|int| |
|codigoBaseGeografica|int| |
|codigoIndicador|int| |
|codigoPeriodicidade|int| |
|codigoPrograma|string| |
|codigoUnidadeMedidaIndicador|int|Código do Indicador da Unidade de Medida|
|dataApuracao|dateTime|Data da apuração do Indicador|
|descricao|string| |
|fonte|string| |
|formula|string| |
|snApuracaoReferencia|boolean| |
|ValorReferencia|decimal| |
|snExclusaoLogica|boolean|Indicador de exclusão.|

==== IniciativaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercício|int| |
|codigoIniciativa|string| |
|codigoObjetivo|string| |
|codigoOrgao|string| |
|codigoPrograma|string| |
|snIndividualizada|boolean|Indica Individualização da Iniciativa|
|titulo|string|Título da Ação|
|snExclusaoLogica|boolean|Indicador de exclusão.|

==== LocalizadorDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnicoAcao|int| |
|codigoMomento|int| |
|exercício|int| |
|codigoLocalizador|string| |
|codigoTipoInclusao|int| |
|mesAnoInicio|Date|Mês e ano de início do projeto|
|mesAnoTermino|Date|Mês e ano de término do projeto|
|descricao|string|Título do Localizador|
|justificativaRepercussao|string| |
|município|string|Código do Município|
|codigoRegiao|Integer|Código da Região (ver RegiaoDTO)|
|totalFinanceiro|double|Total Financeiro do Localizador|
|totalFisico|double|Total Físico do Localizador|
|uf|string|Sigla da UF|
|snExclusaoLogica|boolean|Indicador de exclusão.|
|snAcompanhamentoOpcional|boolean| |

==== MacroDesafioDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoMacroDesafio|int| |
|descricao|string| |
|titulo|string| |

==== MedidaInstitucionalNormativaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercício|int| |
|identificadorIniciativa|int| |
|descricao|string| |
|produto|string| |
|codigoOrgaoSiorg|string| |
|snExclusaoLogica|boolean|Indicador de exclusão.|

==== MetaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercício|int| |
|codigoMeta|string| |
|codigoObjetivo|string| |
|codigoPrograma|string| |
|descricao|string|Título da Meta|
|codigoOrgao|string| |
|snQuantificavel|boolean| |

==== MomentoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoMomento|int| |
|dataHoraAlteracao|dateTime| |
|descricao|string|Título da Meta|
|snAtivo|boolean|Flag indicador de registro ativo|

==== ObjetivoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercicio|int| |
|codigoObjetivo|string| |
|codigoOrgao|string| |
|codigoPrograma|string| |
|enunciado|string|Enunciado do Objetivo|
|snExclusaoLogica|boolean|Indicador de exclusão.|

==== OrgaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoOrgao|string| |
|exercicio|int| |
|tipoOrgao|string|Caractere que identifica o tipo de órgão ('U' para unidade orçamentária, 'O' para órgão setorial, 'S' para secretaria)|
|codigoOrgaoPai|string|Código do órgão-pai, se houver|
|descricao|string|Nome do Órgão|
|descricaoAbreviada|string|Nome Abreviado do Órgão|
|orgaoId|int|Identificador do Órgão|
|orgaoSiorg|string|Código do órgão Siorg|
|snAtivo|boolean|Flag indicador de registro ativo|

==== PerfilDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|perfilId|int| |
|descricao|string| |

==== PeriodicidadeDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoPeriodicidade|int| |
|descricao|string| |
|snAtivo|boolean|Flag indicador de registro ativo|

==== PlanoOrcamentarioDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|identificadorUnicoAcao|int|Identificador único (e não o código) da ação.|
|codigoMomento|int| |
|exercicio|int| |
|planoOrcamentario|Texto(4)|Código do plano orçamentário.|
|titulo|Texto| |
|detalhamento|Texto| |
|codigoUnidadeMedida|Texto|Os valores possíveis podem ser obtidos através da operação obterTabelasApoio do WSQualitativo.|
|codigoProduto|int|Os valores possíveis podem ser obtidos através da operação obterTabelasApoio do WSQualitativo.|
|codigoIndicadorPlanoOrcamentario|Texto(7)| |
|dataHora|dateTime| |

==== ProdutoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoProduto|int| |
|dataHoraAlteracao|dateTime| |
|descricao|string| |
|snAtivo|boolean|Flag indicador de registro ativo|

==== ProgramaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|identificadorUnico|int| |
|codigoMomento|int| |
|exercicio|int| |
|codigoMacroDesafio|int| |
|codigoPrograma|string| |
|codigoOrgao|string|Código do Órgão Responsável|
|codigoTipoPrograma|string| |
|estrategiaImplementacao|string| |
|horizonteTemporalContinuo|int| |
|justificativa|string| |
|objetivo|string| |
|objetivoGoverno|string| |
|objetivoSetorial|string| |
|problema|string| |
|publicoAlvo|string| |
|titulo|string| |
|unidadeResponsavel|string| |
|snExclusaoLogica|boolean|Indicador de exclusão.|

==== RecorteGeograficoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|recorteGeograficoId|int| |
|descricao|string| |
|regiaoId|int| |
|uf|string(2)|Sigla UF|
|municipio|string(7)|Código IBGE (7 dígitos) do Município |
|dataHoraAlteracao|Date| |

==== RegiaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoRegiao|int| |
|descricao|string| |
|sigla|string| |

==== RegionalizacaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|regionalizacaoId|int|Chave primária artificial do SIOP.|
|exercicio|int|Este campo faz parte da chave única de MetaDTO.|
|codigoMomento|int|Este campo faz parte da chave única de MetaDTO.|
|identificadorUnicoMeta|int|Este campo faz parte da chave única de MetaDTO.|
|codigoMeta|int| |
|codigoObjetivo|string| |
|codigoPrograma|string| |
|codigoUnidadeMedida|string| |
|descricao|string| |
|exercicio|int| |
|sigla|string| |
|valor|decimal| |
|codigoSubFuncao|string| |
|codigoFuncao|string| |
|dataHoraAlteracao|dateTime| |
|descricaoAbreviada|string| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== TipoAcaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoTipoAcao|string| |
|descricao|string| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== TipoInclusaoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoTipoInclusao|int| |
|dataHoraAlteracao|dateTime| |
|descricao|string| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== TipoProgramaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoTipoPrograma|string| |
|descricao|string| |
|exercicio|int| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== UnidadeMedidaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoUnidadeMedida|int| |
|dataHoraAlteracao|dateTime| |
|descricao|string| |
|simbolo|string| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== UnidadeMedidaIndicadorDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|codigoUnidadeMedidaIndicador|string| |
|exercicio|int| |
|descricao|string| |
|snAtivo|boolean|Flag indicador de registro ativo.|

==== RetornoAcoesDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de AcaoDTO|Algumas operações utilizam essa lista ao invés do atributo acoes.|
|acoes|Lista de AcaoDTO| |

==== RetornoApoioQualitativoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|momentosDTO|Lista de MomentoDTO| |
|esferasDTO|Lista de EsferaDTO| |
|funcoesDTO|Lista de FuncaoDTO| |
|subFuncoesDTO|Lista de SubFuncaoDTO| |
|tiposInclusaoDTO|Lista de TipoInclusaoDTO| |
|tiposAcaoDTO|Lista de TipoAcaoDTO| |
|produtosDTO|Lista de ProdutoDTO| |
|unidadesMedidaDTO|Lista de UnidadeMedidaDTO| |
|regioesDTO|Lista de RegiaoDTO| |
|perfisDTO|Lista de PerfilDTO| |
|tiposProgramaDTO|Lista de TipoProgramaDTO| |
|macroDesafiosDTO|Lista de MacroDesafioDTO| |
|unidadesMedidaIndicadorDTO|Lista de UnidadeMedidaIndicadorDTO| |
|periodicidadesDTO|Lista de PeriodicidadeDTO| |
|basesGeograficasDTO|Lista de BaseGeograficaDTO| |
|recorteGeograficoDTO|Lista de RecorteGeograficoDTO| |

==== RetornoFinanciamentoExtraOrcamentarioDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de FinanciamentoExtraOrcamentarioDTO| |

==== RetornoIndicadoresDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de IndicadorDTO| |

==== RetornoIniciativasDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de IniciativaDTO| |

==== RetornoLocalizadoresDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de LocalizadorDTO| |

==== RetornoMedidaInstitucionalNormativaDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de MedidaInstitucionalNormativaDTO| |

==== RetornoMetasDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de MetaDTO| |

==== RetornoMomentoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|MomentoDTO| |

==== RetornoObjetivosDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de ObjetivoDTO| |

==== RetornoOrgaosDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de OrgaoDTO| |

==== RetornoPlanoOrcamentarioDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|registros|Lista de PlanoOrcamentarioDTO| |

==== RetornoProgramacaoQualitativoDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |
|orgaosDTO|Lista de OrgaoDTO| |
|programasDTO|Lista de ProgramaDTO| |
|indicadoresDTO|Lista de IndicadorDTO| |
|objetivosDTO|Lista de ObjetivoDTO| |
|iniciativasDTO|Lista de IniciativaDTO| |
|acoesDTO|Lista de AcaoDTO| |
|localizadoresDTO|Lista de LocalizadorDTO| |
|metasDTO|Lista de MetaDTO| |
|regionalizacoesDTO|Lista de RegionalizacaoDTO| |
|planosOrcamentariosDTO|Lista de PlanoOrcamentarioDTO| |
|agendasSamDTO|Lista de AgendaSamDTO| |
|medidasInstitucionaisNormativasDTO|Lista de MedidaInstitucionalNormativaDTO| |

==== RetornoProgramasDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |

==== RetornoRegionalizacoesDTO ====

|**Atributo** |**Tipo(tamanho)** |**Observações** |
|sucesso|boolean| |
|mensagensErro|Lista de String| |

\\