SEI WebServices v3.0 PDF

Web Services - Verso 3.
1. Introduo ................................................................................................
................................ ...................................................................... 1
2. Estruturas de Dados SEI ................................................................................................
................................ ................................................ 3
3. Servios SEI ................................................................................................
................................ ................................................................. 12
4. Servios SIP ................................................................................................
................................ ................................................................. 28
5. Servios Acessados em outros Sistemas ................................................................
...................................................... 30
1. Introduo
O SEI possui uma interface de servios que permite a integrao com outros sistemas e que est
disponvel por meio do endereo:
http://[servidor php]/sei/controlador_ws.php?servico=sei
Para acesso necessrio antes cadastrar os sistemas externos e associ-los

associ com os respectivos
servios que podem ser invocados sendo possvel indicar o tipo de processo, tipo de documento e
unidades permitidas.
1.1 Cadastrar
adastrar o sistema cliente atravs do menu Administrao/Sistemas:
1.2 Aps cadastramento, atravs da lista de sistemas acessar o cone Servios:

Servios
1
1.3 Cadastrar um novo servio para o sistema:
Identificao: este campo dever ser informado na chamada do Web-Service
Descrio: campo auxiliar opcional
Servidores: o SEI validar se o servio est sendo chamado por um dos endereos informados
neste campo retornando Acesso Negado se no encontrar. Alm disso ser lanado um registro na
tabela infra_log informando qual servidor tentou acessar o servio. Dependendo da configurao da
rede pode ser necessrio informar o nome e tambm o IP do servidor na lista. permitido o uso de
at um caractere curinga * no nome do servidor, ex.: 10.100.50.* ou no*.trf4.jus.br. Se apenas o
* for cadastrado ento qualquer mquina estar liberada para acesso (no recomendado em
produo).
Gerar links de acesso externos: Ao chamar um servio do SEI ser retornado, dentre outras
informaes, um link para acesso ao processo ou documento. Sistemas desenvolvidos utilizando a
InfraPHP (como o SEI e SIP) possuem um mecanismo de autenticao automtica, ou seja, no
sistema cliente ao clicar no link o SEI ser aberto automaticamente para visualizao do processo
ou documento (caso o usurio do sistema cliente tenha permisso no SEI). Para sistemas que no
utilizam a InfraPHP ou nos quais o usurio pode no ter permisso no SEI possvel marcar esta
opo, neste caso, o processo ou documento ser visualizado da mesma forma que a funcionalidade
de Acesso Externo (sem login no SEI).
2
1.4 Aps o cadastramento na lista de servios acessar o cone Operaes:
1.5 Cadastrar as operaes permitidas para o servio:
2. Estruturas de Dados SEI
Andamento
IdAndamento Identificador interno do andamento
3
IdTarefa Identificador da tarefa associada
Descricao Texto do andamento
DataHora Data/hora em que o andamento foi gerado
Unidade Dados da unidade que gerou o andamento (ver estrutura Unidade)
Usuario Dados do usurio que gerou o andamento (ver estrutura Usuario)
Atributos Conjunto de atributos do andamento (ver estrutura
AtributoAndamento). Ser um conjunto vazio caso no existam
informaes.
AndamentoMarcador
IdAndamentoMarcador Identificador interno do andamento de marcador
Texto Texto associado com o andamento
DataHora Data/hora em que o andamento foi gerado
Usuario Dados do usurio que gerou o andamento (ver estrutura Usuario)
Marcador Dados do marcador utilizado no lanamento do andamento (ver
estrutura Marcador). Retornar nulo em andamentos de remoo
de marcador.
ArquivoExtensao
IdArquivoExtensao Identificador interno do SEI relativo a extenso
Extensao Texto da extenso (ex.: pdf, ods, doc, ppt,...)
Descricao Descrio da extenso
Assinatura
Nome Nome do assinante
CargoFuncao Cargo ou funo utilizado no momento da assinatura
DataHora Data/hora em que ocorreu a assinatura
Assunto
CodigoEstruturado Cdigo do Assunto, ex.: 00.01.01.01
Descricao Descrio do assunto
AtributoAndamento
Nome Nome do atributo
Valor Valor do atributo
IdOrigem Identificador auxiliar associado com este atributo
Campo
Nome Nome do campo do formulrio
Valor Valor do campo do formulrio
4
Cargo
IdCargo Identificador interno do cargo
ExpressaoCargo Descrio do cargo (Ex.: Governador)
ExpressaoTratamento Tratamento para o cargo (Ex.: A Sua Excelncia o Senhor)
ExpressaoVocativo Vocativo para o cargo (Ex.: Senhor Governador)
Cidade
IdCidade Identificador da cidade
IdEstado Identificador do estado
IdPais Identificador do pas
Nome Nome do estado
CodigoIbge Cdigo do IBGE do estado
SinCapital S/N - Indica se a cidade capital no estado
Latitude Latitude da cidade
Longitude Longitude da cidade
Contato
StaOperacao A Atualizar (cadastramento ou alterao)
E Excluir (se no for possvel excluir ser desativado)
D Desativar
R Reativar
IdContato Identificador interno do contato
IdTipoContato Identificar interno do tipo do contato
NomeTipoContato Nome do tipo do contato
Sigla Sigla do contato
Nome Nome do contato
StaNatureza F - Pessoa Fsica
J - Pessoa Jurdica
IdContatoAssociado Identificador da Pessoa Jurdica associada
NomeContatoAssociado Nome da Pessoa Jurdica associada
SinEnderecoAssociado S/N - indica se o endereo utilizado pelo contato da Pessoa
Jurdica associada
EnderecoAssociado Endereo da Pessoa Jurdica associada
ComplementoAssociado Complemento do endereo da Pessoa Jurdica associada
BairroAssociado Bairro da Pessoa Jurdica associada
IdCidadeAssociado Identificador da cidade da Pessoa Jurdica associada
NomeCidadeAssociado Nome da cidade da Pessoa Jurdica associada
IdEstadoAssociado Identificador do estado da Pessoa Jurdica associada
SiglaEstadoAssociado Sigla do estado da Pessoa Jurdica associada
IdPaisAssociado Identificador do pas da Pessoa Jurdica associada
NomePaisAssociado Nome do pas da Pessoa Jurdica associada
CepAssociado CEP da Pessoa Jurdica associada
Endereco Endereo do contato
Complemento Complemento do endereo do contato
Bairro Bairro do contato
IdCidade Identificador da cidade do contato
5
NomeCidade Nome da cidade do contato
IdEstado Identificador do estado do contato
SiglaEstado Sigla do estado do contato
IdPais Identificador do pas do contato
NomePais Nome do pas do contato
Cep CEP do contato
StaGenero F - Feminino
M - Masculino
IdCargo Identificador do cargo do contato
ExpressaoCargo Cargo do contato (ex.: Diretor)
ExpressaoTratamento Tratamento do contato (ex.: Ao Senhor)
ExpressaoVocativo Vocativo do contato (ex.: Senhor Diretor)
Cpf CPF do contato
Cnpj CNPJ do contato
Rg RG do contato
OrgaoExpedidor rgo Expedidor do RG do contato
Matricula Matrcula do contato
MatriculaOab Matrcula OAB do contato
TelefoneFixo Telefone fixo do contato
TelefoneCelular Telefone celular do contato
DataNascimento Data de nascimento do contato
Email Email do contato
SitioInternet Stio na internet do contato
Observacao Observao associada com o contato
SinAtivo S/N - indica se o contato est ativo ou no no sistema
DefinicaoMarcador
ProtocoloProcedimento Nmero do processo visvel para o usurio, ex: 12.1.000000077-4
IdMarcador Identificador do marcador disponvel na unidade
Texto Texto para associao
Destinatario
Sigla Sigla do participante
Nome Nome do participante
Documento
Tipo G = documento gerado
R = documento recebido (externo)
IdProcedimento Identificador do processo onde o documento deve ser inserido,
passar null quando na mesma operao estiver sendo gerado o
processo. Opcional se ProtocoloProcedimento informado
ProtocoloProcedimento Nmero do processo onde o documento deve ser inserido, visvel
para o usurio, ex: 12.1.000000077-4. Opcional se
IdProcedimento informado.
IdSerie Identificador do tipo de documento no SEI (sugere-se que este id
seja armazenado em uma tabela auxiliar do sistema cliente)
6
Numero Nmero do documento, passar null para documentos gerados com
numerao controlada pelo SEI. Para documentos externos
informar o nmero ou nome complementar a ser exibido na rvore
de documentos do processo (o SEI no controla numerao de
documentos externos). Para documentos gerados com numerao
informada, igualmente informar o nmero por meio deste campo.
Data Data do documento, obrigatrio para documentos externos. Passar
null para documentos gerados
Descricao Descrio do documento para documentos gerados. Passar null
para documentos externos
IdTipoConferencia Identificador do tipo de conferncia associada com o documento
externo
Remetente Obrigatrio para documentos externos, passar null para
documentos gerados (ver estrutura Remetente)
Interessados Informar um conjunto com os dados de interessados (ver estrutura
Interessado). Se no existirem interessados deve ser informado
um conjunto vazio.
Destinatarios Informar um conjunto com os dados de destinatrios (ver estrutura
Destinatario). Se no existirem destinatrios deve ser informado
um conjunto vazio.
Observacao Texto da observao da unidade, passar null se no existir
NomeArquivo Nome do arquivo, obrigatrio para documentos externos. Passar
null para documentos gerados.
Conteudo Contedo do arquivo codificado em Base64. Para documentos
gerados ser o contedo da seo principal do editor HTML e
para documentos externos ser o contedo do anexo.
ConteudoMTOM Contedo textual ou binrio do documento. Este campo somente
poder ser utilizado para documentos externos. O sistema somente
aceitar requisies com um dos atributos preenchidos: Conteudo
ou ConteudoMTOM.
NivelAcesso 0 - pblico
1 - restrito
2 - sigiloso
Null o documento assumir o nvel de acesso e hiptese legal
sugeridos para o tipo do processo, conforme cadastro no SEI.
IdHipoteseLegal Identificador da hiptese legal associada
IdArquivo Identificador do arquivo (ver servio adicionarArquivo)
Campos Campos associados com o formulrio (ver estrutura Campo)
SinBloqueado S/N - bloqueando o documento no ser possvel exclu-lo ou
alterar seu contedo
Estado
IdEstado Identificador do estado
Sigla Sigla do estado
Nome Nome do estado
CodigoIbge Cdigo do IBGE do estado
7
HipoteseLegal
IdHipoteseLegal Identificador da hiptese legal
Nome Nome da hiptese legal
BaseLegal Descrio da base legal
Interessado
Marcador
IdMarcador Identificador do marcador
Nome Nome do marcador
Icone cone do marcador em formato PNG codificado em Base64
SinAtivo S/N - Sinalizador indica se o marcador est ativo
Observacao
Descricao Texto da observao
Unidade Dados da unidade que adicionou a observao (ver estrutura
Unidade)
Pais
Nome Nome do pas
Procedimento
IdTipoProcedimento Identificador do tipo de processo no SEI (sugere-se que este id
seja armazenado em uma tabela de parmetros do sistema cliente)
NumeroProtocolo Nmero do processo, se no for informado o sistema ir gerar um
novo nmero automaticamente
DataAutuacao Data de autuao do processo, se no for informada o sistema
utilizar a data atual
Especificacao Especificao do processo
Assuntos Assuntos do processo (ver estrutura Assunto), os assuntos
informados sero adicionados aos assuntos sugeridos para o tipo
de processo. Passar um conjunto vazio caso nenhum outro assunto
seja necessrio (caso apenas os sugeridos para o tipo bastem para
classificao).
Interessados Informar um conjunto com os dados de interessados (ver estrutura
Interessado). Se no existirem interessados deve ser informado um
conjunto vazio.
Observacao Texto da observao da unidade, passar null se no existir
NivelAcesso 0 - pblico
1 - restrito
2 - sigiloso
Null o processo assumir o nvel de acesso e hiptese legal
8
sugeridos para o tipo do processo, conforme seu cadastro no SEI.
IdHipoteseLegal Identificador da hiptese legal associada
ProcedimentoResumido
IdTipoProcedimento Identificador do tipo de processo no SEI (sugere-se que este id
seja armazenado em uma tabela de parmetros do sistema cliente)
ProcedimentoFormatado Nmero do processo visvel para o usurio, ex: 12.1.000000077-4
TipoProcedimento Dados do tipo do processo (ver estrutura TipoProcedimento)
ProtocoloBloco
ProtocoloFormatado Nmero do processo ou documento visvel para o usurio, ex.
12.1.000000077-4 ou 0043552
Identificacao Tipo do processo ou documento
Assinaturas Conjunto de assinaturas dos documentos (ver estrutura
Assinatura). Ser um conjunto vazio caso no existam
informaes ou se o protocolo representa um processo.
Publicacao
NomeVeiculo Nome do veculo cadastrado no SEI
Numero Nmero da publicao
DataDisponibilizacao Data da disponibilizao
DataPublicacao Data da publicacao
Estado A=Agendado ou P=Publicado
ImprensaNacional Dados da Imprensa Nacional associados (nulo se no existirem)
PublicacaoImprensaNacional
SiglaVeiculo Sigla do veculo (ex.: DOU)
DescricaoVeiculo Descrio do veculo (ex.: Dirio Oficial da Unio)
Pagina Pgina da publicao
Secao Seo da publicao
Data Data da publicao
Remetente
RetornoConsultaBloco
IdBloco Nmero do bloco
Unidade Dados das unidade que gerou o bloco (ver estrutura Unidade)
Usuario Dados do usurio que gerou o bloco (ver estrutura Usurio)
Descrio Descrio do bloco
Tipo Tipo do bloco (A=Assinatura, R=Reunio ou I=Interno)
Estado Estado do bloco (A=Aberto, D=Disponibilizado, R=Retornado ou
C=Concludo)
9
UnidadesDisponibilizacao Dados das unidades configuradas para disponibilizao (ver
estrutura Unidade)
Protocolos Processos ou documentos do bloco (ver estrutura ProtocoloBloco)
RetornoConsultaDocumento
IdProcedimento Id interno do processo no SEI, ex.: 1210000000774
ProcedimentoFormatado Nmero do processo visvel para o usurio, ex: 12.1.000000077-4
IdDocumento Id interno do documento no SEI, ex.: 1140000000872
DocumentoFormatado Nmero do documento visvel para o usurio, ex.: 0003934
LinkAcesso Link para acesso ao documento
Serie Dados do tipo do documento (ver estrutura Serie)
Numero Nmero do documento
Data Data de gerao para documentos internos e para documentos
externos a data informada na tela de cadastro
UnidadeElaboradora Dados da unidade que gerou o documento (ver estrutura Unidade)
AndamentoGeracao Informaes do andamento de gerao (ver estrutura Andamento)
Assinaturas Conjunto de assinaturas do documento (ver estrutura Assinatura).
Ser um conjunto vazio caso no existam informaes.
Publicacao Informaes de publicao do documento (ver estrutura
Publicacao). Ser nulo caso no existam informaes.
Campos Conjunto de campos do formulrio (ver estrutura Campo). Ser
um conjunto vazio caso no existam informaes.
RetornoConsultaProcedimento
ProcedimentoFormatado Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
Especificacao Especificao do processo
DataAutuacao Data de autuao do processo
LinkAcesso Link para acesso ao processo
TipoProcedimento Dados do tipo do processo (ver estrutura TipoProcedimento)
AndamentoGeracao Dados do andamento de gerao (ver estrutura Andamento)
AndamentoConclusao Dados do andamento de concluso (ver estrutura Andamento).
Ser nulo caso no existam informaes.
UltimoAndamento Dados do ltimo andamento (ver estrutura Andamento)
UnidadesProcedimentoAberto Conjunto de unidades onde o processo se encontra aberto (ver
estrutura UnidadeProcedimentoAberto). Ser um conjunto
vazio caso no existam informaes.
Assuntos Conjunto de assuntos do processo (ver estrutura Assunto). Ser
um conjunto vazio caso no existam informaes.
Interessados Conjunto de interessados do processo (ver estrutura
Interessado). Ser um conjunto vazio caso no existam
informaes.
Observacoes Conjunto de observaes das unidades (ver estrutura
Observacao). Ser um conjunto vazio caso no existam
informaes.
ProcedimentosRelacionados Conjunto de processos relacionados (ver estrutura
10
ProcedimentoResumido). Ser um conjunto vazio caso no
existam informaes.
ProcedimentosAnexados Conjunto processos anexados (ver estrutura
ProcedimentoResumido). Ser um conjunto vazio caso no
existam informaes.
RetornoGeracaoProcedimento
ProcedimentoFormatado Nmero do processo visvel para o usurio, ex: 12.1.000000077-
4
LinkAcesso Link para acesso ao processo
RetornoInclusaoDocumentos Conjunto de estruturas RetornoInclusaoDocumento (com um
item para cada documento informado na gerao do processo)
RetornoInclusaoDocumento
IdDocumento Id interno do documento no SEI, ex.: 1140000000872
DocumentoFormatado Nmero do documento visvel para o usurio, ex.: 0003934
LinkAcesso Link para acesso ao documento
Serie
IdSerie Identificador do tipo de documento
Nome Nome do tipo de documento
Aplicabilidade T = Documentos internos e externos
I = documentos internos
E = documentos externos
F = formulrios
TipoProcedimento
IdTipoProcedimento Identificador do tipo de processo
Nome Nome do tipo de processo
TipoConferencia
IdTipoConferencia Identificador do tipo de conferncia
Descricao Descrio do tipo de conferncia
Unidade
IdUnidade Identificador da unidade
Sigla Sigla da unidade
Descricao Descrio da unidade
UnidadeProcedimentoAberto
Unidade Dados da Unidade onde o processo est aberto (ver estrutura
Unidade).
UsuarioAtribuicao Dados do Usurio para o qual o processo est atribudo (ver
11
estrutura Usuario). Ser nulo caso no existam informaes.
Usuario
IdUsuario Identificador do usurio
Sigla Sigla do usurio
Nome Nome do usurio
3. Servios SEI
adicionarArquivo
Entrada
SiglaSistema Valor informado no cadastro do sistema realizado no SEI
IdentificacaoServico Valor informado no cadastro do servio realizado no SEI
IdUnidade Valor informado no cadastro do servio realizado no SEI
Nome Nome do arquivo
Tamanho Tamanho total do arquivo em bytes
Hash MD5 do contedo total do arquivo
Conteudo Contedo total ou parcial codificado em Base64
Sada
Parametros Retorna o identificador do arquivo criado
Observaes
O servio criar um arquivo no repositrio de documentos e retornar seu identificador. O envio
do arquivo poder ser particionado com chamadas posteriores ao servio
adicionarConteudoArquivo.
Aps todo o contedo ser transferido o arquivo ser ativado e poder ser associado com um
documento externo no servio de incluso de documento (campo IdArquivo da estrutura
Documento). Neste caso, ao chamar o respectivo servio o contedo no precisar ser informado
pois j foi enviado previamente.
Quando o agendamento removerArquivosNaoUtilizados for executado sero excludos todos os

