Escolar Documentos
Profissional Documentos
Cultura Documentos
MANUAL WS SIAPE v4 PDF
MANUAL WS SIAPE v4 PDF
SIAPENET
Índice
1.Informações gerais sobre o serviço ............................................................................................................5
1.1Contexto................................................................................................................................................5
1.2Objetivo ................................................................................................................................................5
1.3Nome ....................................................................................................................................................5
1.4Endereço do arquivo WSDL.................................................................................................................5
1.5Gestor do serviço ..................................................................................................................................5
1.6Responsável técnico .............................................................................................................................6
1.7Requisitos e orientações para o acesso .................................................................................................6
2.Informações detalhadas do serviço ............................................................................................................7
2.1Nome do serviço na interface ...............................................................................................................7
2.2 Tabelas de Erro ....................................................................................................................................7
2.2.1Erros de Negócio ...............................................................................................................................7
2.2.2Erros de Infraestrutura .......................................................................................................................7
2.3Considerações gerais sobre parâmetros de entrada e/ou saída .............................................................8
2.4Operações .............................................................................................................................................8
2.4.1Consulta Dados de Afastamento....................................................................................................8
2.4.1.1Nome da Operação na Interface .............................................................................................8
2.4.1.2Parâmetro(s) de entrada ..........................................................................................................8
2.4.1.3Parâmetro(s) de saída..............................................................................................................8
2.4.2Consulta Dados Pessoais ...............................................................................................................9
2.4.2.1Nome da Operação na Interface .............................................................................................9
2.4.2.2Parâmetro(s) de entrada ..........................................................................................................9
2.4.2.3Parâmetro(s) de saída..............................................................................................................9
2.4.3Consulta Dados Documentação ...................................................................................................10
2.4.3.1Nome da Operação na Interface ...........................................................................................10
2.4.3.2Parâmetro(s) de entrada ........................................................................................................10
2.4.3.3Parâmetro(s) de saída............................................................................................................10
2.4.4Consulta Dados Funcionais .........................................................................................................11
2.4.4.1Nome da Operação na Interface ...........................................................................................11
2.4.4.2Parâmetro(s) de entrada ........................................................................................................11
2.4.4.3Parâmetro(s) de saída............................................................................................................11
2.4.5Consulta Dados Escolares ...........................................................................................................13
2.4.5.1Nome da Operação na Interface ...........................................................................................13
2.4.5.2Parâmetro(s) de entrada ........................................................................................................13
2.4.5.3Parâmetro(s) de saída............................................................................................................13
2.4.6Consulta Dados UORG ...............................................................................................................13
2.4.6.1Nome da Operação na Interface ...........................................................................................13
2.4.6.2Parâmetro(s) de entrada ........................................................................................................13
2.4.6.3Parâmetro(s) de saída............................................................................................................13
2.4.7Consulta Dados Endereço Residencial ........................................................................................14
2.4.7.1Nome da Operação na Interface ...........................................................................................14
2.4.7.2Parâmetro(s) de entrada ........................................................................................................14
2.4.7.3Parâmetro(s) de saída............................................................................................................14
2.4.8Consulta Dados Financeiros ........................................................................................................15
2.4.8.1Nome da Operação na Interface ...........................................................................................15
2.4.8.2Parâmetro(s) de entrada ........................................................................................................15
Ministério do Planejamento
Secretaria de Logística e Tecnologia da Informação
2.4.8.3Parâmetro(s) de saída............................................................................................................15
2.4.9Consulta Dados Dependentes ......................................................................................................15
2.4.9.1Nome da Operação na Interface ...........................................................................................15
2.4.9.2Parâmetro(s) de entrada ........................................................................................................15
2.4.9.3Parâmetro(s) de saída............................................................................................................15
2.4.10 Consulta Dados PA...................................................................................................................16
2.4.10.1Nome da Operação na Interface .........................................................................................16
2.4.10.2Parâmetro(s) de entrada ......................................................................................................16
2.4.10.3Parâmetro(s) de saída..........................................................................................................16
2.4.11 Consulta Dados SICAJ .............................................................................................................17
2.4.11.1Nome da Operação na Interface .........................................................................................17
2.4.11.2Parâmetro(s) de entrada ......................................................................................................17
2.4.11.3Parâmetro(s) de saída..........................................................................................................17
2.4.12 Consulta Dados Bancários ........................................................................................................17
2.4.12.1Nome da Operação na Interface .........................................................................................17
2.4.12.2Parâmetro(s) de entrada ......................................................................................................17
2.4.12.3Parâmetro(s) de saída..........................................................................................................18
2.4.13 Consulta Dados Representante Legal .......................................................................................18
2.4.13.1Nome da Operação na Interface .........................................................................................18
2.4.13.2Parâmetro(s) de entrada ......................................................................................................18
2.4.13.3Parâmetro(s) de saída..........................................................................................................18
2.4.14 Consulta Dados Currículo ........................................................................................................18
2.4.14.1Nome da Operação na Interface .........................................................................................18
2.4.14.2Parâmetro(s) de entrada ......................................................................................................18
2.4.14.3Parâmetro(s) de saída..........................................................................................................19
2.4.15 Consulta Dados Pensão Recebida.............................................................................................20
2.4.15.1Nome da Operação na Interface .........................................................................................20
2.4.15.2Parâmetro(s) de entrada ......................................................................................................20
2.4.15.3Parâmetro(s) de saída..........................................................................................................21
2.4.16 Consulta Pensões Instituídas ....................................................................................................21
2.4.16.1Nome da Operação na Interface .........................................................................................21
2.4.16.2Parâmetro(s) de entrada ......................................................................................................21
2.4.16.3Parâmetro(s) de saída..........................................................................................................22
2.4.17 Lista UORGs ............................................................................................................................22
2.4.17.1Nome da Operação na Interface .........................................................................................22
2.4.17.2Parâmetro(s) de entrada ......................................................................................................22
2.4.17.3Parâmetro(s) de saída..........................................................................................................22
2.4.18 Dados UORG ............................................................................................................................23
2.4.18.1Nome da Operação na Interface .........................................................................................23
2.4.18.2Parâmetro(s) de entrada ......................................................................................................23
2.4.18.3Parâmetro(s) de saída..........................................................................................................23
2.4.19 Lista Servidores ........................................................................................................................24
2.4.19.1Nome da Operação na Interface .........................................................................................24
2.4.19.2Parâmetro(s) de entrada ......................................................................................................24
2.4.19.3Parâmetro(s) de saída..........................................................................................................24
Ministério do Planejamento
Secretaria de Logística e Tecnologia da Informação
Histórico de Alterações
Data Versão Descrição Responsável (eis)
27/05/2015 4.0 Atualização dos itens 1.1, 1.7 e 2.3 Rodrigo Ferreira de Almeida
Ministério do Planejamento
Secretaria de Logística e Tecnologia da Informação
1.1 Contexto
O Web Service SIAPE foi desenvolvido em 2007 pelo SERPRO e o Departamento de
Administração de Sistemas de Recursos Humanos – DASIS/SRH/MP, a partir da necessidade de outros
sistemas do Governo Federal de integração com a base de dados do SIAPE.
1.2 Objetivo
O objetivo do Web Service SIAPE é possibilitar o acesso, em tempo real, por parte dos Sistemas
Autorizados, aos dados dos servidores ativos, aposentados e pensionistas, que recebem seus
pagamentos pelo SIAPE, utilizando um serviço disponível na Internet, denominado Web Service.
1.3 Nome
Consulta SIAPE.
Ambiente de produção:
https://www1.siapenet.gov.br/WSSiapenet/services/ConsultaSIAPE?wsdl
- Nível Órgão, Órgãos Vinculados e Unidade Pagadora (Upag): Órgão que deseja acessar
dados somente de servidores do seu órgão e vinculados. Para estes casos só é necessário o
envio do Formulário de Habilitação devidamente preenchido. O formulário deve ser assinado,
escaneado e enviado para o e-mail indicado no item 1.5.
- Nível Geral: Órgão que deseja acessar dados de servidores de todo os órgãos: Para estes
casos é necessária a celebração de um Acordo de Cooperação Técnica após análise de
conveniência/necessidade a ser feita pelo MP. É necessário o envio do Acordo de Cooperação
Técnica, Plano de Trabalho e Formulário de Habilitação. Os documentos físicos devem ser
enviados para o MP, localizado na Esplanada dos Ministérios, bloco K, sala 480, aos cuidados
da Coordenação Geral de Gestão do Desenvolvimento e Manutenção de Sistemas – CGDMS.
Para cada sistema habilitado será fornecida senha específica de acesso que deverá ser
utilizada quando do acionamento do serviço. Esta senha será enviada ao e-mail do responsável técnico
após o cadastramento do sistema cliente.
Ministério do Planejamento
Secretaria de Logística e Tecnologia da Informação
b – Todos os vínculos existentes no sistema para o CPF, independentes de estarem recebendo pagamento
(com ou sem ocorrência de exclusão
ParmTipoVinculo: Recebe os valores “a”, “b” ou “c”, conforme permissões concedidas durante o
cadastramento
a – Somente os vínculos de servidores em exercício (servidores com PCA-exercício interno ou PFU
vigentes ou com vínculos sem cargo e sem função). Não entram nestes casos aposentados, pensionistas,
cedidos ou em exercício externo ao órgão de lotação.
2.4 Operações
ConsultaDadosPessoais
ConsultaDadosDocumentacao
Aposentadoria
codOcorrIsencaoIR Int 0 Código da Ocorrência de
Isenção de IR
nomeOcorrIsencaoIR String 0 Nome da Ocorrância de
Isenção de IR
dataIniOcorrIsencaoIR Date 0 Data Inicial da Ocorrência
de Isenção de IR
dataFimOcorrIsencaoIR Date 0 Data Fim da Ocorrência de
Isenção de IR
codOcorrPSS Int 0 Código da Ocorrência de
PSS
nomeOcorrPSS String 0 Nome da Ocorrência de PSS
dataIniOcorrPSS Date 0 Data Inicial da Ocorrência
de PSS
dataFimOcorrPSS Date 0 Data Fim da Ocorrência de
PSS
codValeTransporte Int 0 Código de ValeTransporte
valorValeTransporte Int 0 Valor de ValeTransporte
tipoValeAR Int 0 Tipo de Vale AR
dataIniValeAR Date 0 Data Inicial de Vale AR
dataFimValeAR Date 0 Data Fim de Vale AR
percentualTS Int 0 Percentual de TS
nomeChefeUorg String 0 Nome do Chefe da Uorg
emailChefiaImediata String 0 E-mail da Chefia Imediata
cpfChefiaImediata Int 0 CPF da Chefia Imediata
pontuacaoDesempenho Int 0 Pontuação do Desempenho