arquivos com mais de 24 horas e que no foram completados ou que no foram associados com
um documento externo.
adicionarConteudoArquivo
Entrada
IdArquivo Identificador do arquivo criado pelo servio adicionarArquivo
Conteudo Contedo codificado em Base64 para ser adicionado no arquivo
Sada
Parametros Retorna o identificador do arquivo criado
Observaes
12
O sistema identificar automaticamente quando o contedo foi completado validando o tamanho
em bytes e o hash do contedo. Quando as condies forem satisfeitas o arquivo ser ativado e
poder ser utilizado nas chamadas de incluso de documento.
atribuirProcesso
Entrada
IdUnidade Id da unidade onde o bloco foi gerado
IdUsuario Identificador do usurio no SIP
SinReabrir S/N - indica se o processo deve ser reaberto automaticamente
(valor padro N)
Sada
parametros Retorna true
Observaes
anexarProcesso
Entrada
ProtocoloProcedimentoPrincipal Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
ProtocoloProcedimentoAnexado Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
Sada
atualizarContatos
Entrada
Contatos Informar conjunto de contatos para atualizao (ver estrutura
Contato).
Sada
Observaes
Cada um dos contatos do conjunto informado ser tratado separadamente. Sendo assim, mesmo
que alguns apresentem erro ou falha na validao dos dados os demais sero atualizados. Os
erros e validaes de dados sero acumulados e retornados como uma exceo.
Com relao a pessoa jurdica associada sero processados apenas os atributos

IdContatoAssociado e SinEnderecoAssociado.
13
Para cidade, estado, pas e cargo devem ser informados os campos relativos aos identificadores
internos (IdCidade, IdEstado, IdPais e IdCargo).
bloquearProcesso
Entrada
IdUnidade Id da unidade onde o processo est aberto
Sada
cancelarDisponibilizacaoBloco
Entrada
Sada
cancelarDocumento
Entrada
ProtocoloDocumento Nmero do documento visvel para o usurio, ex.: 0003934
Motivo Texto informando o motivo do cancelamento
Sada
concluirProcesso
Entrada
Sada
consultarBloco
Entrada
14
IdUnidade Identificador da unidade no SEI (sugere-se que este id seja
armazenado em uma tabela auxiliar do sistema cliente).
SinRetornarProtocolos S/N - sinalizador para retorno dos protocolos do bloco (valor
padro N)
Sada
parametros Uma ocorrncia da estrutura RetornoConsultaBloco
Observaes
O bloco deve ser da unidade ou estar disponibilizado para ela. O sinalizador de retorno dos
protocolos implica em processamento adicional realizado pelo sistema, sendo assim, recomenda-
se que seja solicitado o retorno apenas se as informaes forem estritamente necessrias.
consultarDocumento
Entrada
armazenado em uma tabela auxiliar do sistema cliente).
SinRetornarAndamentoGeracao S/N - sinalizador para retorno do andamento de gerao
SinRetornarAssinaturas S/N - sinalizador para retorno das assinaturas do documento
SinRetornarPublicacao S/N - sinalizador para retorno dos dados de publicao
SinRetornarCampos S/N - sinalizador para retorno dos campos do formulrio
Sada
parametros Uma ocorrncia da estrutura RetornoConsultaDocumento
Observaes
Documento de processos sigilosos no so retornados. Cada um dos sinalizadores implica em
processamento adicional realizado pelo sistema, sendo assim, recomenda-se que seja solicitado o
retorno somente para informaes estritamente necessrias.
consultarProcedimento
Entrada
SiglaSistema Valor informado no cadastro do sistema realizado
no SEI
IdentificacaoServico Valor informado no cadastro do servio realizado
no SEI
IdUnidade Identificador da unidade no SEI (sugere-se que este
id seja armazenado em uma tabela auxiliar do
sistema cliente).
ProtocoloProcedimento Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
SinRetornarAssuntos S/N - sinalizador para retorno dos assuntos do
processo
SinRetornarInteressados S/N - sinalizador para retorno de interessados do
processo
SinRetornarObservacoes S/N - sinalizador para retorno das observaes das
15
unidades
SinRetornarAndamentoGeracao S/N - sinalizador para retorno do andamento de
gerao
SinRetornarAndamentoConclusao S/N - sinalizador para retorno do andamento de
concluso
SinRetornarUltimoAndamento S/N - sinalizador para retorno do ltimo andamento
SinRetornarUnidadesProcedimentoAberto S/N - sinalizador para retorno das unidades onde o
processo se encontra aberto
SinRetornarProcedimentosRelacionados S/N - sinalizador para retorno dos processos
relacionados
SinRetornarProcedimentosAnexados S/N - sinalizador para retorno dos processos
anexados
Sada
parametros Uma ocorrncia da estrutura
RetornoConsultaProcedimento
Observaes
Processos sigilosos no so retornados. Cada um dos sinalizadores implica em processamento
adicional realizado pelo sistema, sendo assim, recomenda-se que seja solicitado o retorno
somente para informaes estritamente necessrias.
definirMarcador
Entrada
Definicoes Conjunto de definies de marcadores (ver estrutura
DefinicaoMarcador)
Sada
desanexarProcesso
Entrada
ProtocoloProcedimentoPrincipal Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
ProtocoloProcedimentoAnexado Nmero do processo visvel para o usurio, ex:
12.1.000000077-4
Motivo Texto do motivo da desanexao
Sada
desbloquearProcesso
Entrada
16
Sada
disponibilizarBloco
Entrada
Sada
enviarProcesso
Entrada
12.1.000000077-4
UnidadesDestino Conjunto de unidades destinatrias (ver estrutura Unidade)
SinManterAbertoUnidade S/N - sinalizador indica se o processo deve ser mantido
aberto na unidade de origem (valor padro N)
SinRemoverAnotacao S/N - sinalizador indicando se deve ser removida anotao
do processo (valor padro N)
SinEnviarEmailNotificacao S/N - sinalizador indicando se deve ser enviado email de
aviso para as unidades destinatrias (valor padro N)
DataRetornoProgramado Data para definio de Retorno Programado (passar nulo se
no for desejado)
DiasRetornoProgramado Nmero de dias para o Retorno Programado (valor padro
nulo)
SinDiasUteisRetornoProgramado S/N - sinalizador indica se o valor passado no parmetro
DiasRetornoProgramado corresponde a dias teis ou no
(valor padro N)
SinReabrir S/N - sinalizador indicando se o processo deve ser reaberto
automaticamente caso esteja concludo na unidade. Para
realizar a reabertura o servio dever ter tambm a operao
"Reabrir Processo" liberada no SEI.
Sada
excluirBloco
Entrada
17
Sada
gerarBloco
Entrada
IdUnidade Id da unidade onde ser gerado o bloco
Tipo Tipo do bloco:
A Assinatura
R Reunio
I - Interno
Descricao Descrio do bloco
UnidadesDisponibilizacao Conjunto de unidades para disponibilizao (ver estrutura
Unidade). Passar um conjunto vazio caso o bloco no deva ser
disponibilizado.
Documentos Lista de protocolos de documentos (nmero visvel para o
usurio, ex.: 0003934). Para realizar a incluso o servio dever
ter tambm a operao "Incluir Documento em Bloco" liberada
no SEI.
SinDisponibilizar S/N - sinalizador indicando se o bloco deve ser automaticamente
disponibilizado. Para realizar a disponibilizao o servio dever
ter tambm a operao "Disponibilizar Bloco" liberada no SEI.
Sada
parametros Retorna o nmero do bloco gerado.
gerarProcedimento
Entrada
armazenado em uma tabela de parmetros no sistema
cliente)
Procedimento Informar os dados do processo (ver estrutura Procedimento)
Documentos Informar os documentos que devem ser gerados em
conjunto com o processo (ver estrutura Documento). Se
nenhum documento for gerado informar um conjunto vazio.
O nmero mximo de documentos por chamada limitado
atravs do parmetro SEI_WS_NUM_MAX_DOCS (menu
Infra/Parmetros).
ProcedimentosRelacionados Conjunto com Ids de processos que devem ser relacionados
automaticamente com o novo processo
UnidadesEnvio Conjunto com Ids de unidades para envio do processo aps
a gerao. O processo ficar aberto na unidade geradora e
18
nas unidades informadas neste parmetro.
SinManterAbertoUnidade S/N - sinalizador indica se o processo deve ser mantido
aberto na unidade de origem (valor padro S)
SinEnviarEmailNotificacao S/N - sinalizador indicando se deve ser enviado email de
aviso para as unidades destinatrias (valor padro N)
DataRetornoProgramado Data para definio de Retorno Programado (valor padro
nulo)
DiasRetornoProgramado Nmero de dias para o Retorno Programado (valor padro
nulo)
SinDiasUteisRetornoProgramado S/N - sinalizador indica se o valor passado no parmetro
DiasRetornoProgramado corresponde a dias teis ou no
(valor padro N)
IdMarcador Opcional. Identificador de um marcador da unidade para
associao
TextoMarcador Opcional. Texto do marcador
Sada
parametros Uma ocorrncia da estrutura RetornoGeracaoProcedimento
incluirDocumento
Entrada
armazenado em uma tabela auxiliar do sistema cliente)
Documento Informar os dados do documento (ver estrutura Documento)
Sada
parametros Uma ocorrncia da estrutura RetornoInclusaoDocumento
incluirDocumentoBloco
Entrada
Anotacao Opcional. Texto de anotao associado com o documento no
bloco.
Sada
incluirProcessoBloco
Entrada
19
Anotacao Opcional. Texto de anotao associado com o processo no bloco.
Sada
lancarAndamento
Entrada
IdTarefa Identificador da tarefa associada
IdTarefaModulo Identificador da tarefa de mdulo
Atributos Conjunto de atributos associados (ver estrutura
AtributoAndamento)
Sada
parametros Retorna o andamento gerado (ver estrutura Andamento)
Observaes
O parmetro IdTarefa deve ser um nmero maior ou igual a 1000 (identificadores abaixo deste
valor so reservados do SEI) ou ento 65 que equivale a tarefa de atualizao de andamento
(neste caso informar um atributo com Nome="DESCRICAO" e Valor="texto do andamento").
Pode ser informado IdTarefa ou IdTarefaModulo o que for mais conveniente.
listarAndamentos
Entrada
SinRetornarAtributos S/N - sinalizador para retorno dos atributos associados
Andamentos Opcional. Filtra andamentos pelos identificadores informados.
Tarefas Opcional. Filtra andamentos pelos identificadores de tarefas
informados.
TarefasModulos Opcional. Filtra andamentos pelos identificadores de tarefas de
mdulo informados.
Sada
parametros Um conjunto de ocorrncias da estrutura Andamento.
Observaes
necessrio informar pelo menos um dos parmetros Andamentos, Tarefas ou TarefasModulos.
No parmetro Tarefas possvel filtrar por qualquer tarefa do sistema (verificar os valores de
tarefas internas nas constantes existentes no arquivo TarefaRN.php).
listarAndamentosMarcadores
Entrada
20
Marcadores Opcional. Filtra andamentos pelos identificadores informados.
Para retornar tambm os andamentos onde o marcador foi
removido adicionar na lista o valor nulo.
Sada
parametros Um conjunto de ocorrncias da estrutura AndamentoMarcador.
Observaes
listarCargos
Entrada
IdCargo Opcional. Filtra por um cargo especfico.
Sada
parametros Um conjunto de ocorrncias da estrutura Cargo.
Observaes
listarCidades
Entrada
IdPais Opcional. Filtra cidades pelo pas informado.
IdEstado Opcional. Filtra cidades pelo estado informado.
Sada
parametros Um conjunto de ocorrncias da estrutura Cidade.
Observaes
listarContatos
Entrada
IdTipoContato Filtra o tipo de contato
PaginaRegistros Opcional. Informa o nmero mximo de registros que devem ser
retornados por pgina de consulta (1 a 1000 com valor padro 1).
PaginaAtual Opcional. Informa o nmero da pgina atual (valor padro 1).
Sigla Opcional. Filtra contato pela sigla.
Nome Opcional. Filtra contato pelo nome.
CPF Opcional. Filtra contato pelo CPF.
21
CNPJ Opcional. Filtra contato pelo CNPJ.
Matricula Opcional. Filtra contato pelo nmero de matrcula.
Sada
parametros Um conjunto de ocorrncias da estrutura Contato.
Observaes
Os contatos retornaro ordenados pelo atributo Nome.
listarEstados
Entrada
IdPais Opcional. Filtra estados pelo pas informado.
Sada
parametros Um conjunto de ocorrncias da estrutura Estado.
Observaes
listarExtensoesPermitidas
Entrada
IdArquivoExtensao Opcional. Filtra determinada extenso.
Sada
parametros Um conjunto de ocorrncias da estrutura ArquivoExtensao.
listarHipotesesLegais
Entrada
NivelAcesso Opcional. Filtra hipteses pelo nvel de acesso associado (1 -
restrito,
2 - sigiloso).
Sada
parametros Um conjunto de ocorrncias da estrutura HipoteseLegal.
Observaes
listarMarcadoresUnidade
Entrada
22
Sada
parametros Um conjunto de ocorrncias da estrutura Marcador.
Observaes
listarPaises
Entrada
Sada
parametros Um conjunto de ocorrncias da estrutura Pais.
Observaes
listarSeries
Entrada
IdUnidade Opcional. Id da unidade cadastrada no servio.
IdTipoProcedimento Opcional. Tipo do processo cadastrado no servio.
Sada
parametros Um conjunto de ocorrncias da estrutura Serie.
Observaes
As sries sero listadas de acordo com o acesso configurado para o servio informado. Por
exemplo, caso o servio informado seja composto por 2 operaes de gerao de documento dos
tipos A e B ento apenas estas 2 sries retornaro. Os parmetros IdUnidade e
IdTipoProcedimento podem ser informados como filtros adicionais que sero aplicados nas
operaes do servio. Desta forma a lista de retorno pode ser montada no sistema cliente apenas
com valores vlidos (evitando chamadas com valores no liberados para o servio no SEI).
listarTiposConferencia
Entrada
Sada
parametros Um conjunto de ocorrncias da estrutura TipoConferencia.
listarTiposProcedimento
Entrada
IdSerie Opcional. Tipo do documento cadastrado no servio.
23
Sada
parametros Um conjunto de ocorrncias da estrutura TipoProcedimento.
Observaes
Os tipos de processo sero listados de acordo com o acesso configurado para o servio
informado. Por exemplo, caso o servio informado seja composto por 3 operaes de gerao de
processo dos tipos A, B e C ento apenas estes 3 tipos retornaro. Os parmetros IdUnidade e
IdSerie podem ser informados como filtros adicionais que sero aplicados nas operaes do
servio. Desta forma a lista de retorno pode ser montada no sistema cliente apenas com valores
vlidos (evitando chamadas com valores no liberados para o servio no SEI).
listarUnidades
Entrada
IdTipoProcedimento Opcional. Tipo do processo cadastrado no servio.
IdSerie Opcional. Tipo do documento cadastrado no servio.
Sada
parametros Um conjunto de ocorrncias da estrutura Unidade.
Observaes
As unidades sero listadas de acordo com o acesso configurado para o servio informado. Por
exemplo, caso o servio informado seja composto por 3 operaes de gerao de processo nas
unidades X, Y e Z ento apenas estas 3 unidades retornaro. Os parmetros IdTipoProcedimento
e IdSerie podem ser informados como filtros adicionais que sero aplicados nas operaes do
servio. Desta forma a lista de retorno pode ser montada no sistema cliente apenas com valores
vlidos (evitando chamadas com valores no liberados para o servio no SEI).
listarUsuarios
Entrada
IdUsuario Opcional. Filtra determinado usurio.
Sada
parametros Um conjunto de ocorrncias da estrutura Usuario.
Observaes
Retorna o conjunto de usurios que possuem o perfil "Bsico" do SEI na unidade.
reabrirProcesso
Entrada
IdUnidade Id da unidade por onde o processo tramitou
Sada
24
relacionarProcesso
Entrada
ProtocoloProcedimento1 Nmero do processo visvel para o usurio, ex: 12.1.000000077-4
Sada
Observaes
O relacionamento entre processos bilateral sendo assim necessrio que a unidade possua
permisso para relacionar nos dois tipos de processos envolvidos.
removerRelacionamentoProcesso
Entrada
Sada
Observaes
O relacionamento entre processos bilateral sendo assim necessrio que a unidade possua
permisso para remover relacionamento nos dois tipos de processos envolvidos.
removerSobrestamentoProcesso
Entrada
Sada
Observaes
retirarDocumentoBloco
Entrada
Sada
25
retirarProcessoBloco
Entrada
Sada
sobrestarProcesso
Entrada
12.1.000000077-4
ProtocoloProcedimentoVinculado Opcional. Nmero do processo visvel para o usurio, ex:
11.1.000000293-2
Motivo Texto do motivo do sobrestamento
Sada
Observaes
Exemplo de chamada em PHP5

$strWSDL = 'http://[servidor php]/sei/controlador_ws.php?servico=sei';
if(!@file_get_contents($strWSDL)) {
throw new InfraException('Arquivo WSDL '.$strWSDL.' no encontrado.');
}
try{
$objWS = new SoapClient($strWSDL, array('encoding'=>'ISO-8859-1'));
//para uso com MTOM utilizar um componente que d suporte a esta caracterstica (ex.:
BeSimpleSoap)
//$objWS = new BeSimple\SoapClient\SoapClient($strWSDL, array ('encoding'=>'ISO-8859-1',
// 'attachment_type'=>BeSimple\SoapCommon\Helper::ATTACHMENTS_
TYPE_MTOM,
// 'soap_version' => SOAP_1_1));
}catch(Exception $e){
throw new InfraException('Erro acessando servio.',$e);
}
$numIdUnidade = '100000969'; //CORREG
//Procedimento
$Procedimento = array();
$Procedimento['IdTipoProcedimento'] = '100000368'; //Designacao de Magistrado -
Suspeicao/Impedimento
$Procedimento['Especificacao'] = 'especificacao teste processo';
$arrAssuntos = array();
$arrAssuntos[] = array('CodigoEstruturado'=>'00.01.01.01');
$arrAssuntos[] = array('CodigoEstruturado'=>'00.01.08.02');
$Procedimento['Assuntos'] = $arrAssuntos;
26
$arrInteressados = array();
$arrInteressados[] = array('Sigla'=>'dgx', 'Nome' => 'Alberto');
$arrInteressados[] = array('Sigla'=>'utv', 'Nome' => 'Maria');
$Procedimento['Interessados'] = $arrInteressados;
$Procedimento['Observacao'] = 'observacao teste processo';

$Procedimento['NivelAcesso'] = null;
$ProcedimentosRelacionados = array('1210000004770');
$UnidadesEnvio = array('110000015','100000983');
//Documento Gerado
$DocumentoGerado = array();
$DocumentoGerado['Tipo'] = 'G';
//se incluindo em um processo existente informar o id neste campo

//se incluindo o documento no momento da geracao do processo passar null
$DocumentoGerado['IdProcedimento'] = null;
$DocumentoGerado['IdSerie'] = '3'; //Portaria

$DocumentoGerado['Numero'] = null;
$DocumentoGerado['Data'] = null;
$DocumentoGerado['Descricao'] = 'descricao teste documento';
$DocumentoGerado['Remetente'] = null;
$arrInteressados[] = array('Sigla'=>'kiv', 'Nome' => 'Pedro');
$DocumentoGerado['Interessados'] = $arrInteressados;
$arrDestinatarios = array();
$arrDestinatarios[] = array('Sigla'=>'udv', 'Nome' => 'Joo');
$arrDestinatarios[] = array('Sigla'=>'prm', 'Nome' => 'Paulo');
$DocumentoGerado['Destinatarios'] = $arrDestinatarios;
$DocumentoGerado['Observacao'] = 'observacao teste documento';
$DocumentoGerado['NomeArquivo'] = null;
$DocumentoGerado['Conteudo'] = base64_encode('aaabbbccc');
$DocumentoGerado['NivelAcesso'] = null;
//Documento Recebido
$DocumentoRecebido = array();
$DocumentoRecebido['Tipo'] = 'R';
//se incluindo em um processo existente informar o id neste campo

//se incluindo o documento no momento da geracao do processo passar null
$DocumentoRecebido['IdProcedimento'] = null;
$DocumentoRecebido['IdSerie'] = '301'; //Ofcio
$DocumentoRecebido['Numero'] = '1000';
$DocumentoRecebido['Data'] = '10/09/2011';
$DocumentoRecebido['Descricao'] = 'descricao teste documento';
$DocumentoRecebido['Remetente'] = array('Sigla'=>'lmr','Nome'=>'Luiza');
$arrInteressados[] = array('Sigla'=>'rub', 'Nome' => 'Roberto');
$arrInteressados[] = array('Sigla'=>'nay', 'Nome' => 'Nadir');
$DocumentoRecebido['Interessados'] = $arrInteressados;
$DocumentoRecebido['Destinatarios'] = null;
$DocumentoRecebido['Observacao'] = 'observacao teste documento';
$DocumentoRecebido['NomeArquivo'] = 'oficio.txt';
$DocumentoRecebido['Conteudo'] = base64_encode('conteudo do documento oficio.txt');
//Para MTOM
//$DocumentoRecebido['Conteudo'] = '';
//$DocumentoRecebido['ConteudoMTOM'] = file_get_contents(dirname(__FILE__).'/OFIC832014CEF.pdf');
$DocumentoRecebido['NivelAcesso'] = null;
//1 - gera processo

//$ret = $objWS->gerarProcedimento('Corregedoria','Suspeio/Impedimento', $numIdUnidade,
$Procedimento, array(),$ProcedimentosRelacionados, $UnidadesEnvio);
//2 - gera processo + documento gerado
27
$Procedimento, array($DocumentoGerado), array(),$UnidadesEnvio);
//3 - gera processo + documento gerado + documento externo

$Procedimento, array($DocumentoGerado, $DocumentoRecebido));
//4 - inclui documento gerado em processo existente

//$DocumentoGerado['IdProcedimento'] deve estar com o id preenchido
//$ret = $objWS->incluirDocumento('Corregedoria','Suspeio/Impedimento', $numIdUnidade,
$DocumentoGerado);
//5 -inclui documento externo em processo existente

//$DocumentoRecebido['IdProcedimento'] deve estar com o id preenchido
//$ret = $objWS->incluirDocumento('Corregedoria','Suspeio/Impedimento', $numIdUnidade,
$DocumentoRecebido);
4. Servios SIP
Endereo de acesso ao WSDL: http://[servidor php]/sip/controlador_ws.php?servico=wsdl
4.1 Estruturas de Dados
Usuario
E Excluir (se no for possvel excluir ser desativado)
D Desativar
R Reativar
IdOrigem ID associado com o usurio no sistema de origem
IdOrgao ID do rgo do usurio
Nome Nome do usurio
Permissao
E Excluir
IdSistema ID do sistema no SIP
IdOrgaoUsuario ID do rgo do usurio no SIP
IdUsuario ID do usurio no SIP (opcional se IdOrigemUsuario informado)
IdOrigemUsuario ID do usurio no sistema origem (opcional se IdUsuario
informado)
IdOrgaoUnidade ID do rgo da unidade no SIP
IdUnidade ID da unidade no SIP (opcional se IdOrigemUnidade informado)
IdOrigemUnidade ID da unidade no sistema origem (opcional se IdUnidade
informado)
IdPerfil ID do perfil no SIP
DataInicial Data de incio da permisso (dd/mm/aaaa)
DataFinal Opcional. Data de trmino da permisso.
SinSubunidades S/N - indica se a permisso deve ser estendida s subunidades da
unidade informada
28
4.2 Mtodos Disponibilizados
listarPermissao
Entrada
IdSistema ID do sistema no SIP
IdOrgaoUsuario Opcional. ID do rgo do usurio no SIP
IdUsuario Opcional. ID do usurio no SIP
IdOrigemUsuario Opcional. ID do usurio no sistema origem
IdOrgaoUnidade Opcional. ID do rgo da unidade na SIP
IdUnidade Opcional. ID da unidade no SIP
IdOrigemUnidade Opcional. ID da unidade no sistema origem
IdPerfil Opcional. ID do perfil no SIP
Sada
Retorno Um conjunto de ocorrncias da estrutura Permissao.
Observaes
necessrio configurar a chave HostWebService/Pesquisa, existente no arquivo
ConfiguracaoSip.php, com a identificao da mquina que chamar o servio.
As permisses retornaro ordenadas pelos atributos IdOrgaoUsuario, IdUsuario e

IdOrigemUsuario.
replicarPermissao
Entrada
Permissoes Conjunto de permisses (ver estrutura Permissao)
Sada
Retorno Retorna true se teve sucesso ou uma exceo em caso de erro.
Observaes
necessrio configurar a chave HostWebService/Replicacao, existente no arquivo
Cada uma das permisses do conjunto informado ser tratada em uma transao separada. Sendo
assim, mesmo que algumas apresentem erro ou falha na validao dos dados as demais sero
atualizadas. Os erros e validaes sero acumulados e retornados como uma exceo.
No SIP mais de uma unidade pode ter o mesmo valor para o atributo IdOrigemUnidade. Neste
caso, se apenas este atributo for informado ento o servio aplicar a operao correspondente
para todo o conjunto de unidades.
Na operao E (excluir) os campos DataInicial, DataFinal e SinSubunidades so ignorados.
replicarUsuario
Entrada
Usuarios Conjunto de usurios (ver estrutura Usuario)
Sada
Retorno Retorna true se teve sucesso ou uma exceo em caso de erro.
Observaes
29
necessrio configurar a chave HostWebService/Replicacao, existente no arquivo
Nas operaes E (excluir), D (desativar) e R (reativar) somente o parmetro IdOrigem da

estrutura ser considerado.
5. Servios Acessados em outros Sistemas
listarCargoFuncao
Entrada
IdOrgao ID do rgo associado com o usurio
IdOrigem ID de origem associado com o usurio
Sada
CargosFuncoes Uma lista de cargos e funes do usurio.
Observaes
A implementao deste servio opcional. O SEI chamar o servio na tela de assinatura de
documentos e utilizar o retorno para preencher a caixa Cargo/Funo. Os cargos e funes
de assinatura cadastrados para unidade dentro do sistema tambm sero exibidos (o sistema
tratar dados repetidos).
O endereo do servio dever ser cadastrado em uma nova chave denominada
RH/CargoFuncao no arquivo ConfiguracaoSEI.php:
'RH' => array('CargoFuncao' => '...endereo do wsdl...'),
Se a chave no existir no arquivo (ou estiver com o valor vazio) ento o sistema no efetuar a
chamada.
Exemplo de definio do servio no WSDL:

<xsd:complexType name="ArrayOfCargoFuncao">
<xsd:sequence>
<xsd:element name="CargoFuncao" type="xsd:string" maxOccurs="unbounded" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<wsdl:message name="listarCargoFuncaoRequest">
<wsdl:part name="IdOrgao" type="xsd:string"/>
<wsdl:part name="IdOrigem" type="xsd:string"/>
<wsdl:part name="Sigla" type="xsd:string"/>
</wsdl:message>
<wsdl:message name="listarCargoFuncaoResponse">
<wsdl:part name="CargosFuncoes" type="tns:ArrayOfCargoFuncao"/>
</wsdl:message>
30

SEI WebServices v3.0 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SEI WebServices v3.0 PDF

Uploaded by

Copyright:

Available Formats

Web Services - Verso 3.

Para acesso necessrio antes cadastrar os sistemas externos e associ-los

1.2 Aps cadastramento, atravs da lista de sistemas acessar o cone Servios:

Identificao: este campo dever ser informado na chamada do Web-Service

Descrio: campo auxiliar opcional

1.5 Cadastrar as operaes permitidas para o servio:

2. Estruturas de Dados SEI

Quando o agendamento removerArquivosNaoUtilizados for executado sero excludos todos os

Com relao a pessoa jurdica associada sero processados apenas os atributos

Pode ser informado IdTarefa ou IdTarefaModulo o que for mais conveniente.

Exemplo de chamada em PHP5

$Procedimento['Observacao'] = 'observacao teste processo';

//se incluindo em um processo existente informar o id neste campo

$DocumentoGerado['IdSerie'] = '3'; //Portaria

//se incluindo em um processo existente informar o id neste campo

//1 - gera processo

//2 - gera processo + documento gerado

//3 - gera processo + documento gerado + documento externo

//4 - inclui documento gerado em processo existente

//5 -inclui documento externo em processo existente

Endereo de acesso ao WSDL: http://[servidor php]/sip/controlador_ws.php?servico=wsdl

4.1 Estruturas de Dados

As permisses retornaro ordenadas pelos atributos IdOrgaoUsuario, IdUsuario e

Na operao E (excluir) os campos DataInicial, DataFinal e SinSubunidades so ignorados.

Nas operaes E (excluir), D (desativar) e R (reativar) somente o parmetro IdOrigem da

5. Servios Acessados em outros Sistemas

Exemplo de definio do servio no WSDL:

You might also like